okw.LogMessenger Klassenreferenz

LogMessenger liest Log-Meldungen sprachspezifisch für die im Konstruktor gegeben Klasse aus der Zugehörigen XML-Datei. Mehr ...

Zusammengehörigkeiten von okw.LogMessenger:

Öffentliche Methoden
	LogMessenger (String fpsClassname)
String	GetMessage (String MethodName, String TextKey)
	Holt die Log-Meldung für MethodeNmae/Textkey ohne weitere Parameter. Mehr ...
String	GetMessage (String MethodName, String TextKey, Object Parameter_1)
	Holt die Log-Meldung für MethodeNmae/Textkey und einem Parameter. Mehr ...
String	GetMessage (String MethodName, String TextKey, Object Parameter_1, Object Parameter_2)
	Holt die Log-Meldung für MethodeNmae/Textkey und einem Parameter. Mehr ...
String	GetMessage (String MethodName, String TextKey, Object Parameter_1, Object Parameter_2, Object Parameter_3)
	Holt die Log-Meldung für MethodeNmae/Textkey und drei Parameter. Mehr ...

Private Methoden
String	ReadMessage (String ClassName, String MethodName, String TextKey)
	Interne Kernfunktion holt die Log-Meldung mit Platzhaltern aus der XML-Datei. Mehr ...

Private Attribute
String	cvsClassName = ""
OKW_XmlReader	myXmlReader

Ausführliche Beschreibung

LogMessenger liest Log-Meldungen sprachspezifisch für die im Konstruktor gegeben Klasse aus der Zugehörigen XML-Datei.

Die Log-Meldungen sind in XML-Dateien ausgelagert. Die XML-Dateien müssn in Verzeichniss gegeben in OKW_Ini.Instance.OKW_Enviroment.PathLog abgelegt sein. (Defaultwert: /XML/Log)

Die XML-Struktur sieh wie folgt aus:

<Class name="MeineKlasse">
    <Method name="MeineMethode">
        <Text key="MeinTextschlüssel">
            <en>Text with Parameter '{0:}'.</en>
            <de>Text mit einem Parameter '{0:}'.</de>
        </Text>
    </Method>
</Class>

Dabei können

• je Klasse n-Methoden
• je Methode n-Textschlüssel.
• Je Textschlüssel können n-Überstezungen definiert werden.

Die aktuelle Sprache kommt aus OKW.OKWLanguage.getInstance.Language

@info Die englische Üersetzung muss immer vorhanden sein. Sollte eine andere Übersetzung fehlen, dann wir die englische Log-Meldung zurückgeliefert.

Autor

Zoltan Hrabovszki

Datum

2013_12_22

Definiert in Zeile 84 der Datei LogMessenger.java.

Beschreibung der Konstruktoren und Destruktoren

LogMessenger()

okw.LogMessenger.LogMessenger

(

String

fpsClassname

)

1. Speichern des Klassennamens.
2. Initialisieren der Klasse.

Parameter

fpsClassname

Name der Klasse. Wird verwendet um die Instanz der Klasse mit der zugehärige XML-Datei zu verbinden.

Autor

Zoltan Hrabovszki

Datum

2013_12_22

Definiert in Zeile 103 der Datei LogMessenger.java.

    {
        try
        {
            this.cvsClassName = fpsClassname;
            String myXMLFile = "/xml/logmessages/LM_" + this.cvsClassName + ".xml";
            myXmlReader = new OKW_XmlReader(myXMLFile);
        }
        catch (Exception e)
        {
            OKW_HandleException.StopRunning(e, this.getClass());
        }
    }

Dokumentation der Elementfunktionen

GetMessage() [1/4]

String okw.LogMessenger.GetMessage	(	String	MethodName,
		String	TextKey
	)

Holt die Log-Meldung für MethodeNmae/Textkey ohne weitere Parameter.

Parameter

MethodName	Name der Methode
TextKey	Text-Schlüssel

Rückgabe

Log-Meldung für die gegebene Paremeter und aktuelle Sprache.

Autor

Zoltan Hrabovszki

Datum

2013.12.22

Definiert in Zeile 137 der Datei LogMessenger.java.

    {
        String lvs_Return = "Message Not Found!";
 
        try
        {
            lvs_Return = this.ReadMessage(this.cvsClassName, MethodName, TextKey);
        }
        catch (Exception e)
        {
            OKW_HandleException.StopRunning(e, this.getClass());
        }
 
        return lvs_Return;
    }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

GetMessage() [2/4]

String okw.LogMessenger.GetMessage	(	String	MethodName,
		String	TextKey,
		Object	Parameter_1
	)

Holt die Log-Meldung für MethodeNmae/Textkey und einem Parameter.

Parameter

MethodName	Name der Methode
TextKey	Text-Schlüssel
Parameter_1	Wert der in der Log_Meldung mit ausgegeben wird.

Rückgabe

Log-Meldung für die gegebene Paremeter und aktuelle Sprache.

Autor

Zoltan Hrabovszki

Datum

2013.12.22

Definiert in Zeile 175 der Datei LogMessenger.java.

    {
        String lvsReturn = "";
    String lvsTemplate = "";
        try
        {
          lvsTemplate = this.ReadMessage(this.cvsClassName, MethodName, TextKey);
            
            ST st = new ST(lvsTemplate, '$', '$');
            st.add("P1", Parameter_1);
            lvsReturn = st.render();
            
        }
        catch (Exception e)
        {
            OKW_HandleException.StopRunning(e, this.getClass());
        }
 
        return lvsReturn;
    }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

GetMessage() [3/4]

String okw.LogMessenger.GetMessage	(	String	MethodName,
		String	TextKey,
		Object	Parameter_1,
		Object	Parameter_2
	)

Holt die Log-Meldung für MethodeNmae/Textkey und einem Parameter.

Parameter

MethodName	Name der Methode
TextKey	Text-Schlüssel
Parameter_1	1. Wert der in der Log_Meldung mit ausgegeben wird.
Parameter_2	2. Wert der in der Log_Meldung mit ausgegeben wird.

Rückgabe

Log-Meldung für die gegebene Paremeter und aktuelle Sprache.

Autor

Zoltan Hrabovszki

Datum

2013.12.22

Definiert in Zeile 219 der Datei LogMessenger.java.

  {
    String lvsReturn = "";
    String lvsTemplate = "";
    try
    {
      lvsTemplate = this.ReadMessage(this.cvsClassName, MethodName, TextKey);
      
      ST st = new ST(lvsTemplate, '$', '$');
      st.add("P1", Parameter_1);
      st.add("P2", Parameter_2);
      lvsReturn = st.render();
      
    }
    catch (Exception e)
    {
      OKW_HandleException.StopRunning(e, this.getClass());
    }
 
    return lvsReturn;
  }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

GetMessage() [4/4]

String okw.LogMessenger.GetMessage	(	String	MethodName,
		String	TextKey,
		Object	Parameter_1,
		Object	Parameter_2,
		Object	Parameter_3
	)

Holt die Log-Meldung für MethodeNmae/Textkey und drei Parameter.

Parameter

MethodName	Name der Methode
TextKey	Text-Schlüssel
Parameter_1	1. Wert der in der Log_Meldung mit ausgegeben wird.
Parameter_2	2. Wert der in der Log_Meldung mit ausgegeben wird.
Parameter_2	2. Wert der in der Log_Meldung mit ausgegeben wird.

Rückgabe

Log-Meldung für die gegebene Paremeter und aktuelle Sprache.

Autor

Zoltan Hrabovszki

Datum

2013.12.22

Definiert in Zeile 267 der Datei LogMessenger.java.

  {
    String lvsReturn = "";
    String lvsTemplate = "";
    try
    {
      lvsTemplate = this.ReadMessage(this.cvsClassName, MethodName, TextKey);
      
      ST st = new ST(lvsTemplate, '$', '$');
      st.add("P1", Parameter_1);
      st.add("P2", Parameter_2);
      st.add("P3", Parameter_3);
      lvsReturn = st.render();
      
    }
    catch (Exception e)
    {
      OKW_HandleException.StopRunning(e, this.getClass());
    }
 
    return lvsReturn;
  }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

ReadMessage()

String okw.LogMessenger.ReadMessage ( String  ClassName, String  MethodName, String  TextKey  )

private

Interne Kernfunktion holt die Log-Meldung mit Platzhaltern aus der XML-Datei.

"ClassName", "MethodName" and "TextKey" and Actual language from ini-file.

Parameter

ClassName	Name of the Class.
MethodName	Name of the Method.
TextKey	Key for the Text-Message.

Autor

Zoltan Hrabovszki

Datum

2013_12_22

Definiert in Zeile 321 der Datei LogMessenger.java.

    {
        String lvsReturn = "Message Not Found!";
 
        try
        {
            String Language = OKWLanguage.getInstance().getLanguage();
            
            String myXPathExpression = "//Class[@name='" + ClassName + "']/Method[@name='" + MethodName + "']/Text[@key='" + TextKey + "']/" + Language;
            
            lvsReturn = myXmlReader.getTextContentSingleValue(myXPathExpression);
 
            if (lvsReturn.isEmpty())
            {
                throw new OKWMessageNotFoundException("Message not Found. Class: " + ClassName + ",  Method: "
                        + MethodName + ", TextKey: " + TextKey);
            }
        }
        catch (OKWMessageNotFoundException e)
        {
            OKW_HandleException.StopRunning(e, this.getClass());
        }
 
        return lvsReturn;
    }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /home/travis/build/Hrabovszki1023/OKW/core/src/main/java/okw/LogMessenger.java