okw

Class OKW_Memorize_Sngltn

java.lang.Object

okw.OKW_Memorize_Sngltn

public class OKW_Memorize_Sngltn
extends Object

\~german OKW_Memorize ist die Speicher-Klasse hinter den Merke*-Schlüsselwörter. Mit Memorize*( "BN", "myKeyname" ) wird ein Wert Diese Klasse ist nach dem Singelton-Pattern aufgebaut. Eine Instanz der Klasse wird wie folgt erstellt: ~~~~~~~~~~~~~{.java} OKW.OKW_Memorrize.getInstance() ~~~~~~~~~~~~~ \~english \~ \author Zoltán Hrabovszki \date 2013.12.06 \

Field Summary

Fields

Modifier and Type	Field and Description
protected static OKW_Memorize_Sngltn	Instance \~german Singelton spezifisch: Dieses Feld speichert die einzige Instanz dieser Klasse.
protected LogMessenger	LM \~german Eine lokale Instanz des OKW.Log.LogMssenger.
protected Logger_Sngltn	Log \~german Referenz auf die einzige Instanz des Klasse OKW.Logger.
String	OKW_Memorize_xml \~german Variable hält Pfad und Dateinamen der OKW_Memorize.xml.
protected OKW_Properties	Properties
protected Map<String,String>	Value \~german Dictionary speichert die Schlüssel-Wert Paare.
protected Map<String,String>	ValuePersistent \~german Dictionary speichert Schlüssel-Wert Paare.

Method Summary

Modifier and Type	Method and Description
Boolean	exists(String fpsKey) \~german Prüft ob es eine Eintrag zum Schlüssel _fpsKey_ vorhanden ist.
String	get(String fpsKey) \~german Holt den aktuellen Wert des gegebennen Schlüssels.
static OKW_Memorize_Sngltn	getInstance() \~german Diese Methode gibt die einzige Instanz dieser Klasse zurück.
Integer	getKeysCount() \~german Holt die aktuelle Anzahl der gespeicherten Werte.
void	init() \~german Initialsiert die Klasse OKW.OKW_Memorize Die Initialisierung der Klasse OKW.OKW_Ini läuft wie folgt ab: /startuml{OKW_Memorize_de.png} start :Lösche alle Werte im Speicher (**_Value**); :Hole Pfad und Dateiname\naus der **OKW_Ini.xml**; if (Ist Pfad und Dateiname\n für\n **OWK_Memorize.xml**\n gegeben?) then (ja) if (Ist die gegebene Datei\n vorhanden?) then (ja) :this.Read()> else (nein) :Gebe eine Warnung aus ; endif else(nein) :Gebe eine Warnung: **'OKW_Memorize'** ist nicht gesetzt!; endif stop /enduml \~english \~ \author Zoltán Hrabovszki \date 2013.11.28
void	reset() \~german Methode setzt diese Klasse zurück.
void	save() \~german Schreibt die Felder (fields) der Klasse OKW_Memorize in eine Datei.
void	set(String fpsKey, String fpsValue) \~german Setzt/Merkt sich das MemKey/Value-Paar.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OKW_Memorize_xml

public String OKW_Memorize_xml

\~german Variable hält Pfad und Dateinamen der OKW_Memorize.xml. \~english \~

Value

protected Map<String,String> Value

\~german Dictionary speichert die Schlüssel-Wert Paare. Die Hier gespeicherten werte sind nicht persistent. \~english \brief \~ \author Zoltán Hrabovszki \date 2013.11.28

ValuePersistent

protected Map<String,String> ValuePersistent

\~german Dictionary speichert Schlüssel-Wert Paare. Die Hier gespeicherten werte sind persistent. Die Werte werden aus/in die Datei gespeichert der Datei \~english \brief \~ \author Zoltán Hrabovszki \date 2019.11.25

Instance

protected static OKW_Memorize_Sngltn Instance

\~german Singelton spezifisch: Dieses Feld speichert die einzige Instanz dieser Klasse. Es wird die Properties Datein geladen, die im OKW-Property "OKW_Memorize.properties" angegeben ist Der Default Wert ist "OKW_Memorize.properties". Diese Datei wird automatisch beim Initialisieren der Klasse geladen und bei jedem Setzen des wertes in der Datei, gegeben in "OKW_Memorize.properties", gespeichert. \~english \~

LM

protected LogMessenger LM

\~german Eine lokale Instanz des OKW.Log.LogMssenger. \~english \~

Log

protected Logger_Sngltn Log

\~german Referenz auf die einzige Instanz des Klasse OKW.Logger. \~english \~

Properties

protected OKW_Properties Properties

Method Detail

getInstance

public static OKW_Memorize_Sngltn getInstance()

\~german Diese Methode gibt die einzige Instanz dieser Klasse zurück. Nachdem Singelton-Muster wird die einzige Instanz der Klasse mit einer Methode abgerufen. Diese Methode erzeug eine Instanz dieser Klasse und initialisiert diesen, sofern nicht bereits eine Instanz der Klasse exsistiert. Wenn eine Instenz bereits vorhanden ist, dann wird nur die Referenz auf die Instanz zurückgeliefert Beipsiele für die Verwendung sind unter der Beschreibung dieser Klasse, OKW.OKW_Memorize, zu finden. \~english \~

reset

public void reset()

\~german Methode setzt diese Klasse zurück. Nach Aufruf dieser Methode befinden sich die Klasse im Initialzustand. Dazu wird die Instance-Variable auf__null__ gesetzt. Wird in erster Linie für die Unittest benötigt. \~

exists

public Boolean exists(String fpsKey)

\~german Prüft ob es eine Eintrag zum Schlüssel _fpsKey_ vorhanden ist. Nach Aufruf dieser Methode befinden sich die Klasse im Initialzustand. Dazu wird die Instance-Variable auf__null__ gesetzt. Wird in erster Linie für die Unittest benötigt. \param fpsKey Schlüssel, der geprüft werden soll. \returntrue, falls der gegeben schlüssel existiert, sonst false\return \~

get

public String get(String fpsKey)

\~german Holt den aktuellen Wert des gegebennen Schlüssels. Kernfunktion dieser Klasse. Holt zum gegeben Schlüssel _fpsKey_ den aktuellwert aus OKW_Memmorize._Value.

Throws:

Es - wird die Ausnahme OKWMemorizeKeyNotExistsException ausgelöst, wenn ein Schlüssel abgefragt wird, der vorher nicht eigespeichert wurde. \param fpsKey \~english \~

getKeysCount

public Integer getKeysCount()

\~german Holt die aktuelle Anzahl der gespeicherten Werte. \~english \~

init

public void init()

\~german Initialsiert die Klasse OKW.OKW_Memorize Die Initialisierung der Klasse OKW.OKW_Ini läuft wie folgt ab: /startuml{OKW_Memorize_de.png} start :Lösche alle Werte im Speicher (**_Value**); :Hole Pfad und Dateiname\naus der **OKW_Ini.xml**; if (Ist Pfad und Dateiname\n für\n **OWK_Memorize.xml**\n gegeben?) then (ja) if (Ist die gegebene Datei\n vorhanden?) then (ja) :this.Read()> else (nein) :Gebe eine Warnung aus ; endif else(nein) :Gebe eine Warnung: **'OKW_Memorize'** ist nicht gesetzt!; endif stop /enduml \~english \~ \author Zoltán Hrabovszki \date 2013.11.28

save

public void save()

\~german Schreibt die Felder (fields) der Klasse OKW_Memorize in eine Datei. Es wird eine XML Datei geschrieben. Hierzu wird die Klasse OKW_Ini mit der Klasse System.Xml.XmlSerializer serialisiert. Pfad und Name der XML-Datei. Dies wird in der XML/OKW_Ini.xml vorgegeben: XPATH: OKW_Ini/OKW_Enviroment/OKW_Memorize_xml \~english \~ \author Zoltán Hrabovszki \date 2013.11.28 /TODO: Prüfen wozu das hier nich benötigt wird.

set

public void set(String fpsKey,
                String fpsValue)
         throws XPathExpressionException

\~german Setzt/Merkt sich das MemKey/Value-Paar.

Parameters:

fpsKey - MemKey - Schlüssel für den Zugriff auf den Wert.

fpsValue - Wert, der gemerkt werden soll.

fpsKey -

fpsValue -

Throws:

XPathExpressionException - \~english

XPathExpressionException - \~ \author Zoltán Hrabovszki \date 2014.12.27