OKW_Memorize ist die Speicher-Klasse hinter den Merke*-Schlüsselwörter. Mehr ...

Zusammengehörigkeiten von okw.OKW_Memorize_Sngltn:

Öffentliche Methoden
Boolean	exists (String fpsKey)
	Prüft ob es eine Eintrag zum Schlüssel fpsKey vorhanden ist. Mehr ...

String	get (String fpsKey)
	Holt den Aktuellen Wert eines Schlüssels. Mehr ...

void	init ()
	Initialsiert die Klasse OKW.OKW_Memorize. Mehr ...

void	load ()
	Liest die Werte der Klasse OKW_Memorize aus einer Datei, gegeben in OKW.OKW_Ini.Xml_Ini_xml, ein. Mehr ...

void	save ()
	Schreibt die Felder (fields) der Klasse OKW_Memorize in eine Datei. Mehr ...

void	set (String fpsKey, String fpsValue) throws XPathExpressionException
	Setzt/Merkt sich das MemKey/Value-Paar. Mehr ...

Öffentliche, statische Methoden
static OKW_Memorize_Sngltn	getInstance ()
	Diese Methode gibt die einzige Instanz dieser Klasse zurück. Mehr ...

static void	reset ()
	Methode setzt diese Klasse zurück. Mehr ...

Öffentliche Attribute
String	OKW_Memorize_xml = ""
	Variable hält Pfad und Dateinamen der OKW_Memorize.xml. Mehr ...

Geschützte Attribute
Map< String, String >	Value = new HashMap<String, String>()
	Dictionary speichert die Schlüssel-Wert Paare. Mehr ...

Map< String, String >	ValuePersistent = new HashMap<String, String>()
	Dictionary speichert Schlüssel-Wert Paare. Mehr ...

LogMessenger	LM = null
	Eine lokale Instanz des OKW.Log.LogMssenger. Mehr ...

Logger_Sngltn	Log = Logger_Sngltn.getInstance()
	Referenz auf die einzige Instanz des Klasse OKW.Logger. Mehr ...

OKW_Properties	Properties = OKW_Properties.getInstance()

Statische, geschützte Attribute
static OKW_Memorize_Sngltn	Instance
	Singelton spezifisch: Dieses Feld speichert die einzige Instanz dieser Klasse. Mehr ...

Private Methoden
	OKW_Memorize_Sngltn ()
	Privater Konstruktor dieser Klasse. Mehr ...

Ausführliche Beschreibung

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:

OKW.OKW_Memorrize.getInstance()

Autor: Zoltán Hrabovszki

Datum: 2013.12.06 \

Definiert in Zeile 73 der Datei OKW_Memorize_Sngltn.java.

Beschreibung der Konstruktoren und Destruktoren

◆ OKW_Memorize_Sngltn()

okw.OKW_Memorize_Sngltn.OKW_Memorize_Sngltn ( )

private

Privater Konstruktor dieser Klasse.

Zu beachten: Der Konstruktor muss private da Singelton.

Verwende die Methode OKW_Memorize.Instace() um eine Instanz dieser Klasse zu erhalten.

Autor: Zoltán Hrabovszki

Datum: 2014.14.27

Definiert in Zeile 167 der Datei OKW_Memorize_Sngltn.java.

     {
         try
         {
             LM = new LogMessenger("OKW_Memorize");
         }
         catch (Exception e)
         {
             OKW_HandleException.StopRunning(e, Instance.getClass());
         }
     }

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

Dokumentation der Elementfunktionen

◆ exists()

Boolean okw.OKW_Memorize_Sngltn.exists ( String fpsKey )

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.

Parameter

fpsKey Schlüssel, der geprüft werden soll. \returntrue, falls der gegeben schlüssel existiert, sonst false

Rückgabe

Autor: Zoltan Hrabovszki

Datum: 2013.11.25

Definiert in Zeile 247 der Datei OKW_Memorize_Sngltn.java.

     {
         Boolean lvbReturn = false;
  
         Log.LogFunctionStartDebug(Instance.getClass().getName() + ".Exists", "String fpsKey", fpsKey);
  
         if ( Value.containsKey(fpsKey))
         {
             lvbReturn = true;
         }
         else
         {
             lvbReturn = false;
         }
  
         Log.LogFunctionEndDebug(lvbReturn);
  
         return lvbReturn;
     }

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

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

◆ get()

String okw.OKW_Memorize_Sngltn.get ( String fpsKey )

Holt den Aktuellen Wert eines Schlüssels.

Kernfunktion dieser Klasse. Holt zum gegeben Schlüssel fpsKey den aktuellwert aus OKW_Memmorize._Value.

Ausnahmebehandlung

Es	wird die Ausnahme OKWMemorizeKeyNotExistsException ausgelöst, wenn ein Schlüssel abgefragt wird, der vorher nicht eigespeichert wurde.

Parameter

fpsKey

Autor: Zoltán Hrabovszki

Datum: 2014.12.27

Definiert in Zeile 284 der Datei OKW_Memorize_Sngltn.java.

     {
         String lvsReturn = null;
  
         Log.LogFunctionStartDebug(Instance.getClass().getName() + ".Get", "String fpsKey", fpsKey);
  
         try
         {
             if ( Value.containsKey(fpsKey))
             {
                 lvsReturn = Value.get(fpsKey);
             }
             else
             {
                 String ErrorText = LM.GetMessage("Get", "OKWMemorizeKeyNotExistsException", fpsKey);
                 throw new OKWMemorizeKeyNotExistsException(ErrorText);
             }
         }
         finally
         {
             Log.LogFunctionEndDebug(lvsReturn);
         }
  
         return lvsReturn;
     }

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

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

◆ getInstance()

static OKW_Memorize_Sngltn okw.OKW_Memorize_Sngltn.getInstance ( )

static

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.

Autor: Zoltán Hrabovszki

Datum: 2014.14.27

Definiert in Zeile 198 der Datei OKW_Memorize_Sngltn.java.

     {
         // Lazy Initialization (If required then only)
         if (Instance == null)
         {
             // Thread Safe. Might be costly operation in some case
             synchronized (OKW_Const_Sngltn.class)
             {
                 if (Instance == null)
                 {
                     Instance = new OKW_Memorize_Sngltn();
                     Instance.init();
                 }
             }
         }
         
         return Instance;
     }

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

◆ init()

void okw.OKW_Memorize_Sngltn.init ( )

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
für
OWK_Memorize.xml
gegeben?) then (ja)

if (Ist die gegebene Datei
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

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 342 der Datei OKW_Memorize_Sngltn.java.

     {
         Log.LogFunctionStartDebug(this.getClass().getName() + ".Init");
  
         // Klassen Variablen erst löschen...
         
         Instance.OKW_Memorize_xml = "";
         Instance.Value.clear();
  
         // ... und dann alles Initialisieren!
         // 1. Setze Pfad und
         OKW_Memorize_xml = OKW_Ini_Sngltn.getInstance().OKW_Enviroment.getFile_OKW_Memorize_xml();
  
         if (!OKW_Helper.isStringNullOrEmpty(this.OKW_Memorize_xml))
         {
             this.Log.LogPrintDebug("OKW Memorize Datei = >>" + this.OKW_Memorize_xml + "<<");
             if (OKW_FileHelper.fileExists(this.OKW_Memorize_xml))
             {
                 // Lesen der Daten...
                 //this.Read();
             }
             else
             {
                 // Deafault Werte Lesen.
                 Log.LogWarning("Datei: >>" + this.OKW_Memorize_xml + "<< nicht gefunden.");
             }
         }
         else
         {
             Log.LogWarning("Enviroment variable 'OKWIni' not set!");
         }
  
         Log.LogFunctionEndDebug();
     }

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

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

◆ load()

void okw.OKW_Memorize_Sngltn.load ( )

Liest die Werte der Klasse OKW_Memorize aus einer Datei, gegeben in OKW.OKW_Ini.Xml_Ini_xml, ein.

Es wird eine XML Datei gelesen. Hierzu wird die Klasse OKW_Memorize mit System.Xml.XmlSerializer deserialisiert.

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 388 der Datei OKW_Memorize_Sngltn.java.

         {
             Log.LogFunctionStartDebug(Instance.getClass().getName() + "load()");
     
             try
             {
                 OKW_XmlReader myXMLReader = new OKW_XmlReader("xml/OKW_Memorize.xml");          
             }
             catch(Exception e)
             {
                 Log.LogPrintDebug(e.getMessage());
             }
             finally
             {
                 Log.LogFunctionEndDebug();
             }
         }

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

◆ reset()

static void okw.OKW_Memorize_Sngltn.reset ( )

static

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.

Autor: Zoltan Hrabovszki

Datum: 2013.11.25

Definiert in Zeile 228 der Datei OKW_Memorize_Sngltn.java.

     {
         Instance = null;
         getInstance();
     }

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

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

◆ save()

void okw.OKW_Memorize_Sngltn.save ( )

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

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 421 der Datei OKW_Memorize_Sngltn.java.

     {
         Log.LogFunctionStartDebug( Instance.getClass().getName() + ".save");
  
         try
         {
             // Hint: The Name of Property with the Path nad Filename of the Properties-file
             // to be loaded is "OKW_Memorize.properties"
             Properties.getProperty( "OKW_Memorize.properties", "OKW_Memorize.properties" );
             
         }
         finally
         {
             Log.LogFunctionEndDebug();
         }
     }

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

◆ set()

void okw.OKW_Memorize_Sngltn.set	(	String	fpsKey,
		String	fpsValue
	)		throws XPathExpressionException

Setzt/Merkt sich das MemKey/Value-Paar.

Parameter

fpsKey	MemKey - Schlüssel für den Zugriff auf den Wert.
fpsValue	Wert, der gemerkt werden soll.

Ausnahmebehandlung

XPathExpressionException

Autor: Zoltán Hrabovszki

Datum: 2014.12.27

Definiert in Zeile 452 der Datei OKW_Memorize_Sngltn.java.

     {
         Log.LogFunctionStartDebug(Instance.getClass().getName() + ".Set", "String fpsKey", fpsKey,
                 "String fpsValue", fpsValue);
  
         try
         {
             // Are we overwriting an existing MemKey?
             if (Value.containsKey(fpsKey))
             {
                 String lvsOverwriteKey = LM.GetMessage("Set", "OverwriteKey", fpsKey);
                 String lvsOldValue = LM.GetMessage("Set", "OldValue", Value.get(fpsKey));
                 String lvsNewValue = LM.GetMessage("Set", "NewValue", fpsValue);
                 
                 if (!lvsOldValue.equals( lvsNewValue ))
                 {
                     Log.ResOpenList(lvsOverwriteKey);
                     Log.LogPrint(lvsOldValue);
                     Log.LogPrint(lvsNewValue);
                     Log.ResCloseList();
                 }
                 Instance.Value.put(fpsKey, fpsValue);
             }
             else
             {
                 Instance.Value.put(fpsKey, fpsValue);
  
                 Log.ResOpenList(LM.GetMessage("Set", "SetValue", fpsKey, fpsValue));
                 String lvsMessage = LM.GetMessage("Set", "SetKeyAndValue", fpsKey, fpsValue);
                 Log.LogPrint( lvsMessage);
                 Log.ResCloseList();
             }
  
             // persistentes Speichern aller Daten...
             // TODO: Prüfen: das wurde ebntfern. Frage soll hier eine Persisntes eingebaut werden?
             // Instance.save();
         }
         finally
         {
             Log.LogFunctionEndDebug();
         }
     }

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

Dokumentation der Datenelemente

◆ Instance

OKW_Memorize_Sngltn okw.OKW_Memorize_Sngltn.Instance

staticprotected

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.

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 129 der Datei OKW_Memorize_Sngltn.java.

◆ LM

LogMessenger okw.OKW_Memorize_Sngltn.LM = null

protected

Eine lokale Instanz des OKW.Log.LogMssenger.

Autor: Zoltán Hrabovszki

Datum: 2014.12.28

Definiert in Zeile 140 der Datei OKW_Memorize_Sngltn.java.

◆ Log

Logger_Sngltn okw.OKW_Memorize_Sngltn.Log = Logger_Sngltn.getInstance()

protected

Referenz auf die einzige Instanz des Klasse OKW.Logger.

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 150 der Datei OKW_Memorize_Sngltn.java.

◆ OKW_Memorize_xml

String okw.OKW_Memorize_Sngltn.OKW_Memorize_xml = ""

Variable hält Pfad und Dateinamen der OKW_Memorize.xml.

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 83 der Datei OKW_Memorize_Sngltn.java.

◆ Value

Map<String, String> okw.OKW_Memorize_Sngltn.Value = new HashMap<String, String>()

protected

Dictionary speichert die Schlüssel-Wert Paare.

Die Hier gespeicherten werte sind nicht persistent.

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 96 der Datei OKW_Memorize_Sngltn.java.

◆ ValuePersistent

Map<String, String> okw.OKW_Memorize_Sngltn.ValuePersistent = new HashMap<String, String>()

protected

Dictionary speichert Schlüssel-Wert Paare.

Die Hier gespeicherten werte sind persistent. Die Werte werden aus/in die Datei gespeichert der Datei

Autor: Zoltán Hrabovszki

Datum: 2019.11.25

Definiert in Zeile 111 der Datei OKW_Memorize_Sngltn.java.

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

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

Öffentliche Methoden

Öffentliche, statische Methoden

Öffentliche Attribute

Geschützte Attribute

Statische, geschützte Attribute

Private Methoden

Ausführliche Beschreibung

Beschreibung der Konstruktoren und Destruktoren

◆ OKW_Memorize_Sngltn()

Dokumentation der Elementfunktionen

◆ exists()

◆ get()

◆ getInstance()

◆ init()

◆ load()

◆ reset()

◆ save()

◆ set()

Dokumentation der Datenelemente

◆ Instance

◆ LM

◆ Log

◆ OKW_Memorize_xml

◆ Value

◆ ValuePersistent