OKW.OKWConst Class Reference

OKW_Const manages the language dependent OKW-Constants. More...

Collaboration diagram for OKW.OKWConst:

Public Member Functions
string	Boolean2YesNo (bool fpbTrueOrFalse)
	Converts true/false language dependent to yes/no. More...
string	ConcatHSEP (List< string > fpLs_ListString2Concat)
	The method connects single strings of a list-string to one string and separates it with the constant ${HSEP}. More...
string	ConcatSEP (List< string > fpLs_ListString2Concat)
	Method combines single strings of a liststring to one string and separates it with the constant ${SEP}. More...
string	ConcatVSEP (List< string > fpLs_ListString2Concat)
	Method combines single strings of a liststring to a single string and separates it with the constant ${VSEP}. More...
string	GetConst4Internalname (string fpsInternalname)
	Method detects the value for Const for the internalname and the actual selected language. More...
string	GetOKWConst4Internalname (string fpsInternalname)
	Method detects for Internalname and the actual selected language the value for OKWConst. More...
List< string >	SplitHSEP (string fpsString2Split)
	Method separates a string and converts it to a liststring. The cut is set at the constant ${HSEP}. More...
List< string >	SplitSEP (string fpsString2Split)
	Method separates a string and converts it to a liststring. The cut is set at the constant ${SEP}. More...
List< string >	SplitVSEP (string fps_String2Split)
	Method devides a string and converts it to a liststring. The cut is set at the constant ${VSEP}. More...
bool	YesNo2Boolean (string fpsYesOrNo)
	Converts a Language dependent Yes/No to bool. More...

Properties
static OKWConst	Instance OKWConst.xml" [get]
	Gets the only instance of this class. The instance of this class. More...

Private Member Functions
	OKWConst ()
	Private constructor without a parameter like singleton pattern: initializes the class OKWConst. More...

Private Attributes
OKWLanguage	CL = OKWLanguage.Instance
	The actual language settings (current language) are administrated in the classe OKWLanguage. http://en.wikipedia.org/wiki/ISO_3166-1. More...
LogMessenger	MyLM = null
	Reference to OKW.Log.LogMessenger. More...
XPathDocument	MyXPathDocument
XPathNavigator	MyXPathNavigator
string	OKWConst_xml = string.Empty
	Contains the complete path and filename referring to the file OKW_Const.xml. More...

Static Private Attributes
static readonly OKWConst	instance = new OKWConst()

Detailed Description

OKW_Const manages the language dependent OKW-Constants.

Designpattern: Singleton - the Highlander-Principle is valid "There only can be one!".

This means there is only one instance of this class, which is responsible for reading the news. The language dependent values belonging to this class are in the file "OKWConst.xml"

This class itself is an OKW-fundamental-class and returns no logs for its own.

Terms
Here is a list of identifier / name / term created to be used in this class.

• Const is the language dependent constant to an internal constant(no brackets)
• OKWConst is the language dependent constant, appearing outward. It has the form for the German implementation: _${Bezeichner}_ and corresponds Const with brackets.
• Internalname is the non language dependent internal identifier of a Const. Look following table:

Internal Name	Const (EN)	OKW_Const (EN)
SEP	SEP	${SEP}
VSEP	VSEP	${VSEP}
HSEP	HSEP	${HSEP}
DELETE	DELETE	${DELETE}
EMPTY	EMPTY	${EMPTY}
IGNORE	IGNORE	${IGNORE}
YES	YES	-
NO	NO	-
CHECKED	CHECKED	-
UNCHECKED	UNCHECKED	-
LEFTBRACE	${	-
RIGHTBRACE	}	-

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_22_jnic)

Todo:

(Zeile 22) Zukünftige Funktionalität: Nachricht auf einen anderen Tag weiterverlinken.

(Zeile 41) Tabellenüberschrift wird als Verlinkung gelesen und blau auf blau dargestellt - OKWConst/DE

(Zeile 75) Tabellenüberschrift wird als Verlinkung gelesen und blau auf blau dargestellt - OKWConst/EN

Constructor & Destructor Documentation

OKW.OKWConst.OKWConst ( )

private

Private constructor without a parameter like singleton pattern: initializes the class OKWConst.

The initialization is effected as follows:

Remarks

This class is a singleton, therefore the constructor is private. Use OKWConst.Instance to receive the instance of the class.

Example:

// Split giveneExpected Value
List>string< lvlsExpected = OKWConst.Instance.SplitSEP(fpsExpectedValue);

Exceptions

A	System.IO.FileNotFoundException is triggered, if the file OKWConst.xml is not found.

Author

Zoltan Hrabovszki

Date

2013_12_22

Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

        {
            this.OKWConst_xml = System.IO.Path.Combine(OKW_Ini.Instance.OKW_Enviroment.PathXML, @"OKWConst.xml");

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

Member Function Documentation

string OKW.OKWConst.Boolean2YesNo

(

bool

fpbTrueOrFalse

)

Converts true/false language dependent to yes/no.

Parameters

fps_YesOrNo

true or false

Returns

"yes" in case of true
"no" in case of false

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

        {
            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;
        }

string OKW.OKWConst.ConcatHSEP

(

List< string >

fpLs_ListString2Concat

)

The method connects single strings of a list-string to one string and separates it with the constant ${HSEP}.

The method is working language dependent meaning that the separation constant is used in the actual language.

Parameters

fpLs_ListString2Concat

List-String, to be combined to a single string. Example: {"Value1", "Value2", "Value3", "Value4"}

Returns

Combined Values "Value1${HSEP}Value2${HSEP}Value3${HSEP}Value

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".ConcatHSEP", "fpLs_ListString2Concat", fpLs_ListString2Concat.ToString());

            string lvs_Return = string.Empty;

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

            return lvs_Return;
        }

string OKW.OKWConst.ConcatSEP

(

List< string >

fpLs_ListString2Concat

)

Method combines single strings of a liststring to one string and separates it with the constant ${SEP}.

The method works language dependent using the separation constant with the actual language.

Parameters

fpLs_ListString2Concat

Liststring to be combined to one string. Example: {"Value1", "Value2", "Value3", "Value4"}

Returns

Combined values "Value${SEP}Value2${SEP}Value3${SEP}Value

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".ConcatSEP", "fpLs_ListString2Concat", fpLs_ListString2Concat.ToString());

            string lvs_Return = string.Empty;

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

            return lvs_Return;
        }

string OKW.OKWConst.ConcatVSEP

(

List< string >

fpLs_ListString2Concat

)

Method combines single strings of a liststring to a single string and separates it with the constant ${VSEP}.

The method is working language dependent using the separation constant of the actual language

Parameters

fpLs_ListString2Concat

List-String, to be combined to a single string. Example: {"Value1", "Value2", "Value3", "Value"}

Returns

Combined values "Value1${VSEP}Value2${VSEP}Value3${VSEP}Value4

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".ConcatVSEP", "fpLs_ListString2Concat", fpLs_ListString2Concat.ToString());

            string lvs_Return = string.Empty;

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

            return lvs_Return;
        }

string OKW.OKWConst.GetConst4Internalname

(

string

fpsInternalname

)

Method detects the value for Const for the internalname and the actual selected language.

GetConst4Internalname is the core method of this class and detects for

• fpsInternalname and
• CL.Language corresponds to OKWLanguage.Instance.Language

the language dependent constant.

Exceptions

If	no value is found for fpsInternalname, then the exception OKWConst4InternalnameNotFoundException is triggered.

Parameters

fpsInternalname

Internal identifier of a constant, which is converted to a language dependent constant. (Internalname -> Const)

Returns

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

        {
            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.MyLM.GetMessage("GetConst4Internalname",
                                                             "ExceptionConst4Internalname",
                                                             fpsInternalname,
                                                             CL.Language,
                                                             this.OKWConst_xml);
                    throw new OKWConst4InternalnameNotFoundException(lvsMessage);
                }
            }
            finally
            {
                if (lvs_temp == string.Empty)
                {
                    Log.Logger.Instance.LogFunctionEndDebug();
                }
                else
                {
                    Log.Logger.Instance.LogFunctionEndDebug(lvs_temp);
                }
            }

            return lvs_temp;
        }

Here is the caller graph for this function:

string OKW.OKWConst.GetOKWConst4Internalname

(

string

fpsInternalname

)

Method detects for Internalname and the actual selected language the value for OKWConst.

GetOKWConst4Internalname selects for

• fpsInternalname and
• CL.Language (local reference for OKWLanguage.Instance.Language)

the language dependent constant and places it in brackets.

Internalname	OKW_Const (DE)
SEP	${SEP}
VSEP	${VSEP}
HSEP	${HSEP}
DELETE	${DELETE}
EMPTY	${EMPTY}
IGNORE	${IGNORE}

Example: "$IGNORE" == GetOKWConst4Internalname("IGNORE")

Parameters

fpsInternalname

Internalname of constant. Example: "IGNORE"

Returns

Bracketed constant. Example: "${IGNORIEREN}" for "IGNORE"

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

        {
            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;
        }

Here is the call graph for this function:

List<string> OKW.OKWConst.SplitHSEP

(

string

fpsString2Split

)

Method separates a string and converts it to a liststring. The cut is set at the constant ${HSEP}.

The method is working language dependent meaning it is used the separation constant of the actual language.

See also

OKWConst::ConcatSEP()
OKWConst::ConcatHSEP()
OKWConst::ConcatVSEP()
OKWConst::SplitSEP()
OKWConst::SplitVSEP()

Parameters

fpsString2Split

One or more values, which are divided with ${HSEP}. Example: "Value1${HSEP}Value2${HSEP}Value2"

Returns

Separated values as a list. Example: {"Value1", "Value2", "Value3"}

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

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

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

            return lvls_2Plit;
        }

List<string> OKW.OKWConst.SplitSEP

(

string

fpsString2Split

)

Method separates a string and converts it to a liststring. The cut is set at the constant ${SEP}.

The method is working language dependant meaning it is used the separation constant of the actual language.

See also

OKWConst::ConcatSEP()
OKWConst::ConcatHSEP()
OKWConst::ConcatVSEP()
OKWConst::SplitHSEP()
OKWConst::SplitVSEP()

Parameters

fpsString2Split

One or more values, which are separated with ${SEP}. Example: "Value1${SEP}Value2${SEP}Value2"

Returns

Separated values as a list: {"value1", "value2", "value3"}

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

        {
            Logger.Instance.LogFunctionStartDebug(this.GetType().FullName + ".SplitSEP", "fpsString2Split", fpsString2Split);

            List<string> lvls_2Plit = null;

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

            return lvls_2Plit;
        }

List<string> OKW.OKWConst.SplitVSEP

(

string

fps_String2Split

)

Method devides a string and converts it to a liststring. The cut is set at the constant ${VSEP}.

The method is working language dependent meaning it is used the separation constant of the actual language.

See also

OKWConst::ConcatSEP()
OKWConst::ConcatHSEP()
OKWConst::ConcatVSEP()
OKWConst::SplitHSEP()
OKWConst::SplitSEP()

Parameters

fpsString2Split

One or more values, which are separated with ${VSEP}. Example: "value1${VSEP}value2${VSEP}value2"

Returns

Separated values as a list. Example: {"value1", "value2", "value3"}

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

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

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

            return lvls_2Plit;
        }

bool OKW.OKWConst.YesNo2Boolean

(

string

fpsYesOrNo

)

Converts a Language dependent Yes/No to bool.

e.g. Language is "en": Input "Yes" returns true
e.g. Language is "en": Input "No" returns false
e.g. Language is "de": Input "Yes" or "No" - raises the exception OKWNotAllowedValueException.

Parameters

fpsYesOrNo

Language dependent Yes/No

Returns

true if Language dependent value is "yes"
false if language dependent "No"

Author

Zoltan Hrabovszki

Date

2013_12_09
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

        {
            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.MyLM.GetMessage("YesNo2Boolean", "ValueNotAllowed", fpsYesOrNo, lvs_Yes + "'/'" + lvs_No);
                    throw new OKWNotAllowedValueException(lvsMessage);
                }
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvb_Return);
            }

            return lvb_Return;
        }

Member Data Documentation

OKWLanguage OKW.OKWConst.CL = OKWLanguage.Instance

private

The actual language settings (current language) are administrated in the classe OKWLanguage.
http://en.wikipedia.org/wiki/ISO_3166-1.

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_22_jnic)

LogMessenger OKW.OKWConst.MyLM = null

private

Reference to OKW.Log.LogMessenger.

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_22_jnic)

string OKW.OKWConst.OKWConst_xml = string.Empty

private

Contains the complete path and filename referring to the file OKW_Const.xml.

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_22_jnic)

Property Documentation

OKWConst OKW.OKWConst.Instance OKWConst.xml"

staticget

Gets the only instance of this class.
The instance of this class.

Author

Zoltan Hrabovszki

Date

2013_12_22
Reviews:(2014_12_18_jnic, 2014_12_22_zh, 2014_12_26_jnic)

---

The documentation for this class was generated from the following file:

• OKW/Develop/OKWConst.cs