OKW_Const_Sngltn (OKW - OpenKeyWord 0.1.0 API)

java.lang.Object
- okw.OKW_Const_Sngltn

```
public class OKW_Const_Sngltn
extends Object
```
\~german OKW_Const verwaltet die sprachabhängigen OKW-Konstanten. Entwurfsmuster: Singleton - es gilt das Highländer-Prinzip "Es kann nur einen geben".
Das bedeutet, dass es nur eine Instanz dieser Klasse gibt, die zum Lesen der Nachrichten zuständig ist. Die sprachabhängigen Werte, die zu dieser Klasse gehören, stehen in der Datei "OKW_Const.xml". Diese Klasse selbst ist eine OKW-Fundametalklasse und gibt selbst keine Dokumentationen (Logs) aus.
Begriffe:
Hier ist eine Liste der Bezeichner/ Namen/ Begriff zusammengestellt, die im Rahmen dieser Klasse verwendet werden. - __Const__ ist die sprachabhängige Konstante zu einer internen Konstante (ohne Klammerung). - __OKWConst__ ist die sprachabhängige Konstante, die nach außen hin in Erscheinung tritt. Sie hat die Form für die deutsche Implementierung: _${Bezeichner}_ und enstpricht der _Const_ mit Klammerung. - __Internalname__ ist die sprachunabhängige interne Bezeichnung einer Const. Siehe folgende Tabelle: | Internalname | Const (DE) | OKWConst (DE) | | -----------: | :--------: | :-----------: | | SEP | SEP | ${SEP} | | VSEP | VSEP | ${VSEP} | | VSEP | VSEP | ${VSEP} | | DELETE | LÖSCHEN | ${LÖSCHEN} | | EMPTY | LEER | ${LEER} | | IGNORE | IGNORIEREN | ${IGNORIEREN} | | YES | JA | - | | NO | NEIN | - | | CHECKED | ANGEWÄHLT | - | | UNCHECKED | ABGEWÄHLT | - | | LEFTBRACE | ${ | - | | RIGHTBRACE | } | - | \~english OKW_Const manages the language dependent OKW-Constants. Designpattern: Singleton - the Highlander-Principle is valid "There only can be one!".
This means there is only one instance of this class, which is responsible for reading the news. The language dependent values belonging to this class are in the file "OKW_Const.xml" This class itself is an OKW-fundamental-class and returns no logs for its own.
Terms
Here is a list of identifier / name / term created to be used in this class. - _Const_ is the language dependent constant to an internal constant(no brackets) - __OKWConst__ is the language dependent constant, appearing outward. It has the form for the German implementation: _${Bezeichner}_ and corresponds _Const_ with brackets. - _Internalname_ is the non language dependent internal identifier of a Const. Look following table: | Internal Name| Const (EN) | OKW_Const (EN)| | -----------: | :--------- | :------------ | | SEP | SEP | ${SEP} | | VSEP | VSEP | ${VSEP} | | HSEP | HSEP | ${HSEP} | | DELETE | DELETE | ${DELETE} | | EMPTY | EMPTY | ${EMPTY} | | IGNORE | IGNORE | ${IGNORE} | | YES | YES | - | | NO | NO | - | | CHECKED | CHECKED | - | | UNCHECKED | UNCHECKED | - | | LEFTBRACE | ${ | - | | RIGHTBRACE | } | - | \~

Author:

Zoltan Hrabovszki

Constructor Summary

Constructors
Modifier Constructor and Description

protected OKW_Const_Sngltn()
\~german Privater Konstruktor ohne Parameter im Entwurfsmuster Singelton initialisiert die Klasse OKW_Const.

Constructors
Modifier	Constructor and Description
`protected`	`OKW_Const_Sngltn()` \~german Privater Konstruktor ohne Parameter im Entwurfsmuster Singelton initialisiert die Klasse OKW_Const.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`Boolean2YesNo(Boolean fpbTrueOrFalse)` \~german Konvertiert WAHR/FALSCH (true/false) sprachabhängig nach "Ja"/"Nein" (Yes/No) \param fpbTrueOrFalse WAHR oder FALSCH \return "Ja" für true "Nein" für false \~english Converts true/false language dependent to yes/no \param fps_YesOrNo true or false \return "yes" in case of true "no" in case of false \~
`String`	`ConcatHSEP(ArrayList<String> fpLs_ListString2Concat)` \~german Methode _verbindet_ die einzelne Strings eines `List<Strings>` zu einem `string` und trennt diese mit der Konstante ${HSEP}.
`String`	`ConcatSEP(ArrayList<String> fpLs_ListString2Concat)` \~german Methode _verbindet_ die einzelne Strings eines `List<Strings>` zu einem `string` und trennt diese mit der Konstante ${SEP}.
`String`	`ConcatVSEP(ArrayList<String> fpLs_ListString2Concat)` \~german Methode _verbindet_ die einzelnen Strings eines `List<Strings>` zu einem `string` und trennt diese mit der Konstante ${VSEP}.
`String`	`GetConst4Internalname(String fpsInternalname)` \~german Methode ermittelt für __Internalname__ und der aktuell eingestellten Sprache den Wert für __Const__.
`static OKW_Const_Sngltn`	`getInstance()` \~german Holt die einzige Instanz dieser Klasse. Die Instanz dieser Klasse.
`String`	`GetOKWConst4Internalname(String fpsInternalname)` \~german Methode ermittelt für __Internalname__ und der aktuell eingestellten Sprache den Wert für __OKWConst__.
`ArrayList<String>`	`SplitHSEP(String fpsString2Split)` \~german Methode trennt einen String und wandelt diesen in eine ListString um.
`ArrayList<String>`	`SplitSEP(String fpsString2Split)` \~german Methode trennt einen String und wandelt diesen in einen ListString um.
`ArrayList<String>`	`SplitVSEP(String fps_String2Split)` \~german Methode trennt einen String und wandelt diesen in einen ListString um.
`Boolean`	`YesNo2Boolean(String fpsYesOrNo)` \~german Konvertiert sprachabhängig Ja/Nein zu einem Booleanean Wert (Wahr/Falsch). Beispiele: Sprache ist "de": Eingabe "JA" -> Ausgabe Wahr Sprache ist "de": Eingabe "NEIN" -> Ausgabe Falsch Sprache ist "en": Eingabe "JA" oder "NEIN" -> löst die Exception OKWNotAllowedValueException aus.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OKW_Const_Sngltn
```
protected OKW_Const_Sngltn()
```
    \~german Privater Konstruktor ohne Parameter im Entwurfsmuster Singelton initialisiert die Klasse OKW_Const. Die Initialisierung erfolgt wie folgt: /startuml{OKW_Const_de.png} start :Löse Pfad zu\n **"OKW_Const.xml"**\n auf ; note right: Wird aus der Umgebungvariable\n **PathXML**\n gebildet if ( \nExistiert die Datei\n **"OKW_Const.xml"**?\n) then (ja) :Erzeuge **XPathDocument()** **CreateNavigator()**; else (nein) :Löse **FileNotFoundException** aus; note right: Danach wird\n die Ausführung\n des Skriptes beendet. endif stop /enduml
    
    Throws:
    
    A - _System.IO.FileNotFoundException_ is triggered, if the file OKW_Const.xml is not found. \~
- Method Detail
  - getInstance
```
public static OKW_Const_Sngltn getInstance()
```
    \~german Holt die einzige Instanz dieser Klasse.
    Die Instanz dieser Klasse. Lazy Initialization (If required then only) \~english Gets the only instance of this class.
    The instance of this class. \~
  - Boolean2YesNo
```
public String Boolean2YesNo(Boolean fpbTrueOrFalse)
                     throws XPathExpressionException
```
    \~german Konvertiert WAHR/FALSCH (true/false) sprachabhängig nach "Ja"/"Nein" (Yes/No) \param fpbTrueOrFalse WAHR oder FALSCH \return "Ja" für true
    "Nein" für false \~english Converts true/false language dependent to yes/no \param fps_YesOrNo true or false \return "yes" in case of true
    "no" in case of false \~
    
    Throws:
    
    XPathExpressionException
  - ConcatHSEP
```
public String ConcatHSEP(ArrayList<String> fpLs_ListString2Concat)
                  throws XPathExpressionException
```
    \~german Methode _verbindet_ die einzelne Strings eines List<Strings> zu einem string und trennt diese mit der Konstante ${HSEP}. Die Methode arbeitet sprachabhängig, womit die Trennkonstante in der aktuellen Sprache verwendet wird.
    
    Parameters:
    
    fpLs_ListString2Concat - List-String, der zu einem String verbunden werden soll. Beispiel: {"Wert1", "Wert2", "Wert3", "Wert4"}
    
    fpLs_ListString2Concat - List-String, to be combined to a single string.
    Example: {"Value1", "Value2", "Value3", "Value4"}
    
    Returns:
    
    Verbundene Werte "Wert1${HSEP}Wert2${HSEP}Wert3${HSEP}Wert4 \~english The method connects single strings of a list-String to one String and separates it with the constant ${HSEP}. The method is working language dependent meaning that the separation constant is used in the actual language.
    
    Throws:
    
    XPathExpressionException
  - ConcatSEP
```
public String ConcatSEP(ArrayList<String> fpLs_ListString2Concat)
                 throws XPathExpressionException
```
    \~german Methode _verbindet_ die einzelne Strings eines List<Strings> zu einem string und trennt diese mit der Konstante ${SEP}. Die Methode arbeitet sprachabhängig, d.h. es wird die Trennkonstante der aktuellen Sprache verwendet.
    
    Parameters:
    
    fpLs_ListString2Concat - List-String, die zu einem String verbunden werden soll. Beispiel: {"Wert1", "Wert2", "Wert3", "Wert4"}
    
    fpLs_ListString2Concat - ListString to be combined to one string. Example: {"Value1", "Value2", "Value3", "Value4"}
    
    Returns:
    
    Verbundene Werte "Wert1${SEP}Wert2${SEP}Wert3${SEP}Wert4 \~english Method combines single strings of a listString to one String and separates it with the constant ${SEP}. The method works language dependent using the separation constant with the actual language.
    
    Throws:
    
    XPathExpressionException
  - ConcatVSEP
```
public String ConcatVSEP(ArrayList<String> fpLs_ListString2Concat)
                  throws XPathExpressionException
```
    \~german Methode _verbindet_ die einzelnen Strings eines List<Strings> zu einem string und trennt diese mit der Konstante ${VSEP}. Die Methode arbeitet sprachabhänging, d.h es wird die Trennkonstante der aktuellen Sprache verwendet.
    
    Parameters:
    
    fpLs_ListString2Concat - List-String, der zu einem String verbunden werden soll. Beispiel: {"Wert1", "Wert2", "Wert3", "Wert4"}
    
    fpLs_ListString2Concat - List-String, to be combined to a single string. Example: {"Value1", "Value2", "Value3", "Value"}
    
    Returns:
    
    Verbundene Werte "Wert1${VSEP}Wert2${VSEP}Wert3${VSEP}Wert4 \~english Method combines single strings of a listString to a single string and separates it with the constant ${VSEP}. The method is working language dependent using the separation constant of the actual language
    
    Throws:
    
    XPathExpressionException
  - GetConst4Internalname
```
public String GetConst4Internalname(String fpsInternalname)
```
    \~german Methode ermittelt für __Internalname__ und der aktuell eingestellten Sprache den Wert für __Const__. GetConst4Internalname ist die Kernmethode dieser Klasse und ermittelt für
    - fpsInternalname und - CL.Language enstpricht OKWLanguage.Instance.Language
    die sprachabhängige Konstante.
    Parameters:
    
    fpsInternalname - Interner Bezeichner einer Konstante, die in eine sprachabhängige Konstante umgestetzt wird. (_Internalname_ -> _Const_)
    
    fpsInternalname - Internal identifier of a constant, which is converted to a language dependent constant. (_Internalname_ -> _Const_)
    
    Returns:
    
    Liefert die Sprachabhängige Konstante des
    
    Throws:
    Wird - für fpsInternalname kein Wert gefunden, dann wird die Ausnahme OKWConst4InternalnameNotFoundException ausgelöst. \~english Method detects the value for __Const__ for the __internalname__ and the actual selected language. GetConst4Internalname is the core method of this class and detects for
    
    fpsInternalname and - CL.Language corresponds to
    
    OKWLanguage.Instance.Language the language dependent constant.
    If - no value is found for fpsInternalname, then the exception OKWConst4InternalnameNotFoundException is triggered.
  - GetOKWConst4Internalname
```
public String GetOKWConst4Internalname(String fpsInternalname)
```
    \~german Methode ermittelt für __Internalname__ und der aktuell eingestellten Sprache den Wert für __OKWConst__. GetOKWConst4Internalname wählt für - fpsInternalname und - CL.Language (Lokale Referenz auf OKWLanguage.Instance.Language) die sprachabhängige Konstante aus und setzt diese in Klammern. | Internalname | OKW_Const (DE)| | -----------: | :------------ | | SEP | ${SEP} | | VSEP | ${VSEP} | | HSEP | ${HSEP} | | DELETE | ${LÖSCHEN} | | EMPTY | ${LEER} | | IGNORE | ${IGNORIEREN} | Beispiel: "$IGNORIEREN" == GetOKWConst4Internalname("IGNORE")
    
    Parameters:
    
    fpsInternalname - Internalname der Konstante. Beispiel: "IGNORE"
    
    fpsInternalname - Internalname of constant. Example: "IGNORE"
    
    Returns:
    
    Eingeklammerte Konstante. Beispiel: "${IGNORIEREN}" für "IGNORE" \~english Method detects for __Internalname__ and the actual selected language the value for __OKWConst__. GetOKWConst4Internalname selects for - fpsInternalname and - CL.Language (local reference for OKWLanguage.Instance.Language) the language dependent constant and places it in brackets. | Internalname | OKW_Const (DE)| | -----------: | :------------ | | SEP | ${SEP} | | VSEP | ${VSEP} | | HSEP | ${HSEP} | | DELETE | ${DELETE} | | EMPTY | ${EMPTY} | | IGNORE | ${IGNORE} | Example: "$IGNORE" == GetOKWConst4Internalname("IGNORE")
  - SplitHSEP
```
public ArrayList<String> SplitHSEP(String fpsString2Split)
                            throws XPathExpressionException
```
    \~german Methode trennt einen String und wandelt diesen in eine ListString um. Der Schnitt wird an der Konstante ${HSEP} vorgenommen. Die Methode arbeitet sprachabhänging, d.h es wird jeweils die Trennkonstante der aktuellen Sprache verwendet.
    
    Parameters:
    
    fpsString2Split - Ein oder mehrere Werte, die mit ${HSEP} getrennt sind.
    Beispiel: "Wert1${HSEP}Wert2${HSEP}Wert2"
    
    fpsString2Split - One or more values, which are divided with ${HSEP}.
    Example: "Value1${HSEP}Value2${HSEP}Value2"
    
    Returns:
    
    Getrennte Werte als Liste. Beispiel: {"Wert1", "Wert2", "Wert3"} \~english Method separates a String and converts it to a liststring. The cut is set at the constant ${HSEP}. The method is working language dependent meaning it is used the separation constant of the actual language.
    
    Throws:
    
    XPathExpressionException
    
    See Also:
    
    OKWConst::ConcatHSEP() OKWConst::ConcatVSEP() OKWConst::SplitSEP() OKWConst::SplitVSEP(), OKWConst::ConcatHSEP() OKWConst::ConcatVSEP() OKWConst::SplitSEP() OKWConst::SplitVSEP()
  - SplitSEP
```
public ArrayList<String> SplitSEP(String fpsString2Split)
                           throws XPathExpressionException
```
    \~german Methode trennt einen String und wandelt diesen in einen ListString um. Der Schnitt wird an der Konstante ${SEP} vorgenommen. Die Methode arbeitet sprachabhänging, d.h es wird jeweils die Trennkonstante der aktuellen Sprache verwendet.
    
    Parameters:
    
    fpsString2Split - Ein oder mehrere Werte, die mit ${SEP} getrennt sind.
    Beispiel: "Wert1${SEP}Wert2${SEP}Wert2"
    
    fpsString2Split - One or more values, which are separated with ${SEP}.
    Example: "Value1${SEP}Value2${SEP}Value2"
    
    Returns:
    
    Getrennte Werte als Liste. Beispiel: {"Wert1", "Wert2", "Wert3"} \~english Method separates a String and converts it to a liststring. The cut is set at the constant ${SEP} The method is working language dependant meaning it is used the separation constant of the actual language.
    
    Throws:
    
    XPathExpressionException
    
    See Also:
    
    OKWConst::ConcatHSEP() OKWConst::ConcatVSEP() OKWConst::SplitHSEP() OKWConst::SplitVSEP(), OKWConst::ConcatHSEP() OKWConst::ConcatVSEP() OKWConst::SplitHSEP() OKWConst::SplitVSEP()
  - SplitVSEP
```
public ArrayList<String> SplitVSEP(String fps_String2Split)
                            throws XPathExpressionException
```
    \~german Methode trennt einen String und wandelt diesen in einen ListString um. Der Schnitt wird an der Konstante ${VSEP} vorgenommen. Die Methode arbeitet sprachabhänging, d.h es wird jeweils die Trennkonstante der aktuellen Sprache verwendet.
    
    Parameters:
    
    fpsString2Split - Ein oder mehrer Werte, die mit ${VSEP} getrennt sind.
    Beispiel: "Wert1${VSEP}Wert2${VSEP}Wert2"
    
    fpsString2Split - One or more values, which are separated with ${VSEP}.
    Example: "value1${VSEP}value2${VSEP}value2"
    
    Returns:
    
    Getrennte Werte als Liste. Beispiel: {"Wert1", "Wert2", "Wert3"} \~english Method devides a String and converts it to a liststring. The cut is set at the constant ${VSEP} The method is working language dependent meaning it is used the separation constant of the actual language.
    
    Throws:
    
    XPathExpressionException
    
    See Also:
    
    OKWConst::ConcatHSEP() OKWConst::ConcatVSEP() OKWConst::SplitHSEP() OKWConst::SplitSEP(), OKWConst::ConcatHSEP() OKWConst::ConcatVSEP() OKWConst::SplitHSEP() OKWConst::SplitSEP()
  - YesNo2Boolean
```
public Boolean YesNo2Boolean(String fpsYesOrNo)
                      throws XPathExpressionException
```
    \~german Konvertiert sprachabhängig Ja/Nein zu einem Booleanean Wert (Wahr/Falsch).
    Beispiele: Sprache ist "de": Eingabe "JA" -> Ausgabe Wahr
    Sprache ist "de": Eingabe "NEIN" -> Ausgabe Falsch
    Sprache ist "en": Eingabe "JA" oder "NEIN" -> löst die Exception OKWNotAllowedValueException aus. Beim der Eingabe muss die GROSS- und kleinschreibung nicht beachtet werden. "Ja", "JA" oder "ja" ist gleichwertig.
    
    Parameters:
    
    fpsYesOrNo - sprachabhängig Ja/Nein
    
    fpsYesOrNo - Language dependent Yes/No
    
    Returns:
    
    WAHR wenn sprachabhängiger Wert ist "Ja"
    FALSCH, wenn sprachabhängiger Wert "Nein" \~english Converts a Language dependent Yes/No to Boolean.
    e.g. Language is "en": Input "Yes" returns true
    e.g. Language is "en": Input "No" returns false
    e.g. Language is "de": Input "Yes" or "No" - raises the exception OKWNotAllowedValueException.
    
    Throws:
    
    OKWNotAllowedValueException - wird ausgelöst, wenn nicht eine sprachabhängiges Ja/Nein als Parameter eingegeben wird.
    
    XPathExpressionException

Class OKW_Const_Sngltn

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OKW_Const_Sngltn

Method Detail

getInstance

Boolean2YesNo

ConcatHSEP

ConcatSEP

ConcatVSEP

GetConst4Internalname

GetOKWConst4Internalname

SplitHSEP

SplitSEP

SplitVSEP

YesNo2Boolean