OKW_Const_Sngltn.java

/*
    ==============================================================================
      Author: Zoltán Hrabovszki <zh@openkeyword.de>
 
      Copyright © 2012 - 2019 IT-Beratung Hrabovszki
      www.OpenKeyWord.de
    ============================================================================== 
 
    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;
 
import java.util.ArrayList;
 
import javax.xml.xpath.XPathExpressionException;
 
import okw.exceptions.OKWConst4InternalnameNotFoundException;
import okw.exceptions.OKWMessageNotFoundException;
import okw.exceptions.OKWNotAllowedValueException;
import okw.log.Logger_Sngltn;
 
public class OKW_Const_Sngltn
{
 
    private static Logger_Sngltn    Log       = Logger_Sngltn.getInstance();
 
    private static OKW_Const_Sngltn Instance;
 
    private OKWLanguage CL = OKWLanguage.getInstance();
 
    private LogMessenger LM = null;
 
    private OKW_XmlReader           myXmlReader;
 
    protected OKW_Const_Sngltn()
    {
        try
        {
            LM = new LogMessenger( "OKW_Const" );
 
            myXmlReader = new OKW_XmlReader( "/xml/OKW_Const.xml" );
 
            /*if (OKW_FileHelper.FileExists(lvsOKW_Const_xml))
                {
                    myXmlReader = new OKW_XmlReader("xml/OKW_Const.xml");
                }
                else
                {
                    String lvsMessage = LM.GetMessage("OKW_Const", "FileNotFoundException", lvsOKW_Const_xml);
                    throw new FileNotFoundException(lvsMessage);
                }
            */
        }
        catch (Exception e)
        {
            OKW_HandleException.StopRunning( e, this.getClass() );
        }
 
    }
 
    
    public static OKW_Const_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_Const_Sngltn.class )
            {
                if ( Instance == null )
                {
                    Instance = new OKW_Const_Sngltn();
                }
            }
        }
        return Instance;
    }
 
    
    public String Boolean2YesNo( Boolean fpbTrueOrFalse ) throws XPathExpressionException
    {
        String lvs_Return = "";
 
        try
        {
            Log.LogFunctionStartDebug( this.getClass().getName() + ".Boolean2YesNo", "fpbTrueOrFalse", fpbTrueOrFalse.toString() );
 
            if ( fpbTrueOrFalse )
            {
                // If TRUE -> YES
                lvs_Return = this.GetConst4Internalname( "YES" );
            }
            else
            {
                // Else FALSE -> NO
                lvs_Return = this.GetConst4Internalname( "NO" );
            }
        }
        finally
        {
            Log.LogFunctionEndDebug( lvs_Return );
        }
 
        return lvs_Return;
    }
 
    public String ConcatHSEP( ArrayList<String> fpLs_ListString2Concat ) throws XPathExpressionException
    {
        Log.LogFunctionStartDebug( this.getClass().getName() + ".ConcatHSEP", "fpLs_ListString2Concat", fpLs_ListString2Concat.toString() );
 
        String lvs_Return = "";
 
        try
        {
            lvs_Return = OKW_Helper.concatListString( fpLs_ListString2Concat, this.GetOKWConst4Internalname( "HSEP" ) );
        }
        finally
        {
            Log.LogFunctionEndDebug( lvs_Return );
        }
 
        return lvs_Return;
    }
 
    public String ConcatSEP( ArrayList<String> fpLs_ListString2Concat ) throws XPathExpressionException
    {
        Log.LogFunctionStartDebug( this.getClass().getName() + ".ConcatSEP", "fpLs_ListString2Concat", fpLs_ListString2Concat.toString() );
 
        String lvs_Return = "";
 
        try
        {
            lvs_Return = OKW_Helper.concatListString( fpLs_ListString2Concat, this.GetOKWConst4Internalname( "SEP" ) );
        }
        finally
        {
            Log.LogFunctionEndDebug( lvs_Return );
        }
 
        return lvs_Return;
    }
 
    public String ConcatVSEP( ArrayList<String> fpLs_ListString2Concat ) throws XPathExpressionException
    {
        Log.LogFunctionStartDebug( this.getClass().getName() + ".ConcatVSEP", "fpLs_ListString2Concat", fpLs_ListString2Concat.toString() );
 
        String lvs_Return = "";
 
        try
        {
            lvs_Return = OKW_Helper.concatListString( fpLs_ListString2Concat, this.GetOKWConst4Internalname( "VSEP" ) );
        }
        finally
        {
            Log.LogFunctionEndDebug( lvs_Return );
        }
 
        return lvs_Return;
    }
 
    public String GetConst4Internalname( String fpsInternalname )
    {
        Log.LogFunctionStartDebug( this.getClass().getName() + ".ReadConst", "fpsInternalname", fpsInternalname );
 
        String lvsReturn = "";
 
        try
        {
 
            String myXPathExpression = "//okwconst[@internalname='" + fpsInternalname + "']/name/" + CL.getLanguage();
 
            Log.LogPrintDebug( "XPath: >>" + myXPathExpression + "<<" );
 
            lvsReturn = myXmlReader.getTextContentSingleValue( myXPathExpression );
        }
        catch( OKWMessageNotFoundException e )
        {
            throw new OKWConst4InternalnameNotFoundException( e.getMessage() );
        }
        finally
        {
            Log.LogFunctionEndDebug( lvsReturn );
        }
 
        return lvsReturn;
    }
 
    public String GetOKWConst4Internalname( String fpsInternalname )
    {
        String lvsReturn = null;
 
        Log.LogFunctionStartDebug( this.getClass().getName() + ".GetOKWConst4Internalname", "fpsInternalname", fpsInternalname );
 
        try
        {
            lvsReturn = this.GetConst4Internalname( "LEFTBRACE" ) + this.GetConst4Internalname( fpsInternalname ) + this.GetConst4Internalname( "RIGHTBRACE" );
        }
        finally
        {
            Log.LogFunctionEndDebug( lvsReturn );
        }
 
        return lvsReturn;
    }
 
    public ArrayList<String> SplitHSEP( String fpsString2Split ) throws XPathExpressionException
    {
        ArrayList<String> lvls_2Plit = new ArrayList<String>();
 
        Log.LogFunctionStartDebug( this.getClass().getName() + ".SplitHSEP", "fpsString2Split", fpsString2Split );
 
        try
        {
            lvls_2Plit = OKW_Helper.splitString( fpsString2Split, this.GetOKWConst4Internalname( "HSEP" ) );
        }
        finally
        {
            Log.LogFunctionEndDebug( lvls_2Plit.toString() );
        }
 
        return lvls_2Plit;
    }
 
    public ArrayList<String> SplitSEP( String fpsString2Split ) throws XPathExpressionException
    {
        ArrayList<String> lvls_2Plit = null;
        Log.LogFunctionStartDebug( this.getClass().getName() + ".SplitSEP", "fpsString2Split", fpsString2Split );
 
        try
        {
            lvls_2Plit = OKW_Helper.splitString( fpsString2Split, this.GetOKWConst4Internalname( "SEP" ) );
        }
        finally
        {
            Log.LogFunctionEndDebug( lvls_2Plit.toString() );
        }
 
        return lvls_2Plit;
    }
 
    public ArrayList<String> SplitVSEP( String fps_String2Split ) throws XPathExpressionException
    {
        ArrayList<String> lvls_2Plit = new ArrayList<String>();
 
        Log.LogFunctionStartDebug( this.getClass().getName() + ".SplitHSEP", "fps_String2Split", fps_String2Split );
 
        try
        {
            lvls_2Plit = OKW_Helper.splitString( fps_String2Split, this.GetOKWConst4Internalname( "VSEP" ) );
        }
        finally
        {
            Log.LogFunctionEndDebug( lvls_2Plit.toString() );
        }
 
        return lvls_2Plit;
    }
 
    public Boolean YesNo2Boolean( String fpsYesOrNo ) throws XPathExpressionException
    {
        Log.LogFunctionStartDebug( this.getClass().getName() + ".YesNo2Boolean", "fpsYesOrNo", fpsYesOrNo );
        Boolean lvb_Return = false;
 
        String lvs_Yes = "";
        String lvs_No = "";
 
        try
        {
            lvs_Yes = this.GetConst4Internalname( "YES" ).toUpperCase();
            lvs_No = this.GetConst4Internalname( "NO" ).toUpperCase();
 
            if ( lvs_Yes.equals( fpsYesOrNo.toUpperCase() ) )
            {
                lvb_Return = true;
            }
            else if ( lvs_No.equals( fpsYesOrNo.toUpperCase() ) )
            {
                lvb_Return = false;
            }
            else
            {
                Log.LogFunctionEndDebug();
 
                String lvsMessage = LM.GetMessage( "YesNo2Boolean", "ValueNotAllowed", fpsYesOrNo, lvs_Yes + "'/'" + lvs_No );
                throw new OKWNotAllowedValueException( lvsMessage );
            }
        }
        finally
        {
            Log.LogFunctionEndDebug( lvb_Return );
        }
 
        return lvb_Return;
    }
}