Verwaltet zentral die Frame-Klassen: Instanziert Frame-Klassen zu Frame-Objekten und liefert die Referenzen auf diese zurück. Mehr ...

Zusammengehörigkeiten von okw.FrameObjectDictionary_Sngltn:

Öffentliche Methoden
Object	getParentObjectByName (String FNParentObject) throws XPathExpressionException
	Die Methode liefert das Frame-Object des gegebenen FN eines Fensterobjektes zurück. Mehr ...

ArrayList< String >	getAllChildKeysOfParent (String FN_Parent)
	Methode Ermittelt alle FN´s der Kinder des gegebene Fensters (Parent). Mehr ...

Object	getChildObjectByName (String fps_ParentObject, String fps_ChildObject) throws XPathExpressionException, IllegalArgumentException, IllegalAccessException
	Die Methode liefert das Objekt des gegebenen Kindobjekttests zurück. Mehr ...

void	printObjectDictionary ()

OKW	getOKW (String fpKN)
	Holt für einen GUI-Object die angehängte Annotation. Mehr ...

Öffentliche, statische Methoden
static FrameObjectDictionary_Sngltn	getInstance () throws XPathExpressionException, JAXBException, ParserConfigurationException, SAXException, IOException

static void	init () throws ClassNotFoundException, InstantiationException, JAXBException, ParserConfigurationException, SAXException, IOException, XPathExpressionException, IllegalArgumentException, IllegalAccessException
	Methode initialisiert diese Klasse. Mehr ...

static ArrayList< Class<?> >	getListOfOKWGuiClasses () throws ClassNotFoundException, IOException, XPathExpressionException
	Methode erstellt eine Liste aller OKWGUI-Rahmenklassen (Frame class), die in der aktuell ausgeführten Assambly definiert sind. Mehr ...

Statische öffentliche Attribute
static Map< String, Object >	myFrameObjectDictionary = new HashMap<String, Object>()

static Map< String, OKW >	myAnnotationDictionary = new HashMap<String, OKW>()

Private Methoden
	FrameObjectDictionary_Sngltn ()
	Konstuktor der Klasse. Mehr ...

Object	createInstanceByObjectName (String fps_ParentObject, String fps_ChildObject) throws XPathExpressionException

Object	getChildObjectByName (Object fpo_ParentObject, String fps_ChildName) throws XPathExpressionException
	Holt sich einen öffentlichen Feld Wert über den Namen. Mehr ...

Private, statische Methoden
static void	frameScan () throws InstantiationException, XPathExpressionException, IllegalArgumentException, IllegalAccessException, ClassNotFoundException, IOException
	Liefert die Instanz der Klasse. Mehr ...

static void	frameScanFieldsRecursively (Field fpParentField, Object fpParentFieldInstance, String fpsWindowName)

static OKW	getOKWFromObjekt (Object fpObject)
	Holt die Referenz auf die Annotation des gegebenen Objektes. Mehr ...

Statische, private Attribute
static Logger_Sngltn	Log = Logger_Sngltn.getInstance()
	Zentrale Logger-Klasse stellt Logger-Methoden innerhalb von OKW zur Verfügung. Mehr ...

static LogMessenger	LM
	LogMessenger liest Log-Meldungen sprachspezifisch für die im Konstruktor gegeben Klasse aus der Zugehörigen XML-Datei.

static FrameObjectDictionary_Sngltn	Instance = null

Ausführliche Beschreibung

Verwaltet zentral die Frame-Klassen: Instanziert Frame-Klassen zu Frame-Objekten und liefert die Referenzen auf diese zurück.

Noch zu erledigen:: TODO: ZH Dokumentaion erweitern.

Autor: Zoltan Hrabovszki

Datum: 2014-10-10

Definiert in Zeile 73 der Datei FrameObjectDictionary_Sngltn.java.

Beschreibung der Konstruktoren und Destruktoren

◆ FrameObjectDictionary_Sngltn()

okw.FrameObjectDictionary_Sngltn.FrameObjectDictionary_Sngltn ( )

private

Konstuktor der Klasse.

Es wird die Methode aufgerufen.

Autor: Zoltan Hrabovszki

Datum: 2014.10.10

Definiert in Zeile 126 der Datei FrameObjectDictionary_Sngltn.java.

127 {

128 }

Dokumentation der Elementfunktionen

◆ frameScan()

static void okw.FrameObjectDictionary_Sngltn.frameScan ( ) throws InstantiationException, XPathExpressionException, IllegalArgumentException, IllegalAccessException, ClassNotFoundException, IOException

staticprivate

Liefert die Instanz der Klasse.

Parameter

fps_ParentClassName Name der Klasse

Autor: Zoltan Hrabovszki

Ausnahmebehandlung

IOException

Datum: 2015.01.28

Noch zu erledigen:: TODO: rename lvsFNParent to lvsFNWindow (Parent is not correct in all cases)

Definiert in Zeile 473 der Datei FrameObjectDictionary_Sngltn.java.

   {
     Object lvTypeInstanceAsObject = null;
  
     Log.ResOpenList( "List of Frames..." );
     
     try
     {
       // Alle Fenster Klassen, die eine Annotation ermitteln...
       ArrayList<Class<?>> lvOKWGuiClasses = getListOfOKWGuiClasses();
  
       // Für jede Klasse in der Liste...
       for ( Class<?> lvOKWGuiClass : lvOKWGuiClasses )
       {
         // Erzeuge eine Instanz der Window-Klasse
         lvTypeInstanceAsObject = OKW_GetJavaClass.createInstanceByType( lvOKWGuiClass );
  
         // FN (Fachlichen Namen) der Klasse aus der die Annotiation OKW.FN() auslesen.
         // Hierbei handelt es sich um des  ParentObject = Fenster
         OKW lvOKWWindow = getOKWFromObjekt( lvTypeInstanceAsObject );
         String lvsFNWindow = lvOKWWindow.FN();
         
         // Wenn Attribute vorhanden (!=null) und nicht Leer (!= "") dann ins Dictionary einfügen.
         if ( lvsFNWindow != null && !lvsFNWindow.isEmpty() )
         {
           Log.ResOpenList( "Parent: '" + lvsFNWindow + "'" );
           Log.LogPrint( "Type: '" + lvTypeInstanceAsObject.getClass().getName() + "'" );
  
           ((IOKW_FN)lvTypeInstanceAsObject).setFN( lvsFNWindow );
           ((IOKW_FN)lvTypeInstanceAsObject).setKN( lvsFNWindow );
           
           myFrameObjectDictionary.put( lvsFNWindow, lvTypeInstanceAsObject );
           myAnnotationDictionary.put( lvsFNWindow, lvOKWWindow );
  
           Log.LogPrintDebug( LM.GetMessage( "CreateInstanceByObjectName", "InstanceWasCreated", lvTypeInstanceAsObject.getClass().getName() ) );
  
           // Rekursive alle Felder (Fields) der Frame-Klasse durchsuchen...
           // und einlesen, wenn diese eine Annotaion besitzen.
           Field[] lvFields = lvTypeInstanceAsObject.getClass().getFields();
  
           for ( Field lvField : lvFields )
           {
  
             String myFieldType   = lvField.getType().getName();
             
             // Die Instance des Feldes holen...
             Object lvFieldInstance = lvField.get( lvTypeInstanceAsObject );
               
             if ( lvField.isAnnotationPresent( OKW.class ) )
             {
                 OKW myFN = lvField.getAnnotation( OKW.class );
                 // Get the value from property.
  
                 String lvsFNChild  = myFN.FN();
                 String lvsChildKey = lvsFNWindow + "." + lvsFNChild;
  
                 Log.ResOpenList( "Child: '" + lvsFNChild + "'" );
                 Log.LogPrint( "  Key: '" + lvsChildKey + "'" );
                 Log.LogPrint( " Type: '" + myFieldType + "'" );
  
                 // Add child-object to the dictionary
                 myAnnotationDictionary.put( lvsChildKey, myFN );
                 
                 try
                 {
                      // Now here we tell the GUI-Adapter his FN and his Parent-FN...
                    (( IOKW_FN ) lvFieldInstance).setKN( lvsChildKey );
                    (( IOKW_FN ) lvFieldInstance).setFN( lvsFNChild );
                    (( IOKW_FN ) lvFieldInstance).setParentFN( lvsFNWindow );
                    myFrameObjectDictionary.put( lvsChildKey, lvFieldInstance );
                    
                    frameScanFieldsRecursively( lvField, lvFieldInstance, lvsFNWindow );
                 }
                 catch (java.lang.ClassCastException e)
                 {
                    System.out.print("Uuupps! There is a ClassCastException... ");
                 }
                 finally
                 {
                     Log.ResCloseList(); // Close Child  
                 }
               }
               else
               {
                 Log.LogPrint( "-GUI-Container-" );              
                 frameScanFieldsRecursively( lvField, lvFieldInstance, lvsFNWindow );
               }
           }
         }
         Log.ResCloseList();
       }
     }
     finally
     {
       Log.ResCloseList();
     }
   }

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

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

◆ getAllChildKeysOfParent()

ArrayList<String> okw.FrameObjectDictionary_Sngltn.getAllChildKeysOfParent ( String FN_Parent )

Methode Ermittelt alle FN´s der Kinder des gegebene Fensters (Parent).

Hinweis: Methode filtert alle FNs aus myFarmeObjectDictionary heraus, die mit FN_Parent Anfangen.
D.h. Es kann auch auch die Kinder eines Radiolist ermitteln. Siehe auch SeRadioList.

Parameter

FN_Parent Funktionaler Name des Fenster welches Durchsucht werden soll.

Rückgabe: Liste der gefunden Child-Keys´s,

Autor: Zoltan Hrabovszki

Datum: 2016.11.18

Definiert in Zeile 250 der Datei FrameObjectDictionary_Sngltn.java.

   {
     ArrayList<String> lvAlReturn = new ArrayList<String>();
     
     Set<String> lvKeys = myFrameObjectDictionary.keySet();
     
     for ( Object lvoKey : lvKeys )
     {
       String lvsKey = (String)lvoKey;
       
       if (lvsKey.startsWith( FN_Parent ) )
       {
           lvAlReturn.add( lvsKey );
       }
     }    
     return lvAlReturn;
   }

◆ getChildObjectByName() [1/2]

Object okw.FrameObjectDictionary_Sngltn.getChildObjectByName	(	Object	fpo_ParentObject,
		String	fps_ChildName
	)		throws XPathExpressionException

private

Holt sich einen öffentlichen Feld Wert über den Namen.

Parameter

fpo_ParentObject	Frame des Fensters als Objekt.
fps_ChildName	Fachlicher Name des Kindobjektes, welches als Objekt zurückgegeben werden soll.

Rückgabe: Eigenschaftswert

Autor: Zoltan Hrabovszki

Datum: 2014-10-10

Ausnahmebehandlung

XPathExpressionException

Definiert in Zeile 755 der Datei FrameObjectDictionary_Sngltn.java.

   {
     Object lvo_Return = null;
  
     Log.LogFunctionStartDebug( "FrameObjectDictionary.GetChildObjectByName", "fpo_ParentObject", fpo_ParentObject.toString(), "fps_ChildName", fps_ChildName );
  
     try
     {
       Field fieldInfoObj = fpo_ParentObject.getClass().getField( fps_ChildName );
  
       // Existiert es das Kindobjekt >>{0:}<< im Objekt >>{1:}<<?
       Log.LogPrintDebug( LM.GetMessage( "GetChildObjectByName", "M1", fps_ChildName, fpo_ParentObject.getClass().getName() ) );
  
       // Ja, das Objekt existiert.
       Log.LogPrintDebug( LM.GetMessage( "GetChildObjectByName", "M2" ) );
  
       // Get the value from property.
       lvo_Return = fieldInfoObj;
     }
     catch (SecurityException e)
     {
       // \todo TODO: In Sprachabhängige datei Auslagern!
       Log.LogPrintDebug( "Frame Object must be declarec as Public!" );
       throw e;
     }
     catch (NoSuchFieldException e)
     {
       // Nein -> Exception auslösen und alles beenden!
       Log.LogPrintDebug( LM.GetMessage( "GetChildObjectByName", "M3" ) );
  
       throw new OKWFrameObjectChildNotFoundException( LM.GetMessage( "GetChildObjectByName", "ChildIsNotDefined_Exception", fps_ChildName, fpo_ParentObject
               .getClass().getName() ) );
     }
     finally
     {
       Log.LogFunctionEndDebug();
     }
  
     return lvo_Return;
   }

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

◆ getChildObjectByName() [2/2]

Object okw.FrameObjectDictionary_Sngltn.getChildObjectByName	(	String	fps_ParentObject,
		String	fps_ChildObject
	)		throws XPathExpressionException, IllegalArgumentException, IllegalAccessException

Die Methode liefert das Objekt des gegebenen Kindobjekttests zurück.

Siehe auch: Für das Fensterobjekt existiert eine zweite Ausprägung dieser Methode. FrameObjectDictionary.GetObjectByName(String,String)

Parameter

fps_ParentObject	Name des Fenster-Objektes = Elternobjekt.
fps_ChildObject	Name des Kindobjektes-Objektes.

Rückgabe: Frame-Objekt-Referenz auf das Kindobjekt.

Autor: Zoltan Hrabovszki

Datum: 2014.10.10

Noch zu erledigen:: TODO:

Ausnahmebehandlung

IllegalAccessException
IllegalArgumentException

Definiert in Zeile 298 der Datei FrameObjectDictionary_Sngltn.java.

   {
     Object lvo_Return = null;
     String lvs_ObjectName = fps_ParentObject + "." + fps_ChildObject;
  
     Log.LogFunctionStartDebug( "FrameObjectDictionary.GetChildObjectByName", "fps_ParentObject", fps_ParentObject, "fps_ChildObject", fps_ChildObject );
  
     // Gibt es den Schlüssel im Dictinary?
     Log.LogPrintDebug( LM.GetMessage( "GetChildObjectByName", "M1", fps_ChildObject, fps_ParentObject ) );
     try
     {
       if ( myFrameObjectDictionary.containsKey( lvs_ObjectName ) )
       {
         // Ja, das Objekt existiert.
         Log.LogPrintDebug( LM.GetMessage( "GetChildObjectByName", "M2" ) );
         
         // Hole die Referenz auf das Objekt aus dem Dictionary 
         lvo_Return = myFrameObjectDictionary.get( lvs_ObjectName );
         // lvo_Return = myField.get( this.GetParentObjectByName( fps_ParentObject ) );
       }
       else
       {
         // Nein -> Frame zum Funtionalen Name wurde nicht gefunden ->
         // Exception OKWFrameObjectChildNotFoundException auslösen...
         // \todo TODO: Fehlermeldung einbauen...
         Log.LogPrintDebug( LM.GetMessage( "GetChildObjectByName", "M3" ) );
  
         String lvsMessage = LM.GetMessage( "GetChildObjectByName", "OKWFrameObjectChildNotFoundException", lvs_ObjectName );
         throw new OKWFrameObjectChildNotFoundException( lvsMessage );
       }
     }
     finally
     {
       if ( lvo_Return == null )
       {
         Log.LogFunctionEndDebug();
       }
       else
       {
         Log.LogFunctionEndDebug( lvo_Return.toString() );
       }
     }
     return lvo_Return;
   }

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

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

◆ getListOfOKWGuiClasses()

static ArrayList<Class<?> > okw.FrameObjectDictionary_Sngltn.getListOfOKWGuiClasses ( ) throws ClassNotFoundException, IOException, XPathExpressionException

static

Methode erstellt eine Liste aller OKWGUI-Rahmenklassen (Frame class), die in der aktuell ausgeführten Assambly definiert sind.

Zu beachten

WICHTIG: Es werden Klassen in die Liste aufgenommen, die

dem Namepsace OKW.Frames zugeordent sind
und mit dem Annotiation OKWGUIAttribute "geschmückt" ist.

Rückgabe: Liefert die Liste der Klasse, die der Namespace OKW.Frames und mit dem Attribute OKWGUI vershen sind.

Autor: Zoltan Hrabovszki

Datum: 2014.10.10

Ausnahmebehandlung

XPathExpressionException

Definiert in Zeile 424 der Datei FrameObjectDictionary_Sngltn.java.

   {
     String lvsNamespace = "okw.gui.frames";
     ArrayList<Class<?>> lvALReturn = new ArrayList<Class<?>>();
  
     ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
  
     // 1. Hole alle Klassen, die sich im Package "okw.gui.frames" befinden
     ArrayList<String> lvALClassNames = OKW_GetJavaClass.getClasses( lvsNamespace );
  
     try
     {
       // 2. Hole alle Klassen, die Annotation "OKW_FN" haben.
       for ( String lvsClass : lvALClassNames )
       {
         Class<?> aClass = classLoader.loadClass( lvsClass );
  
         // Wenn die Klasse die Annotaion OKW_FN hat, dann in die
         // Rückgabe-Liste eintrage
         if ( aClass.isAnnotationPresent( OKW.class ) )
         {
           lvALReturn.add( aClass );
         }
       }
     }
     catch (ClassNotFoundException e)
     {
       e.printStackTrace();
     }
  
     return lvALReturn;
   }

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

◆ getOKW()

OKW okw.FrameObjectDictionary_Sngltn.getOKW ( String fpKN )

Holt für einen GUI-Object die angehängte Annotation.

Parameter

fpKN	Frame Objekt Schlüssel "FensterFN" oder "FensterFN.KindObjectFN".

Rückgabe: OKW-Annotation des Objektes.

Autor: Zoltan Hrabovszki

Datum: 2017-02-11

Ausnahmebehandlung

XPathExpressionException

Definiert in Zeile 829 der Datei FrameObjectDictionary_Sngltn.java.

   {  
       OKW Return = null;
       
       if (myAnnotationDictionary.containsKey(fpKN) )
       {
           Return = myAnnotationDictionary.get( fpKN );
       }
       
       return Return;
   }

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

◆ getOKWFromObjekt()

static OKW okw.FrameObjectDictionary_Sngltn.getOKWFromObjekt ( Object fpObject )

staticprivate

Holt die Referenz auf die Annotation des gegebenen Objektes.

Parameter

fpObject

Rückgabe: Refernz auf die OKW-Annotaion des Objectes

Definiert in Zeile 643 der Datei FrameObjectDictionary_Sngltn.java.

   {
     OKW lvsReturn = null;
  
     if ( fpObject.getClass().isAnnotationPresent( OKW.class ) )
     {
       lvsReturn = fpObject.getClass().getAnnotation( OKW.class );
     }
  
     return lvsReturn;
   }

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

◆ getParentObjectByName()

Object okw.FrameObjectDictionary_Sngltn.getParentObjectByName ( String FNParentObject ) throws XPathExpressionException

Die Methode liefert das Frame-Object des gegebenen FN eines Fensterobjektes zurück.

Das Objekt ist bereits erzeugt (instanziert), und liegt im FrameObjectDictionary FrameObjectDictionary_Sngltn.myFrameObjectDictionary.

Wenn das Object nicht im FrameObjectDictionary vorhanden ist, dann wird die Ausnahme OKWFrameObjectParentNotFoundException ausgelöst.

Siehe auch: Für das Kindobjekt existiert eine zweite Ausprägung dieser Methode: FrameObjectDictionary.GetObjectByName(String,String)

Parameter

fpsParentObject FN des Fenster Objektes = Elternobjekt.

Rückgabe: Rückgabe des instantierten Fenster-Objektes.

Autor: Zoltan Hrabovszki

Datum: 2014.10.10

Definiert in Zeile 195 der Datei FrameObjectDictionary_Sngltn.java.

   {
     Object lvo_Return = null;
  
     Log.LogFunctionStartDebug( "FrameObjectDictionary.GetParentObjectByName", "FNParentObject", FNParentObject );
     try
     {
       // Gibt es den Schlüssel im Dictinary? - D.h. Gibt es schon eine
       // Instanz des Objektes im Speicher?
       Log.LogPrintDebug( LM.GetMessage( "GetParentObjectByName", "M1", FNParentObject ) );
       if ( myFrameObjectDictionary.containsKey( FNParentObject ) )
       {
         // Ja, das Objekt existiert.
         Log.LogPrintDebug( LM.GetMessage( "GetParentObjectByName", "M2" ) );
         lvo_Return = myFrameObjectDictionary.get( FNParentObject );
       }
       else
       {
         // Nein -> Frame zum Funtionalen NAme wurde nicht gefunden ->
         // Exception auslösen...
         // \todo TODO: Fehlermeldung einbauen...
         Log.LogPrintDebug( LM.GetMessage( "GetParentObjectByName", "M3" ) );
  
         String lvsMessage = LM.GetMessage( "GetParentObjectByName", "OKWFrameObjectParentNotFoundException", FNParentObject );
         throw new OKWFrameObjectParentNotFoundException( lvsMessage );
       }
     }
     finally
     {
       if ( lvo_Return != null )
       {
         Log.LogFunctionEndDebug( lvo_Return.toString() );
       }
       else
       {
         Log.LogFunctionEndDebug();
       }
     }
  
     return lvo_Return;
   }

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

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

◆ init()

static void okw.FrameObjectDictionary_Sngltn.init ( ) throws ClassNotFoundException, InstantiationException, JAXBException, ParserConfigurationException, SAXException, IOException, XPathExpressionException, IllegalArgumentException, IllegalAccessException

static

Methode initialisiert diese Klasse.

Es wird - LogMessender-Instanz erzeugt. - das FrameObjektDictionary wird gelöscht. - Es werden die Frame-Objekte geladen (instanziert)

Autor: Zoltan Hrabovszki

Datum: 2014.10.10

Definiert in Zeile 357 der Datei FrameObjectDictionary_Sngltn.java.

   {
     Log.LogFunctionStartDebug( "FrameObjectDictionary.Init" );
  
     try
     {
       LM = new LogMessenger( "FrameObjectDictionary" );
  
       Log.LogPrintDebug( LM.GetMessage( "Init", "InitClear", "FrameObjectDictionary" ) );
  
       myFrameObjectDictionary.clear();
  
       frameScan( );
  
       Set<String> Keys = myFrameObjectDictionary.keySet();
  
       ArrayList<String> myList = new ArrayList<String>();
  
       for ( String Key : Keys )
       {
         myList.add( Key );
       }
  
       Collections.sort( myList );
  
       Log.ResOpenListDebug( "Frames: " );
  
       for ( String Element : myList )
       {
         Log.LogPrintDebug( Element );
       }
  
       Log.ResCloseListDebug();
  
     }
     finally
     {
       Log.LogFunctionEndDebug();
     }
   }

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

Dokumentation der Datenelemente

◆ Log

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

staticprivate

Zentrale Logger-Klasse stellt Logger-Methoden innerhalb von OKW zur Verfügung.

Definiert in Zeile 103 der Datei FrameObjectDictionary_Sngltn.java.

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

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

Öffentliche Methoden

Öffentliche, statische Methoden

Statische öffentliche Attribute

Private Methoden

Private, statische Methoden

Statische, private Attribute

Ausführliche Beschreibung

Beschreibung der Konstruktoren und Destruktoren

◆ FrameObjectDictionary_Sngltn()

Dokumentation der Elementfunktionen

◆ frameScan()

◆ getAllChildKeysOfParent()

◆ getChildObjectByName() [1/2]

◆ getChildObjectByName() [2/2]

◆ getListOfOKWGuiClasses()

◆ getOKW()

◆ getOKWFromObjekt()

◆ getParentObjectByName()

◆ init()

Dokumentation der Datenelemente

◆ Log