JSBS_XML_ErrorMessages – Basisklasse für das Verarbeiten der XML-Struktur mit den sprachabhängigen Fehlermeldungen und Warnungen

Inhaltsverzeichnis

Code 
Erklärungen und Anwendungsbeispiele 
Verwandte Dokumentation 

Code

package js_base.xml;

import java.util.*;

import org.jdom.*;
import js_base.frame.JSBS_StartFrame;
import js_base.structures.JSBS_UniversalParameters;
/**
 *
 * @author kurt[at]javascout(dot)biz
 * @date 2007-09-05
 *
 * @description
 * de:
 *  Klasse mit spezialisierten Methoden zum Ermitteln des Nachrichten-Texten
 *  für Fehler- und Warnings-Hinweise.
 *  Diese Klasse erbt JSBS_XML_Base und verwendet dessen Methoden zum lesen
 *  der Datei, die die XML-Struktur enthält.
 * en:
 *  Class with specialized methods for getting the Message-Text for
 *  Error- or Warning-Messages.
 *  This class inherits JSBS_XML_Base and uses its methods to read a file
 *  containing a XML-structure.
 *
 * @change-log
 * when         who               why
 * --------------------------------------------------------
 *
 */
public class JSBS_XML_ErrorMessages extends JSBS_XML_Base {
/*
 * -------------------------------
 * de:
 * CONSTRUCTOR der Klasse.
 * Der Name der zu öffnenden Datei wird aus der Struktur UniversalParameters ermittelt.
 * en:
 * CONSTRUCTOR of the class.
 * The name of the file to be opened is derived from the UniversalParameters. */
    public JSBS_XML_ErrorMessages(JSBS_StartFrame parmCC) {
/*
 * de: Ausführen des Codes im Constructor der geerbten Klasse.
 * en: Perform the code in the constructor of the inherited class */
        super(parmCC);
/* 
 * de:
 * Holen des Dateinamens für die XML-Struktur mit den Fehler- und Warn-Hinweisen.
 * Dazu wird das Datei-Verzeichnis mit den sprach-spezifischen Dateien und  der
 * Datei-Name für die Datei mit der XML-Struktur zusammen gesetzt.
 * en:
 * Get the filename for the XML-structure with the error- and warning-messages.
 * This is done by concatenating the directory with the language dependant files
 * and the filename for the file with the XML-structure. */
        String locstrFileName =
            parmCC.structJSBS_UniversalParameters.strTextElementsDirectoryName +
            JSBS_UniversalParameters.CONST_ERRORMESSAGES_FILE_NAME;
/* 
 * de:
 * RootElement der XML-Struktur lesen,
 * Die Methode ist in der Superklasse - das ist die geerbte Klasse - implementiert.
 * en:
 * Read the RootElement of the XML-structure.
 * The method implemented in the superclass - i.e. the class inherited. */
        readXMLFile(locstrFileName);
    }
/*
 * -------------------------------
 * de:
 * CONSTRUCTOR der Klasse.
 * Der Name der zu öffnenden Datei (und das Vezeichnis) wird als Parameter übergeben.
 * en:
 * CONSTRUCTOR of the class.
 * The name of the file (and directory) to be opened is passed as parameter. */
    public JSBS_XML_ErrorMessages(String parmDirectoryAndFileName) {
/* 
 * de: Ausführen des Codes im Constructor der geerbten Klasse.
 * en: Perform the code in the constructor of the inherited class */
        super(null);
/* 
 * de:
 * RootElement der XML-Struktur lesen,
 * Die Methode ist in der Superklasse - das ist die geerbte Klasse - implementiert.
 * en:
 * Read the RootElement of the XML-structure.
 * The method implemented in the superclass - i.e. the class inherited. */
        readXMLFile(parmDirectoryAndFileName);
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Ermitteln des Indikators wie das Ereignis bearbeitet werden soll (Abbruch /
 * Warnung / Log auf Datei).
 * en:
 * METHOD to get the Indicator how the event should be processed (Dump / Warn / Log). */
    public String getProcessIndicator(String parmstrOriginClass, String parmstrOriginCode) {
/*
 * de: Indikator auf 'Dump/Abbruch' setzen für den Fall das kein Eintrag gefunden wird.
 * en: Set the Indicator to 'Dump' in case no entry is found. */
      String locstrProcessing = "D";
/* 
 * de: Mehrfach verwendete Variable.
 * en: Multiple used Variables. */
      Element elementMessage;
      Element elementOriginClass;
      Element elementOriginCode;
      String  strOriginClassName;
      String  strOriginCodeName;
/*
 * de: Liste alle <Message>-Elemente, Anzahl und Index zum Durchsuchen.
 * en: List of all <Message>-elements, size and index for searching it. */
      List listMessages;
      int intlistMessagesSize;
      int intlistMessagesIndex = 0;
/* 
 * de:
 * Status-Code auf OK setzen damit am Ende der Methode erkannt werden kann wenn ein
 * Fehler aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Fenerelle Prüfung ob ein child-Element mit Namen <Message> vorhanden ist.
 * en: General check if there is a child-elements named <Messages> present. */
      Element elementMessages = XML_RootElement.getChild("Messages");
      if (elementMessages == null) {
/* 
 * de: Überhaupt kein <Message>-Element vorhanden; oben definierten Standard-Wert zurückliefern.
 * en: No Message elements present within XML-structure; return default value (defined above). */
        return locstrProcessing;
      }
/* 
 * de: Liste der <Message>-Elemente und die Anzahl in der Liste ermitteln.
 * en: Get the list of <Message>-elements and the number of elements within. */
      listMessages = elementMessages.getChildren();
      intlistMessagesSize = listMessages.size();
      if (intlistMessagesSize == 0) {
/* 
 * de: Überhaupt kein <Message>-Element vorhanden; oben definierten Standard-Wert zurückliefern.
 * en: No Message elements present within XML-structure; return default value (defined above). */
        return locstrProcessing;
      }
/* 
 * de:
 * Jedes Element untersuchen um das Element zu finden das zu
 * OriginClass und OriginCode, die als Parameter übergeben wurden) passt.
 * en:
 * Inspect each element of the list to find the element
   fitting the OriginClass and the OriginCode passed as parameter. */
      for (intlistMessagesIndex = 0;
           intlistMessagesIndex < intlistMessagesSize;
           intlistMessagesIndex++) {
        elementMessage = (Element) listMessages.get(intlistMessagesIndex);
/* 
 * de:
 * Element mit <OriginClass> und <OriginCode> holen und deren Inhalte mit
 * den Werten der übergebenen Parameter vergleichen.
 * en:
 * Get the element with the <OriginClass> and <OriginCode> to compare its content
 * with the values of the passed parameters. */
        elementOriginClass = elementMessage.getChild("OriginClass");
        if (elementOriginClass == null) {
          continue;
        }
        elementOriginCode = elementMessage.getChild("OriginCode");
        if (elementOriginCode == null) {
          continue;
        }
        strOriginClassName = elementOriginClass.getTextTrim();
        strOriginCodeName = elementOriginCode.getTextTrim();
        if (   (strOriginClassName.compareTo(parmstrOriginClass.trim()) == 0)
            && (strOriginCodeName.compareTo(parmstrOriginCode.trim()) == 0)) {
/* 
 * de:
 * Passendes <Message>-Element innerhalb der Liste gefunden;
 * prüfen ob ein <ProcessIndicator> vorhanden ist.
 * en:
 * Fitting <Message>-element found within the list;
 * check if a <ProcessIndicator> is defined. */
         Element elementProcessing = elementMessage.getChild("Processing");
         if ( elementProcessing != null) {
/* 
 * de:
 * <ProcessIndicator> im <Message>-Element gefunden; extrahieren und den Wert zurück liefern.
 * en:
 * <ProcessIndicator> found with the <Message>-element; extract and return its value. */
           locstrProcessing = elementProcessing.getTextTrim();
           return locstrProcessing;
         }
       }
     }
/* 
 * de:
 * Keine <Message> Elemente vorhanden für die gesuchte Kombination aus
 * <OriginClass>/<OriginCode>; oben definierten Standard-Wert zurückliefern.
 * en:
 * No <Message> elements present for the requested <OriginClass>/<OriginCode>;
 * return default value (defined above). */
      return locstrProcessing;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Ermitteln des Indikators ob für dieses Ereignis ein Eintrag in die
 * Log-Datei geschrieben werden soll.
 * en:
 * METHOD to get the Indicator if a record should be written into the Log-File for this event. */
    public boolean getLogIndicator(String parmstrOriginClass, String parmstrOriginCode) {
/*
 * de:
 * Auslesen des gesamten <Message>-XML-elements für die gegebene Kombination aus OriginClass/OriginCode.
 * en:
 * Retrieve the whole <Message>-XML-element for the given OriginClass/OriginCode. */
      Element elementMessage = getElement_Message(parmstrOriginClass, parmstrOriginCode);
/*
 * de:
 * Wenn das passende <Message>-Element nicht gefunden wird dann wird angenommen, dass ein Logging
 * nicht notwendig ist.
 * en:
 * If the fitting <Message>-Element ist not found then it is assumed that logging is not needed. */
      if (elementMessage == null) return false;
/* 
 * de:
 * <Message>-Element vorhanden; prüfen ob das Unter-Element <Logging> existiert.
 * en:
 * <Message>-element present; now check if it contains the sub-element <Logging>. */
      Element elementLogging = elementMessage.getChild("Logging");
/* 
 * de:
 * Wenn das <Logging>-Element vorhanden ist dann soll ein Log-Eintrag erfogen; sonst nicht.
 * en:
 * If the <Logging>-element is present then a Log-entry should be performed; otherwise not. */
      if (elementLogging != null) return true;
      else return false;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Ermitteln ob der <Message>-Eintrag auf einen anderen <Message>-Eintrag verweist
 * und dessen Schlüssel (OriginClass/OriginCode) zurückliefern.
 * Die referenzierten Werte für OriginClass und OriginCode werden in einem (ein-dimensionalen) Array
 * mit 2 Strings (Zeichenketten) zurück geliefert.
 * en:
 * METHOD to verify if this <Message>-entry refers to another <Message>-entry and return the
 * OriginClass/OriginCode of the referred <Message>-entry.
 * The referred OriginClass and OriginCode is returned in an (one-dimensional) array of 2 Strings. */
    public String[] getReferenceOrigin(String parmstrOriginClass, String parmstrOriginCode) {
/*
 * de:
 * Auslesen des gesamten <Message>-XML-elements für die gegebene Kombination aus OriginClass/OriginCode.
 * en:
 * Retrieve the whole <Message>-XML-element for the given OriginClass/OriginCode. */
      Element elementMessage = getElement_Message(parmstrOriginClass, parmstrOriginCode);
/*
 * de:
 * Wenn das passende <Message>-Element nicht gefunden wird dann wird ein leeres Array zurück geliefert.
 * en:
 * If the fitting <Message>-Element ist not found then an empty array is returned. */
      if (elementMessage == null) return new String[0];
/* 
 * de:
 * <Message>-Element vorhanden; prüfen ob das Unter-Element <Reference> existiert.
 * en:
 * <Message>-element present; now check if it contains the sub-element <Reference>. */
      Element elementReferenceOrigin = elementMessage.getChild("Reference");
/* 
 * de:
 * Wenn das <Reference>-Element vorhanden ist dann werden die Werte für <ReferenceOriginClass> und
 * <ReferenceOriginCode> ausgelesen.
 * en:
 * If the <Reference>-element is present then the values for <ReferenceOriginClass> and 
 * <ReferenceOriginCode> are read. */
      if (elementReferenceOrigin != null) {
        Element elementReferenceOriginClass = elementReferenceOrigin.getChild("ReferenceOriginClass");
/* de: Wenn das XML-Element nicht vorhanden ist dann wird ein leeres Array zurück geliefert.
 * en: if the XML-element is not present then an empty array is returned. */
        if (elementReferenceOriginClass == null) return new String[0];
/* *** */
        Element elementReferenceOriginCode = elementReferenceOrigin.getChild("ReferenceOriginCode");
/* de: Wenn das XML-Element nicht vorhanden ist dann wird ein leeres Array zurück geliefert.
 * en: if the XML-element is not present then an empty array is returned. */
        if (elementReferenceOriginCode == null) return new String[0];
/* 
 * de:
 * Wenn das Programm bis hierher gekommen ist dann ein neues Array erstellen und die Werte für
 * <ReferenceOriginClass> und <ReferenceOriginCode> in das Array übertragen.
 * en:
 * If the program ran till this point then construct a new array and transfer the values for
 * <ErrorOriginClass> and <ErrorOriginCode> into the new array. */
        String[] arrayReturnValue = new String[2];
        arrayReturnValue[0] = elementReferenceOriginClass.getTextTrim();
        arrayReturnValue[1] = elementReferenceOriginCode.getTextTrim();
        return arrayReturnValue;
      }
/* 
 * de: Wenn kein <Reference>-Element vorhanden ist dann wird ein leeres Array zurück geliefert.
 * en: If a <Reference>-element is not present then an empty array is returned. */
      else return new String[0];
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Ermitteln des <MessageText für die gesuchte Kombination aus
 * <OriginClass> und <OriginCode>.
 * en:
 * METHOD to get the MessageText for the requested OriginClass and OriginCode. */
    public String getMessageText(String parmstrOriginClass, String parmstrOriginCode) {
/* 
 * de:
 * Private Methode verwenden.
 * Den Parameter zum Verwenden einer eventuellen Reference-Text-Message verwenden.
 * en:
 * Use the private method; passing the parameter to allow check for a Reference-Text-Message. */
      return getMessageText(parmstrOriginClass, parmstrOriginCode, true);
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum ermitteln des <MessageText> für die gesuchte Kombination aus
 * <OriginClass> und <OriginCode>.
 * Die Methode ist 'private' weil sie einen Parameter verwendet um eine recursive
 * Suche nach Referenz-Text-Nachrichten zu verhindern.
 * en:
 * METHODE to get the MessageText for the requested OriginClass and OriginCode.
 * This method is private as it also features a parameter to inhibit recursive
 * search for Reference-Text-Messages. */
    private String getMessageText(String parmstrOriginClass, String parmstrOriginCode,
                                   boolean parmbolLookForReference) {
/* 
 * Variablen / Variables: */
/*
 * de: String mit dem Nachrichten-Tect der zurück geliefert wird.
 * en: String with the message-text that is returned. */
      String locstrMessageText;
/*
 * de: Elemente aus der XML-Struktur und Strings für deren Inhalts-Werte.
 * en: Elements derived from the XML-structure and Strings for the content-values. */
      Element elementMessage;
      Element elementOriginClass;
      Element elementOriginCode;
      String  strOriginClassName;
      String  strOriginCodeName;
/*
 * de: Liste aller <Message>-Elemente, Anzahl und Index zum Durchsuchen.
 * en: List of all <Message>-elements, size and index for searching it. */
      List listMessages;
      int intlistMessagesSize;
      int intlistMessagesIndex = 0;
/* 
 * de: StatusCode auf OK setzen um am Ende der Methode Fehler erkennen zu können.
 * en: Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Generelle Prüfung ob überhaupt ein Child-Element <Message> vorhanden ist.
 * en: General check if there is a child-elements named <Messages> present. */
      Element elementMessages = XML_RootElement.getChild("Messages");
      if (elementMessages == null) {
/* 
 * de:
 * Kein <Message> Element in der XML-Struktur vorhanden; vorher definierten Standard-Wert zurückliefern.
 * en:
 * No <Message> elements present within XML-structure; return default value (defined above). */
        return getNotFoundMessageText();
      }
/* 
 * de: Liste der <Message>-Elemente erstellen und deren Anzahl ermitteln.
 * en: Get the list of <Message>-elements and the number of elements within. */
      listMessages = elementMessages.getChildren();
      intlistMessagesSize = listMessages.size();
      if (intlistMessagesSize == 0) {
/* 
 * de: Keine Elemente gefunden; <NotFoundMessageText> zurückliefern.
 * en: No Elements found; return the <NotFoundMessageText>. */
        return getNotFoundMessageText();
      }
/* 
 * de:
 * Jedes Element der Liste untersuchen um das Element zu finden,
 * dessen <OriginClass> und <OriginCode> zu den als Parameter übergebenen Werten passt.
 * en:
 * Inspect each element of the list to find the element
 * fitting the <OriginClass> and the <OriginCode> passed as parameter. */
      for (intlistMessagesIndex = 0;
           intlistMessagesIndex < intlistMessagesSize;
           intlistMessagesIndex++) {
        elementMessage = (Element) listMessages.get(intlistMessagesIndex);
/* 
 * de:
 * Element mit <OriginClass> und <OriginCode> holen und deren Inhalte mit
 * den Werten der übergebenen Parameter vergleichen.
 * en:
 * Get the element with the <OriginClass> and <OriginCode> to compare its content
 * with the values of the passed parameters. */
        elementOriginClass = elementMessage.getChild("OriginClass");
        if (elementOriginClass == null) {
          continue;
        }
        elementOriginCode = elementMessage.getChild("OriginCode");
        if (elementOriginCode == null) {
          continue;
        }
        strOriginClassName = elementOriginClass.getTextTrim();
        strOriginCodeName = elementOriginCode.getTextTrim();
        if (   (strOriginClassName.compareTo(parmstrOriginClass.trim()) == 0)
            && (strOriginCodeName.compareTo(parmstrOriginCode.trim()) == 0)) {
/* 
 * de:
 * Passendes <Message>-Element in der Liste gefunden;
 * prüfen ob ein Nachrichten-Text dafür definiert ist.
 * en:
 * Fitting <Message>-element found within the list;
 * check if a Message-Text is defined. */
          Element elementMessageText = elementMessage.getChild("MessageText");
          if (elementMessageText != null) {
/* 
 * de: <MessageText> vorhanden; wert extrahieren und zurück liefern.
 * en: <MessageText> present; extract it and return its value. */
            locstrMessageText = elementMessageText.getTextTrim();
            return locstrMessageText;
          }
/* 
 * de:
 * <MessageText> nicht vorhanden. Prüfen ob eine Referenz definiert ist.
 * Auf Referenz nur prüfen wenn der Parameter 'parmbolLookForReferenz' das anfordert.
 * en:
 * <MessageText> not present. See if a reference is defined. Look for a reference only
 * if the parameter 'parmbolLookForReference' requests to do so. */
          if (parmbolLookForReference) {
            Element elementReference = elementMessage.getChild("Reference");
            if (elementReference != null) {
/* 
 * de:
 * Referenz auf anderen MessageText vorhanden; OriginClass und OriginCode
 * für die referenzierte Nachricht ermitteln.
 * en:
 * Reference to another MessageText present; get the OriginClass and OriginCode
 * for the Message referred. */
              String strReferredOriginClassName = "";
              String strReferredOriginCodeName = "";
              Element elementReferredOriginClassName =
                elementReference.getChild("ReferenceOriginClass");
              if (elementReferredOriginClassName != null)
                strReferredOriginClassName = elementReferredOriginClassName.getTextTrim();
              Element elementReferredOriginCodeName =
                elementReference.getChild("ReferenceOriginCode");
              if (elementReferredOriginCodeName != null)
                strReferredOriginCodeName = elementReferredOriginCodeName.getTextTrim();
/* 
 * de: Diese Methode rekursiv aufrufen um den Nachrichten-Text zu ermitteln.
 * en: Call this method recursively to get the Message-Text. */
              return getMessageText(strReferredOriginClassName, strReferredOriginCodeName, false);
            }
          }
        }
      }
/* 
 * de:
 * XML-Struktur durchsucht ohne eine <Message> für die Kombination <OriginClass> / <OriginCode>
 * gefunden zu haben. <NotFoundMessageText> zurückliefern.
 * en:
 * XML-structure searched without finding a <Message> for the combination <OriginClass> / <OriginCode>.
 * Return the <NotFoundMessageText>. */
      return getNotFoundMessageText();
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Holen eines kompletten <Message>-XML-Elementes für die gegebene Kombination
 * <OriginClass> und <OriginCode>.
 * Dieses <Message>-XML-Element kann von anderen Methoden weiter bearbeitet werden.
 * en:
 * METHODE to get a whole <Message>-XML-Element for the requested OriginClass and OriginCode.
 * This <Message>-XML-element can be used for further processing by other methods. */
    private Element getElement_Message(String parmstrOriginClass, String parmstrOriginCode) {
/* 
 * Variablen / Variables: */
/*
 * de: Elemente aus der XML-Struktur und Strings für deren Inhalts-Werte.
 * en: Elements derived from the XML-structure and Strings for the content-values. */
      Element elementMessage = null;
      Element elementOriginClass;
      Element elementOriginCode;
      String  strOriginClassName;
      String  strOriginCodeName;
/*
 * de: Liste aller <Message>-Elemente, Anzahl und Index zum Durchsuchen.
 * en: List of all <Message>-elements, size and index for searching it. */
      List listMessages;
      int intlistMessagesSize;
      int intlistMessagesIndex = 0;
/* 
 * de: StatusCode auf OK setzen; als Vorsicht falls er durch eine andere Methode geändert wurde.
 * en: Set the StatusCode to OK as precaution if another method changed it. */
      StatusCode = CONST_OK;
/* 
 * de: Generelle Prüfung ob überhaupt ein Child-Element <Message> vorhanden ist.
 * en: General check if there is a child-elements named <Messages> present. */
      Element elementMessages = XML_RootElement.getChild("Messages");
      if (elementMessages == null) return null;
/* 
 * de: Liste der <Message>-Elemente erstellen und deren Anzahl ermitteln.
 * en: Get the list of <Message>-elements and the number of elements within. */
      listMessages = elementMessages.getChildren();
      intlistMessagesSize = listMessages.size();
      if (elementMessages == null) return null;
/* 
 * de:
 * Jedes Element der Liste untersuchen um das Element zu finden,
 * dessen <OriginClass> und <OriginCode> zu den als Parameter übergebenen Werten passt.
 * en:
 * Inspect each element of the list to find the element
 * fitting the <OriginClass> and the <OriginCode> passed as parameter. */
      for (intlistMessagesIndex = 0;
           intlistMessagesIndex < intlistMessagesSize;
           intlistMessagesIndex++) {
        elementMessage = (Element) listMessages.get(intlistMessagesIndex);
/* 
 * de:
 * Element mit <OriginClass> und <OriginCode> holen und deren Inhalte mit
 * den Werten der übergebenen Parameter vergleichen.
 * en:
 * Get the element with the <OriginClass> and <OriginCode> to compare its content
 * with the values of the passed parameters. */
        elementOriginClass = elementMessage.getChild("OriginClass");
        if (elementOriginClass == null) {
          continue;
        }
        elementOriginCode = elementMessage.getChild("OriginCode");
        if (elementOriginCode == null) {
          continue;
        }
        strOriginClassName = elementOriginClass.getTextTrim();
        strOriginCodeName = elementOriginCode.getTextTrim();
        if (   (strOriginClassName.compareTo(parmstrOriginClass.trim()) == 0)
            && (strOriginCodeName.compareTo(parmstrOriginCode.trim()) == 0)) {
/* 
 * de:
 * Passendes <Message>-Element in der Liste gefunden; an die aufrufende Methode zurück liefern.
 * en:
 * Fitting <Message>-element found within the list; return it to the calling methode. */
          return elementMessage;
        }
      }
/* 
 * de:
 * XML-Struktur durchsucht ohne ein <Message>-Element für die Kombination <OriginClass> / <OriginCode>
 * gefunden zu haben. 'null' als Signal an die aufrufende Methode zurück liefern.
 * en:
 * XML-structure searched without finding a <Message> for the combination <OriginClass> / <OriginCode>.
 * Return 'null' as a signal to the calling methode. */
      return null;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Holen des Wertes des XML-Elementes <NotFoundMessageText>.
 * Diese Nachricht informiert den Anwender dass eine spezifische Nachricht für
 * <OriginClass>/<OriginCode> innerhalb der XML-Struktur nicht gefunden wurde.
 * en:
 * METHOD to get the value of the XML-element <NotFoundMessageText>.
 * This message informs the user that a specific message for <OriginClass>/<OriginCode>
 * is not found in the XML-structure. */
    private String getNotFoundMessageText() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Text der zurückgeliefert wird.
 * Der String enthält einen Standard-Hinweis im Fall dass ein passendes Element nicht
 * in der XML-Struktur vorhanden ist.
 * en:
 * String with the text that is returned.
 * It contains a default-message in case that a suitable element is not within
 * the XML-structure. */
      String locstrNotFoundMessageText = "Message-Text not available";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <NotFoundMessageText>.
 * en: Get the child-element <NotFoundMessageText>. */
      Element elementNotFoundMessageText = XML_RootElement.getChild("NotFoundMessageText");
      if (elementNotFoundMessageText == null) {
/* 
 * de:
 * Sogar der Hinweis-Text mit der Information dass eine spezifische Nachricht nicht verfügbar
 * ist fehlt. Standard-Text zurückliefern.
 * en:
 * Even the Message-Text informing that no specific Message is available is missing.
 * Return the default text. */
        return locstrNotFoundMessageText;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrNotFoundMessageText = elementNotFoundMessageText.getTextTrim();
      return locstrNotFoundMessageText;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Holen des Wertes des XML-Elementes <ErrorExplanationText>.
 * Diese Nachricht informiert den Anwender dass ein Fehler aufgetreten ist,
 * der nicht durch den Anwender behoben werden kann und zu einem Abbruch des
 * Anwendungsprogramms führt.
 * en:
 * METHOD to get the value of the XML-element <ErrorExplanationText>.
 * This message informs the user that aan error occured that can not be corrected
 * by the user and will lead to a termination of the application-program. */
    public String getErrorExplanationText() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Text der zurückgeliefert wird.
 * Der String enthält einen Standard-Hinweis im Fall dass ein passendes Element nicht
 * in der XML-Struktur vorhanden ist.
 * en:
 * String with the text that is returned.
 * It contains a default-message in case that a suitable element is not within
 * the XML-structure. */
      String locstrErrorExplanationText = "Error; application will be terminated !";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <ErrorExplanationText>.
 * en: Get the child-element <ErrorExplanationText>. */
      Element elementErrorExplanationText = XML_RootElement.getChild("ErrorExplanationText");
      if (elementErrorExplanationText == null) {
/* 
 * de:
 * Sogar der Hinweis-Text mit der Information dass eine spezifische Nachricht nicht verfügbar
 * ist fehlt. Standard-Text zurückliefern.
 * en:
 * Even the Message-Text informing that no specific Message is available is missing.
 * Return the default text. */
        return locstrErrorExplanationText;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrErrorExplanationText = elementErrorExplanationText.getTextTrim();
      return locstrErrorExplanationText;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Holen des Wertes des XML-Elementes <WarningExplanationText>.
 * Diese Nachricht informiert den Anwender dass eine unerwartete Situation aufgetreten ist
 * die durch den Anwender behoben werden kann.
 * en:
 * METHOD to get the value of the XML-element <WarningExplanationText>.
 * This message informs the user that an unusual situation occured that can be cleared
 * by the user. */
    public String getWarningExplanationText() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Text der zurückgeliefert wird.
 * Der String enthält einen Standard-Hinweis im Fall dass ein passendes Element nicht
 * in der XML-Struktur vorhanden ist.
 * en:
 * String with the text that is returned.
 * It contains a default-message in case that a suitable element is not within
 * the XML-structure. */
      String locstrWarningExplanationText = "Warning; click [Continue] to close this window.";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <WarningExplanationText>.
 * en: Get the child-element <ErrorExplanationText>. */
      Element elementWarningExplanationText = XML_RootElement.getChild("WarningExplanationText");
      if (elementWarningExplanationText == null) {
/* 
 * de:
 * Sogar der Hinweis-Text mit der Information dass eine spezifische Nachricht nicht verfügbar
 * ist fehlt. Standard-Text zurückliefern.
 * en:
 * Even the Message-Text informing that no specific Message is available is missing.
 * Return the default text. */
        return locstrWarningExplanationText;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrWarningExplanationText = elementWarningExplanationText.getTextTrim();
      return locstrWarningExplanationText;
    }
/*
 * ************************************************** */
/* 
 * de:
 * Methode zum Holen des Elements <UnixLogFileName>.
 * Der Text enthält das Verzeichnis und die Datei in Unix-Format für die Datei
 * in der die Log-Einträge gespeichert sind.
 * en:
 * Method to get the value of element <UnixLogFileName>.
 * This text contains the directory- and file-name in Unix-style format of the file 
 * where log-messages are to be stored. */
    public String getUnixLogFileName() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Text der zurückgeliefert wird.
 * Der String ist leer im Fall dass ein passendes Element nicht
 * in der XML-Struktur vorhanden ist.
 * en:
 * String with the text that is returned.
 * It is empty in case that a suitable element is not within
 * the XML-structure. */
      String locstrUnixLogFileName = "";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <UnixLogFileName>.
 * en: Get the child-element <UnixLogFileName>. */
      Element elementUnixLogFileName = XML_RootElement.getChild("UnixLogFileName");
      if (elementUnixLogFileName == null) {
/* de: Kein Datei-Name festgelegt; Standard-Wert zurückliefern.
 * en: No file-name defined; return the default text. */
        return locstrUnixLogFileName;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrUnixLogFileName = elementUnixLogFileName.getTextTrim();
      return locstrUnixLogFileName;
    }
/*
 * ************************************************** */
/* 
 * de:
 * Methode zum Holen des Elements <WindowsLogFileName>.
 * Der Text enthält das Verzeichnis und die Datei in Windows-Format für die Datei
 * in der die Log-Einträge gespeichert sind.
 * en:
 * Method to get the value of element <WindowsLogFileName>.
 * This text contains the directory- and file-name in Wondows-style format of the file 
 * where log-messages are to be stored. */
    public String getWindowsLogFileName() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Text der zurückgeliefert wird.
 * Der String ist leer im Fall dass ein passendes Element nicht
 * in der XML-Struktur vorhanden ist.
 * en:
 * String with the text that is returned.
 * It is empty in case that a suitable element is not within
 * the XML-structure. */
      String locstrWindowsLogFileName = "";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <WindowsLogFileName>.
 * en: Get the child-element <WindowsLogFileName>. */
      Element elementWindowsLogFileName = XML_RootElement.getChild("WindowsLogFileName");
      if (elementWindowsLogFileName == null) {
/* de: Kein Datei-Name festgelegt; Standard-Wert zurückliefern.
 * en: No file-name defined; return the default text. */
        return locstrWindowsLogFileName;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrWindowsLogFileName = elementWindowsLogFileName.getTextTrim();
      return locstrWindowsLogFileName;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Holen des Wertes des XML-Elementes <StorebleExplanationText>.
 * Diese Nachricht informiert den Anwender dass beim Ausführen seiner gewünschten
 * Aktion geänderte Daten nicht gespeichert werden aber die Daten fehlerfrei sind
 * und ein Speichern noch möglich ist.
 * en:
 * METHOD to get the value of the XML-element <StoreableExplanationText>.
 * This message informs the user that changed data will not be stored if he continues
 * with the desired action. But the entered data is without errors and can be still stored. */
    public String getStoreableExplanationText() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Text der zurückgeliefert wird.
 * Der String enthält einen Standard-Hinweis im Fall dass ein passendes Element nicht
 * in der XML-Struktur vorhanden ist.
 * en:
 * String with the text that is returned.
 * It contains a default-message in case that a suitable element is not within
 * the XML-structure. */
      String locstrStoreableExplanationText = "Changed data not stored; storing now possible !";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <StoreableExplanationText>.
 * en: Get the child-element <StoreableExplanationText>. */
      Element elementStoreableExplanationText = XML_RootElement.getChild("StoreableExplanationText");
      if (elementStoreableExplanationText == null) {
/* 
 * de:
 * Sogar der Hinweis-Text mit der Information dass eine spezifische Nachricht nicht verfügbar
 * ist fehlt. Standard-Text zurückliefern.
 * en:
 * Even the Message-Text informing that no specific Message is available is missing.
 * Return the default text. */
        return locstrStoreableExplanationText;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrStoreableExplanationText = elementStoreableExplanationText.getTextTrim();
      return locstrStoreableExplanationText;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Holen des Wertes des XML-Elementes <NotStorebleExplanationText>.
 * Diese Nachricht informiert den Anwender dass beim Ausführen seiner gewünschten
 * Aktion geänderte Daten nicht gespeichert werden. Ein Speichern ist aber nicht 
 * möglich weil die geänderten Daten fehlerhaft sind.
 * en:
 * METHOD to get the value of the XML-element <NotStoreableExplanationText>.
 * This message informs the user that changed data will not be stored if he continues
 * with the desired action. The entered data has errors and can not be stored. */
    public String getNotStoreableExplanationText() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Text der zurückgeliefert wird.
 * Der String enthält einen Standard-Hinweis im Fall dass ein passendes Element nicht
 * in der XML-Struktur vorhanden ist.
 * en:
 * String with the text that is returned.
 * It contains a default-message in case that a suitable element is not within
 * the XML-structure. */
      String locstrNotStoreableExplanationText = "Changed data not stored; data has errors !";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <NotStoreableExplanationText>.
 * en: Get the child-element <NotStoreableExplanationText>. */
      Element elementNotStoreableExplanationText = XML_RootElement.getChild("NotStoreableExplanationText");
      if (elementNotStoreableExplanationText == null) {
/* 
 * de:
 * Sogar der Hinweis-Text mit der Information dass eine spezifische Nachricht nicht verfügbar
 * ist fehlt. Standard-Text zurückliefern.
 * en:
 * Even the Message-Text informing that no specific Message is available is missing.
 * Return the default text. */
        return locstrNotStoreableExplanationText;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrNotStoreableExplanationText = elementNotStoreableExplanationText.getTextTrim();
      return locstrNotStoreableExplanationText;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Holen des Datei-Namens mit dem Graphischen Symbol (Icon) für einen
 * Warnungs-Hinweis.
 * Dieses Symbol unterstützt den Anwender beim Erkennen warum das Dialog-Fenster angezeigt wird.
 * en:
 * METHOD to get the file-name with the Icon for a Warning-Message.
 * This symbol assists the user in recognizing the reason why the dialog-window is shown. */
    public String getWarningIconFileName() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Namen der Datei.
 * Der String enthält eine leere Zeichenkette wenn kein passendes XML-Element gefunden wird.
 * en:
 * String with the name of the file.
 * It contains an empty string if a fitting XML-Element is not found. */
      String locstrWarningIconFileName = "";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <WarningIconFileName>.
 * en: Get the child-element <WarningIconFileName>. */
      Element elementWarningIconFileName = XML_RootElement.getChild("WarningIconFileName");
      if (elementWarningIconFileName == null) {
/* 
 * de:
 * Kein Graphisches Symbol festgelegt; Standard-Wert (bei der Definition der Variable definiert)
 * zurückliefern.
 * en:
 * No Icon defined; return the default-value (defined when the variable was defined). */
        return locstrWarningIconFileName;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrWarningIconFileName = elementWarningIconFileName.getTextTrim();
      return locstrWarningIconFileName;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Holen des Datei-Namens mit dem Graphischen Symbol (Icon) für den Hinweis
 * dass ein schwerer Fehler aufgetreten ist und das Anwendungsprogramm beendet wird.
 * Dieses Symbol unterstützt den Anwender beim Erkennen warum das Dialog-Fenster angezeigt wird.
 * en:
 * METHOD to get the file-name with the Icon for the message that a severe error occured and
 * that the application-program will be terminated.
 * This symbol assists the user in recognizing the reason why the dialog-window is shown. */
    public String getErrorIconFileName() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Namen der Datei.
 * Der String enthält eine leere Zeichenkette wenn kein passendes XML-Element gefunden wird.
 * en:
 * String with the name of the file.
 * It contains an empty string if a fitting XML-Element is not found. */
      String locstrErrorIconFileName = "";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <ErrorIconFileName>.
 * en: Get the child-element <ErrorIconFielName>. */
      Element elementErrorIconFileName = XML_RootElement.getChild("ErrorIconFileName");
      if (elementErrorIconFileName == null) {
/* 
 * de:
 * Kein Graphisches Symbol festgelegt; Standard-Wert (bei der Definition der Variable definiert)
 * zurückliefern.
 * en:
 * No Icon defined; return the default-value (defined when the variable was defined). */
        return locstrErrorIconFileName;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrErrorIconFileName = elementErrorIconFileName.getTextTrim();
      return locstrErrorIconFileName;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Holen des Wertes des XML-Elementes <UnixStyleLogDirectoryAndFileName>.
 * Dieser Wert enthält den Datei-Namen (inklusive voller Verzeichnis-Struktur) für die
 * Datei in der auftretende Fehler gespeichert werden.
 * Der Datei-Name ist im Stil für Unix-Betriebssysteme.
 * en:
 * METHOD to get the value of the XML-element <UnixStyleLogDirectoryAndFileName>.
 * This value contains the file-name (including the full directory structure) for the file
 * to log occured errors.
 * The style of the file-name is according to Unix-operating-systems. */
    public String getUnixStyleLogDirectoryAndFileName() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Namen der Datei.
 * Der String enthält eine leere Zeichenkette wenn kein passendes XML-Element gefunden wird.
 * en:
 * String with the name of the file.
 * It contains an empty string if a fitting XML-Element is not found. */
      String locstrUnixStyleLogDirectoryAndFileName = "";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <UnixStyleLogDirectoryAndFileName>.
 * en: Get the child-element <UnixStyleLogDirectoryAndFileName>. */
      Element elementUnixStyleLogDirectoryAndFileName =
                                XML_RootElement.getChild("UnixStyleLogDirectoryAndFileName");
      if (elementUnixStyleLogDirectoryAndFileName == null) {
/* 
 * de:
 * Keine Datei festgelegt; Standard-Wert (bei der Definition der Variable definiert)
 * zurückliefern.
 * en:
 * No Log-File defined; return the default-value (defined when the variable was defined). */
        return locstrUnixStyleLogDirectoryAndFileName;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrUnixStyleLogDirectoryAndFileName = elementUnixStyleLogDirectoryAndFileName.getTextTrim();
      return locstrUnixStyleLogDirectoryAndFileName;
    }
/*
 * ************************************************** */
/*
 * de:
 * METHODE zum Holen des Wertes des XML-Elementes <WindowsStyleLogDirectoryAndFileName>.
 * Dieser Wert enthält den Datei-Namen (inklusive Laufwerk und voller Verzeichnis-Struktur)
 * für dieDatei in der auftretende Fehler gespeichert werden.
 * Der Datei-Name ist im Stil für Windows-Betriebssysteme.
 * en:
 * METHOD to get the value of the XML-element <WindowsStyleLogDirectoryAndFileName>.
 * This value contains the file-name (including the file and the full directory structure)
 * for the file to log occured errors.
 * The style of the file-name is according to Windows-operating-systems. */
    public String getWindowsStyleLogDirectoryAndFileName() {
/* 
 * Variable / Variables: */
/*
 * de:
 * String mit dem Namen der Datei.
 * Der String enthält eine leere Zeichenkette wenn kein passendes XML-Element gefunden wird.
 * en:
 * String with the name of the file.
 * It contains an empty string if a fitting XML-Element is not found. */
      String locstrWindowsStyleLogDirectoryAndFileName = "";
/* 
 * de:
 * StatusCode auf OK setzen damit am Ende der Methode geprüft werden kann ob ein Fehler
 * aufgetreten ist.
 * en:
 * Set the StatusCode to OK to see at the end of the method if anything went wrong. */
      StatusCode = CONST_OK;
/* 
 * de: Holen des Child-Elements <UnixStyleLogDirectoryAndFileName>.
 * en: Get the child-element <UnixStyleLogDirectoryAndFileName>. */
      Element elementWindowsStyleLogDirectoryAndFileName =
                                XML_RootElement.getChild("WindowsStyleLogDirectoryAndFileName");
      if (elementWindowsStyleLogDirectoryAndFileName == null) {
/* 
 * de:
 * Keine Datei festgelegt; Standard-Wert (bei der Definition der Variable definiert)
 * zurückliefern.
 * en:
 * No Log-File defined; return the default-value (defined when the variable was defined). */
        return locstrWindowsStyleLogDirectoryAndFileName;
      }
/* 
 * de: Holen des Wertes des XML-Elementes und diesen zurückliefern.
 * en: Get the value of the XML-element and return it. */
      locstrWindowsStyleLogDirectoryAndFileName = elementWindowsStyleLogDirectoryAndFileName.getTextTrim();
      return locstrWindowsStyleLogDirectoryAndFileName;
    }
}

▲ zum Inhaltsverzeichnis

Erklärungen und Anwendungsbeispiele

xxx

▲ zum Inhaltsverzeichnis

Verwandte Dokumentation

▲ zum Inhaltsverzeichnis