OKW_Const.cs

#region Header
/*
    ==============================================================================
      Author: Zoltan Hrabovszki <zh@openkeyword.de>

      Copyright © 2012, 2013, 2014, 2015 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/>.
*/
#endregion Header

namespace OKW
{
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Xml.XPath;

    using OKW.Log;

    public class OKW_Const
    {
        #region Fields

        private static readonly OKW_Const instance = new OKW_Const();

        private OKWLanguage CL = OKWLanguage.Instance;

        LogMessenger LM_OKW_Const_xml = null;
        
        private XPathDocument MyXPathDocument;
        private XPathNavigator MyXPathNavigator;
        
        string OKW_Const_xml = string.Empty;

        #endregion Fields

        #region Constructors

        private OKW_Const()
        {

            string myOKW_Const = OKW.ANTLR4.MyParser.ParseMe(OKW_Ini.Instance.OKW_Enviroment.File_OKW_Const_xml);
            this.OKW_Const_xml = System.IO.Path.Combine(OKW_Ini.Instance.OKW_Enviroment.Folder_XML, @"OKW_Const.xml");
            System.Console.WriteLine( "OKW_Const.xml: >>" + this.OKW_Const_xml + "<<");

            this.LM_OKW_Const_xml = new LogMessenger(this.GetType().Name);
            
            if (!System.IO.File.Exists(this.OKW_Const_xml))
            {
                string lvsMessage = this.LM_OKW_Const_xml.GetMessage("OKW_Const", "FileNotFoundException", this.OKW_Const_xml);
                throw new FileNotFoundException(lvsMessage);
            }
            else
            {
                MyXPathDocument = new XPathDocument(this.OKW_Const_xml);
                MyXPathNavigator = this.MyXPathDocument.CreateNavigator();
            }
        }

        #endregion Constructors

        #region Properties

        public static OKW_Const Instance
        {
            get
            {
                return instance;
            }
        }

        #endregion Properties

        #region Methods

        public string Boolean2YesNo(bool fpbTrueOrFalse)
        {
            string lvs_Return = string.Empty;
            string lvsInternalname = string.Empty;

            try
            {
                Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".Boolean2YesNo", "fpbTrueOrFalse", fpbTrueOrFalse.ToString());

                if (fpbTrueOrFalse)
                {
                    // If TRUE -> YES
                    lvs_Return = this.GetConst4Internalname("YES");
                }
                else
                {
                    // Else FALSE -> NO
                    lvs_Return = this.GetConst4Internalname("NO");
                }
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvs_Return);
            }

            return lvs_Return;
        }

        public string ConcatHSEP(List<string> fpLs_ListString2Concat)
        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".ConcatHSEP", "fpLs_ListString2Concat", fpLs_ListString2Concat.ToString());

            string lvs_Return = string.Empty;

            try
            {
                lvs_Return = OKW_Helper.ListStringConcat(fpLs_ListString2Concat, this.GetOKWConst4Internalname("HSEP"));
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvs_Return);
            }

            return lvs_Return;
        }

        public string ConcatSEP(List<string> fpLs_ListString2Concat)
        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".ConcatSEP", "fpLs_ListString2Concat", fpLs_ListString2Concat.ToString());

            string lvs_Return = string.Empty;

            try
            {
                lvs_Return = OKW_Helper.ListStringConcat(fpLs_ListString2Concat, this.GetOKWConst4Internalname("SEP"));
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvs_Return);
            }

            return lvs_Return;
        }

        public string ConcatVSEP(List<string> fpLs_ListString2Concat)
        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".ConcatVSEP", "fpLs_ListString2Concat", fpLs_ListString2Concat.ToString());

            string lvs_Return = string.Empty;

            try
            {
                lvs_Return = OKW_Helper.ListStringConcat(fpLs_ListString2Concat, this.GetOKWConst4Internalname("VSEP"));
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvs_Return);
            }

            return lvs_Return;
        }

        public string GetConst4Internalname(string fpsInternalname)
        {
            Log.Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".ReadConst", "fpsInternalname", fpsInternalname);

            string lvs_temp = string.Empty;

            string myXPath = "//okwconst[@internalname='" + fpsInternalname + "']/name/" + CL.Language;

            Log.Logger.Instance.LogPrintDebug("myXPath: " + myXPath);

            try
            {
                XPathNodeIterator iter = this.MyXPathNavigator.Select(myXPath);

                if (iter.Count > 0)
                {
                    while (iter.MoveNext())
                    {
                        lvs_temp = iter.Current.Value;
                    }
                }
                else
                {
                    string lvsMessage = this.LM_OKW_Const_xml.GetMessage("GetConst4Internalname",
                                                             "ExceptionConst4Internalname",
                                                             fpsInternalname,
                                                             CL.Language,
                                                             this.LM_OKW_Const_xml.XMLFile);
                    throw new OKWConst4InternalnameNotFoundException(lvsMessage);
                }
            }
            finally
            {
                if (lvs_temp == string.Empty)
                {
                    Log.Logger.Instance.LogFunctionEndDebug();
                }
                else
                {
                    Log.Logger.Instance.LogFunctionEndDebug(lvs_temp);
                }
            }

            return lvs_temp;
        }


        public string GetOKWConst4Internalname(string fpsInternalname)
        {
            string lvsReturn = string.Empty;

            Logger.Instance.LogFunctionStartDebug( this.GetType().FullName + ".GetOKWConst4Internalname", "fpsInternalname", fpsInternalname);

            try
            {
                lvsReturn =
                    this.GetConst4Internalname("LEFTBRACE") +
                    this.GetConst4Internalname(fpsInternalname) +
                    this.GetConst4Internalname("RIGHTBRACE");
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvsReturn);
            }

            return lvsReturn;
        }


        public List<string> SplitHSEP(string fpsString2Split)
        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".SplitHSEP", "fpsString2Split", fpsString2Split);
            List<string> lvls_2Plit = new List<string>();

            try
            {
                lvls_2Plit = OKW_Helper.StrSplit(fpsString2Split, this.GetOKWConst4Internalname("HSEP"));
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvls_2Plit.ToString());
            }

            return lvls_2Plit;
        }

        
        public List<string> SplitSEP(string fpsString2Split)
        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".SplitSEP", "fpsString2Split", fpsString2Split);

            List<string> lvls_2Plit = null;

            try
            {
                lvls_2Plit = OKW_Helper.StrSplit(fpsString2Split, this.GetOKWConst4Internalname("SEP"));
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvls_2Plit.ToString());
            }

            return lvls_2Plit;
        }

        public List<string> SplitVSEP(string fps_String2Split)
        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".SplitHSEP", "fps_String2Split", fps_String2Split);
            List<string> lvls_2Plit = new List<string>();

            try
            {
                lvls_2Plit = OKW_Helper.StrSplit(fps_String2Split, this.GetOKWConst4Internalname("VSEP"));
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvls_2Plit.ToString());
            }

            return lvls_2Plit;
        }

        
        public bool YesNo2Boolean(string fpsYesOrNo)
        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".YesNo2Boolean", "fpsYesOrNo", fpsYesOrNo);
            bool lvb_Return = false;

            string lvs_Yes = string.Empty;
            string lvs_No  = string.Empty;

            try
            {
                lvs_Yes = this.GetConst4Internalname("YES");
                lvs_No  = this.GetConst4Internalname("NO");

                if (lvs_Yes.ToUpper() == fpsYesOrNo.ToUpper())
                {
                    lvb_Return = true;
                }
                else if (lvs_No.ToUpper() == fpsYesOrNo.ToUpper())
                {
                    lvb_Return = false;
                }
                else
                {
                    Logger.Instance.LogFunctionEndDebug();

                    string lvsMessage = this.LM_OKW_Const_xml.GetMessage("YesNo2Boolean", "ValueNotAllowed", fpsYesOrNo, lvs_Yes + "'/'" + lvs_No);
                    throw new OKWNotAllowedValueException(lvsMessage);
                }
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvb_Return);
            }

            return lvb_Return;
        }

        #endregion Methods
    }
}