OKW_CurrentObject_Sngltn.java

/*
    ==============================================================================
    Copyright © 2012 - 2019 IT-Beratung Hrabovszki
    ============================================================================== 
 
    This file is part of OpenKeyWord.
 
    OpenKeyWord is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenKeyWord is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenKeyWord.  If not, see <http://www.gnu.org/licenses/>.
 
    Diese Datei ist Teil von OpenKeyWord.
 
    OpenKeyWord ist Freie Software: Sie können es unter den Bedingungen
    der GNU General Public License, wie von der Free Software Foundation,
    Version 3 der Lizenz oder (nach Ihrer Wahl) jeder späteren
    veröffentlichten Version, weiterverbreiten und/oder modifizieren.
 
    OpenKeyWord wird in der Hoffnung, dass es nützlich sein wird, aber
    OHNE JEDE GEWÄHRLEISTUNG, bereitgestellt; sogar ohne die implizite
    Gewährleistung der MARKTFÄHIGKEIT oder EIGNUNG FÜR EINEN BESTIMMTEN ZWECK.
    Siehe die GNU General Public License für weitere Details.
 
    Sie sollten eine Kopie der GNU General Public License zusammen mit 
    OpenKeyWord erhalten haben. Wenn nicht, siehe <http://www.gnu.org/licenses/>.
*/
 
package okw.core;
 
import java.io.IOException;
import java.lang.reflect.Method;
import java.util.ArrayList;
 
import javax.xml.bind.JAXBException;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.xpath.XPathExpressionException;
 
import org.xml.sax.SAXException;
 
import okw.FrameObjectDictionary_Sngltn;
import okw.LogMessenger;
import okw.OKW_Helper;
import okw.exceptions.*;
import okw.log.*;
 
public class OKW_CurrentObject_Sngltn
{
 
    protected static String             cvsChildFN              = "";
 
    protected static String             cvsWindowFN             = "";
 
    private static Object               cvoObject               = null;
 
    private static String               cvsFullObjectFN         = "";
 
    private static String               cvsObjectName           = "";
 
    private static LogMessenger         LM                      = null;
 
    private Logger_Sngltn               Log                     = Logger_Sngltn.getInstance();
 
    private static FrameObjectDictionary_Sngltn myFrameObjectDictionary = null;
 
    private static OKW_CurrentObject_Sngltn Instance;
 
    private OKW_CurrentObject_Sngltn()
    {
 
    }
 
    
    public static OKW_CurrentObject_Sngltn getInstance() throws XPathExpressionException, JAXBException, ParserConfigurationException, SAXException, IOException
    {
        // Lazy Initialization (If required then only)
        if ( Instance == null )
        {
            // Thread Safe. Might be costly operation in some case
            synchronized ( OKW_CurrentObject_Sngltn.class )
            {
                if ( Instance == null )
                {
                    Instance = new OKW_CurrentObject_Sngltn();
                    init();
                }
            }
        }
        return Instance;
    }
 
    public ArrayList<String> getAllChildFNsOfParent( String FN )
    {
        return myFrameObjectDictionary.getAllChildKeysOfParent( FN );
    }
 
 
    public Object getCurrentObject()
    {
        Object lvoReturn = new Object();
        
        Log.LogFunctionStartDebug( "CurrentObject.GetCurrentObject" );
 
        lvoReturn = cvoObject;
        
        Log.LogFunctionEndDebug( cvoObject.getClass().getName() );
        return lvoReturn;
    }
 
    public String getObjectFN()
    {
        // Varaibles
        String lvsReturn = null;
        
        // Action
        Log.LogFunctionStartDebug( "CurrentObject.GetObjectName" );
        try
        {
            lvsReturn = cvsFullObjectFN;
        }
        finally
        {
                Log.LogFunctionEndDebug( lvsReturn );
        }
        return lvsReturn;
    }
 
    public String getWindowFN()
    {
        // Variables
        String lvsReturn = null;
        
        // Action
        Log.LogFunctionStartDebug( "CurrentObject.GetWindowFN" );
        try
        {
            lvsReturn = cvsWindowFN;
        }
        finally
        {
            Log.LogFunctionEndDebug( lvsReturn );
        }
        return lvsReturn;
    }
 
    public String getChildFN()
    {
        // Varaibles
        String lvsReturn = null;
        
        //Action
        Log.LogFunctionStartDebug( "CurrentObject.GetChildFN" );
        try
        {
            lvsReturn = cvsChildFN;
        }
        finally
        {
           Log.LogFunctionEndDebug( lvsReturn );
        }
        return lvsReturn;
    }
 
    public static void init() throws XPathExpressionException, JAXBException, ParserConfigurationException, SAXException, IOException
    {
            LM = new LogMessenger( "OKW_CurrentObject" );
            cvoObject = null;
            cvsWindowFN = "";
            cvsChildFN = "";
            cvsObjectName = "";
            myFrameObjectDictionary = null;
            myFrameObjectDictionary = FrameObjectDictionary_Sngltn.getInstance();
    }
 
    public void LogObjectData()
    {
        Log.LogFunctionStartDebug( "CurrentObject.LogObjectData" );
        
        try
        {
            Log.ResOpenList( "Object Data:" );
            Log.LogPrint( LM.GetMessage( "LogObjectData", "WindowName", cvsWindowFN ) );
            Log.LogPrint( LM.GetMessage( "LogObjectData", "ChildWindowName", cvsChildFN ) );
            if (cvoObject == null)
                Log.LogPrint( LM.GetMessage( "LogObjectData", "Class of Object", "null - There is no Frame-Object" ) );
            else
               Log.LogPrint( LM.GetMessage( "LogObjectData", "Class of Object", cvoObject.getClass().getSimpleName() ) );
            Log.LogPrint( LM.GetMessage( "LogObjectData", "FullNameOfObject", cvsObjectName ) );
        }
/*        catch (Exception e)
        {
            Log.LogPrint( e.getMessage() );
        }*/
        finally
        {
            Log.ResCloseList();
        }
        
        Log.LogFunctionEndDebug();
    }
 
    public Object resetToWindow() throws XPathExpressionException, IllegalArgumentException, IllegalAccessException
    {
        Log.LogFunctionStartDebug( "CurrentObject.ResetToWindow" );
        Log.LogPrintDebug( LM.GetMessage( "ResetToWindow", "ResetToWindowDebug" ) );
 
        cvsChildFN = "";
        updateObject();
        
        Log.LogFunctionEndDebug( cvoObject.getClass().getName() );
        return cvoObject;
    }
 
    
    public Object setChildName( String fpsChildName ) throws XPathExpressionException, IllegalArgumentException, IllegalAccessException
    {
        Boolean bOK = false;
        
        Log.LogFunctionStartDebug( "CurrentObject.SetChildName", "String fpsChildName", fpsChildName );
        Log.LogPrintDebug( LM.GetMessage( "SetChildName", "GivenWindownameDebug" ) );
        try
        {
            if ( !OKW_Helper.isStringNullOrEmpty( cvsWindowFN ) )
            {
                if( "SELECTEDCHILD".equals( fpsChildName ) )
                {
                    Log.LogPrint( LM.GetMessage( "SetChildName", "SetChildwindowNameDebug", cvsWindowFN, cvsChildFN ) );                    
                }
                else
                {
                    cvsChildFN = fpsChildName;
                    Log.LogPrintDebug( LM.GetMessage( "SetChildName", "SetChildwindowNameDebug", cvsWindowFN, cvsChildFN ) );
                    updateObject();
                    bOK = true;
                }
            }
            else
            {
                // Fenster Objekt wurde nicht gesetzt, Exception auslösen...
                String ErrorText = LM.GetMessage( "SetChildName", "OKWFrameObjectWindowNotSetException" );
                throw new OKWFrameObjectWindowNotSetException( ErrorText );
            }
        }
        finally
        {
            if ( bOK )
            {
                Log.LogFunctionEndDebug( cvoObject.getClass().getName() );
            }
            else
            {
                Log.LogFunctionEndDebug();
            }
        }
        return cvoObject;
    }
 
 
    public Object setWindowName( String fpsWindowName ) throws XPathExpressionException, IllegalArgumentException, IllegalAccessException
    {
        Object lvoReturn = new Object();
        Boolean bOK = false;
        Log.LogFunctionStartDebug( "CurrentObject.SetWindowName", "String fpsWindowName", fpsWindowName );
        try
        {
            cvsWindowFN = fpsWindowName;
            cvsChildFN = "";
            updateObject();
            lvoReturn = cvoObject;
            bOK = true;
        }
        finally
        {
            if ( bOK )
            {
                Log.LogFunctionEndDebug( lvoReturn.toString() );
            }
            else
            {
                Log.LogFunctionEndDebug( );
            }
        }
        return lvoReturn;
    }
    
    private void updateObject() throws XPathExpressionException, IllegalArgumentException, IllegalAccessException
    {
        Log.LogFunctionStartDebug( "CurrentObject.updateObject" );
        try
        {
            if ( "".equals( cvsChildFN ) )
            {
                // -> 2. Get the Window-Object...
                cvoObject = myFrameObjectDictionary.getParentObjectByName( cvsWindowFN );
                cvsObjectName = cvoObject.getClass().getName();
                cvsFullObjectFN = cvsWindowFN;
 
            }
            else
            {
                // < 1. Set the cvsObjectName for a child-Object.
                cvsFullObjectFN = cvsWindowFN + "." + cvsChildFN;
 
                // < 2. Now get the Object-Instance...
                cvoObject = null;
                cvoObject = myFrameObjectDictionary.getChildObjectByName( cvsWindowFN, cvsChildFN );
 
                // < 3. Set tecnicalname of Object-Instance...
                cvsObjectName = cvoObject.getClass().getName();
            }
        }
        finally
        {
            Log.LogFunctionEndDebug( );
        }
    }
 
 
    /*
     * \~german
     * Ruft eine Methode, gegeben in fpsMethodName, des aktuellen Objektes via "late bound function call" auf. 
     *
     * @param FN Funktionaler Name des GUI-Objektes.
     * @param fpsMethodName der Methode, die aufgerufen werden soll.
     * @param fpsParameter_1 1. Parameter als Type-String.
     *
     * \~english
     * Calls a method of the current Object with "late bound function call".
     *
     * @param FN Functional name of the GUI-Object.
     * @param fpsMethodName of method to be called.
     * @param fpsParameter_1 1st
     * parameter as type-String.
     *
     * \~
     * @author Zoltan Hrabovszki
     * @date 2012.11.01
     */
    public void Sequence( String FN, String fpsMethodName, String fpsParameter_1 ) throws Exception
    {
        Log.LogFunctionStartDebug( "Sequence", "String fpsMethodName", fpsMethodName, "String fps_Parameter_1", fpsParameter_1 );
 
        setWindowName( FN );
 
        Class<?>[] paramTypes =
        { String.class };
        Class<?> myFrame_Class = cvoObject.getClass();
 
        try
        {
            Method myMethod = myFrame_Class.getDeclaredMethod( fpsMethodName, paramTypes );
            myMethod.invoke( cvoObject, fpsParameter_1 );
        }
        catch (NoSuchMethodException e)
        {
            // Existiert die Methode des Objektes?
            // Nein: -> Mit einem OKWFrameObjectMethodNotFoundException
            // aussteigen...
            String errorText = LM.GetMessage( "CallMethod", "MethodNotDefined", fpsMethodName );
            throw new OKWFrameObjectMethodNotFoundException( errorText );
        }
        finally
        {
            Log.LogFunctionEndDebug();
        }
    }
}