okw.core

Class OKW_CurrentObject_Sngltn

java.lang.Object

okw.core.OKW_CurrentObject_Sngltn

public class OKW_CurrentObject_Sngltn
extends Object

\~german Diese Klasse verwaltet das aktuelle GUI-Objekt. Jedes technische GUI-Objekt, wobei es unerheblich ist, wie tief diese technisch ineinander verschachtelt sind, wird mit maximal zwei Angaben referenziert: **Fenstername** und **Kindobjektname** __Design-Pattern:__ Singleton - Highlander-Prinzip \~english This class administrates the actual GUI-Object. Each technical GUI-Object, irrelevant how deep they are nested into each other technically, will be referenced with two informations: **WindowName** und **ChildObjectName** __Design-Pattern:__ Singleton - Highlander-Principle \~ \author Zoltan Hrabovszki \date 2012.11.01

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	cvsChildFN \~german \brief Die Eigenschaft enthält den fachlichen Namen des aktuellen Kindobjektes.
protected static String	cvsWindowFN \~german \brief Eigenschaft enthält den fachlichen Namen des aktuellen Fensters.

Method Summary

Modifier and Type	Method and Description
ArrayList<String>	getAllChildFNsOfParent(String FN)
String	getChildFN() \~german Ermittelt den FN des des aktuellen Kind-Objektes.
Object	getCurrentObject() \~german Liefert die Referenz zum aktuellen Frame-Object.
static OKW_CurrentObject_Sngltn	getInstance()
String	getObjectFN() \~german Ermittelt den ObjektNamen des aktuellen Objektes.
String	getWindowFN() \~german Ermittelt den FN des des aktuellen Fenster-Objektes.
static void	init() \~german Führt die Initialisierung der Klasse durch: Es werden alle Felder der Klasse auf einen definierten Anfangszustand zurükgesetzt; \~english Running the initializing of the class: There are all fields of the class set to a defined initial state.
void	LogObjectData() \~german Methode gibt alle wichtigen Informationen zum aktuellen Objekt aus.
Object	resetToWindow() \~german Das aktuelle Objekt wird auf das Fenster zurückgesetzt.
void	Sequence(String FN, String fpsMethodName, String fpsParameter_1)
Object	setChildName(String fpsChildName) \~german Setzt das Kindobjekt.
Object	setWindowName(String fpsWindowName) \~german Hier wird der Kontext auf ein Fenster gesetzt.

Methods inherited from class java.lang.Object

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

Field Detail

cvsChildFN

protected static String cvsChildFN

\~german \brief Die Eigenschaft enthält den fachlichen Namen des aktuellen Kindobjektes. Auf dieses Kindobjekt beziehen sich alle GUI Kind-Objekte, die unter 'sNameChildObject' gegeben sind. \todo TODO: ZH: Weitergehende Beschreibung Prüfen. \~english \brief The feature contains the professional name of the current child Object. All GUI child Objects are relating to this ChildObject, given under 'sNameChildObject'.

cvsWindowFN

protected static String cvsWindowFN

\~german \brief Eigenschaft enthält den fachlichen Namen des aktuellen Fensters. Auf dieses Fenster beziehen sich alle GUI Kind-Objekte, die mit "cvsChildName" gegeben sind. \~english \brief The feature contains the professional name of the current window.
All GUI child Objects are relating to this window given mit "cvsChildName".

Method Detail

getInstance

public static OKW_CurrentObject_Sngltn getInstance()
                                            throws XPathExpressionException,
                                                   JAXBException,
                                                   ParserConfigurationException,
                                                   SAXException,
                                                   IOException

Throws:

XPathExpressionException

JAXBException

ParserConfigurationException

SAXException

IOException

getAllChildFNsOfParent

public ArrayList<String> getAllChildFNsOfParent(String FN)

getCurrentObject

public Object getCurrentObject()

\~german Liefert die Referenz zum aktuellen Frame-Object. Referenz ist im Feld cvoObject abgelegt.

Returns:

Die Referenz auf das auf das aktuelle GUI-Object. \~english Returns the reference to the current Frame-Object. Reference is stored in the field cvoObject.

getObjectFN

public String getObjectFN()

\~german Ermittelt den ObjektNamen des aktuellen Objektes.

Returns:

Liefert den Objektnamen in der Form "WindowName.ChildName" oder "WindowName". \~english Detecting the ObejctName of the current Object

getWindowFN

public String getWindowFN()

\~german Ermittelt den FN des des aktuellen Fenster-Objektes.

Returns:

Liefert den Objektnamen in der Form "WindowName" oder "WindowName". \~english Detecting the ObejctName of the current Object

getChildFN

public String getChildFN()

\~german Ermittelt den FN des des aktuellen Kind-Objektes.

Returns:

Liefert den Objektnamen in der Form "ChildName". \~english

init

public static void init()
                 throws XPathExpressionException,
                        JAXBException,
                        ParserConfigurationException,
                        SAXException,
                        IOException

\~german Führt die Initialisierung der Klasse durch: Es werden alle Felder der Klasse auf einen definierten Anfangszustand zurükgesetzt; \~english Running the initializing of the class: There are all fields of the class set to a defined initial state. \~

Throws:

XPathExpressionException

JAXBException

ParserConfigurationException

SAXException

IOException

LogObjectData

public void LogObjectData()

\~german Methode gibt alle wichtigen Informationen zum aktuellen Objekt aus. Diese soll im Fehler- oder Ausnahmefall bei der Fehlersuche durch Ausgabe der aktuellen Objektdaten helfen.
Diese Daten werden ausgegeben: * Window Name: cvsWindowName * Name des Kindes: cvsChildName * Objektklasse: cvoObject.getClass().Name * Voller Name des Objektes: cvsObjectName \note Methode wird während der Ausnahmebehandlung aufgerufen. \~english Method returns all the important information about the current Object. This should help in error or exception when debugging by outputting the current data Object. These data will be returned: * Window Name: cvsWindowName * Name of Child: cvsChildName * Class of Object: cvoObject.getClass().Name * Fullname of Object: cvsObjectName \note Method is called during exception handling. \~

resetToWindow

public Object resetToWindow()
                     throws XPathExpressionException,
                            IllegalArgumentException,
                            IllegalAccessException

\~german Das aktuelle Objekt wird auf das Fenster zurückgesetzt. Kindobjekt wird gelöscht.

Returns:

Liefert die Objektreferenz des Fensters zurück. \~english The current Object will be set back to the window. Child Object will be deleted.

Throws:

IllegalAccessException

IllegalArgumentException

XPathExpressionException

setChildName

public Object setChildName(String fpsChildName)
                    throws XPathExpressionException,
                           IllegalArgumentException,
                           IllegalAccessException

\~german Setzt das Kindobjekt.

Parameters:

fpsChildName - Fachlicher Name des Kind-Objektes. \note Wichtig! Das Fenster-Objekt muss bereits gesetzt sein!
Ist dies nicht der Fall, wird eine OKW.OKWFrameObjectWindowNotSetException Exception ausgelöst \~english Setting the Child Object.

fpsChildName - Funktional name of the Child Object.

Returns:

Liefert die Objektreferenz auf das aktuelle Objekt cvoObject aus dem Rückgabewert.

Throws:

IllegalAccessException

IllegalArgumentException

XPathExpressionException

setWindowName

public Object setWindowName(String fpsWindowName)
                     throws XPathExpressionException,
                            IllegalArgumentException,
                            IllegalAccessException

\~german Hier wird der Kontext auf ein Fenster gesetzt. * Der Bezeichner des letzten Kindobjektes wird gelöscht. * Frame-Klasse mit "fpsWindowName" wird ggf. instanziert oder aus dem

Parameters:

fpsWindowName - Name des Fenster, welches den Kontext erhält.

fpsWindowName - Name of the window, which contains the context.

Returns:

Liefert die Objektreferenz, auf das hier gesetzte Fenster zurück. \~english Here the context is set to a window. * The identifier of the last child Object is deleted. * Frame class with "fpsWindowName" will be instantiate optionally or from the

Throws:

IllegalAccessException

IllegalArgumentException

XPathExpressionException

Sequence

public void Sequence(String FN,
                     String fpsMethodName,
                     String fpsParameter_1)
              throws Exception

Throws:

Exception