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. Die Daten werden vie Serialisierung in eine XML Datei geschrieben. Zur Serialisierung wird die Klasse System.Xml.XmlSerializer verwendet. Pfad und Name der XML-Datei. Dies wird in der XML/OKW_Ini.xml vorgegeben: XPATH: OKW_Ini/OKW_Enviroment/OKW_Memorize_xml Diese Klasse ist nach denm Singelton-Muster aufgebaut. Die Instanz der Klasse wird wie folgt abgerufen: ~~~~~~~~~~~~~{.py} OKW.OKW_Memorrize.Instanz ~~~~~~~~~~~~~ \~english \~ \author Zoltán Hrabovszki \date 2013.12.06 \

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,String>	_Value \~german Dictionary speichert die Schlüssel-Wert Paare.
String	OKW_Memorize_xml \~german Variable hält Pfad und Dateinamen der OKW_Memorize.xml.

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 eines Schlüssels.
static OKW_Memorize_Sngltn	getInstance() \~german Diese Methode gibt die einzige Instanz dieser Klasse zurück.
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
static 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

public Map<String,String> _Value

\~german Dictionary speichert die Schlüssel-Wert Paare.

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 static 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 eines 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 \~

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

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