OKW.OKWHelper Class Reference

Class contains OKW-Helpfunctions. More...

Collaboration diagram for OKW.OKWHelper:

Static Public Member Functions
static string	Boolean2String (bool fpbTrueOrFalse)
	Converts bool true/false to string "true"/"false". More...
static string	GetLeftFromDelimiterNumber (string fpsSource, string fpsDelimiter, int fpiCount)
	The String will be cut at the fpiCount-ten delimiter and the left half of the String is returned. More...
static string	GetRigthFromDelimiterNumber (string fpsSource, string fpsDelimiter, int fpiCount)
	Cuts fpsSource at fpiCount-ten fpsDelimiter and returns the right part of the string. More...
static bool	ListStringCompare (List< string > ListString1, List< string > ListString2)
	Compares two ListStrings with view to their content. More...
static string	ListStringConcat (List< string > fps_ListString2Concat, string fps_Separator)
static bool	MatchStr (string fpsPattern, string fpsStringToMatch)
	Source: http://stackoverflow.com/questions/6907720/need-to-perform-wildcard-etc-search-on-a-string-using-regex. More...
static bool	MatchStrIgnoreCase (string fpsPattern, string fpsStringToMatch)
	Source: http://stackoverflow.com/questions/6907720/need-to-perform-wildcard-etc-search-on-a-string-using-regex. More...
static string	RemoveBeginEndQuotations (string fps_StringinQuotations)
	Removes quotation marks " at the beginning and at the end. Quotation marks being internal of the string will not be removed. If there are no quotation marks at the beginning and at the end, then the return is identical to the input. More...
static List< string >	StrArray2ListStr (string[] fpsStringArray)
	Converts a String-Array to a List-String. More...
static bool	String2Boolean (string fpsTrueOrFalse)
	Converts string "true"/"false" to bool. More...
static List< string >	StrSplit (string fpsString2Split, string fpsSeparator)
	Splits a string at the given Separator. The separator can consist of more than one sign. More...

Static Private Attributes
static Logger	Log = Logger.Instance
static LogMessenger	LM = new LogMessenger("OKWHelper")

Detailed Description

Class contains OKW-Helpfunctions.

This class is and should to be used in project specific classes.

Member Function Documentation

static string OKW.OKWHelper.Boolean2String ( bool  fpbTrueOrFalse )

static

Converts bool true/false to string "true"/"false".

Parameters

fpbTrueOrFalse

Boolean value to be converted.

Returns

• true is to be changed in "true" and
• falsebecomes "false".

Author

Zoltán Hrabovszki

Date

2013.05.03

        {
            string lvsReturn = string.Empty;

            Logger.Instance.LogFunctionStartDebug("OKWHelper.Boolean2String", "fpbTrueOrFalse", fpbTrueOrFalse.ToString());

            try
            {
                if (fpbTrueOrFalse)
                {
                    lvsReturn = "true";
                }
                else
                {
                    lvsReturn = "false";
                }
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvsReturn);
            }

            return lvsReturn;
        }

static string OKW.OKWHelper.GetLeftFromDelimiterNumber ( string  fpsSource, string  fpsDelimiter, int  fpiCount  )

static

The String will be cut at the fpiCount-ten delimiter and the left half of the String is returned.

An exception is triggered, if

• the delimiter is empty: OKW.OKWDelimiterIsEmptyException
• fpiCount is not in valid parameters(1 >= fpiCount >c= numerb of delimiters): OKW.OKWDelimiterCountOutOfRangeException

Valid examples:

• "AAAA" = OKWHelper.GetLeftFromDelimiterNumber("AAAACBBBB", "C", 1)
• "AAAACBBBB" = OKWHelper.GetLeftFromDelimiterNumber("AAAACBBBBCDDDD", "C", 2)
• "AAAAGGBBBB"= OKWHelper.GetLeftFromDelimiterNumber("AAAAGGBBBBGGDDDD", "GG", 2)

Examples with triggering the exception procedure

• OKWHelper.GetLeftFromDelimiterNumber("AAAACBBBB", "", 1) : OKW.OKWDelimiterIsEmptyException
• OKWHelper.GetLeftFromDelimiterNumber("AAAACBBBBCDDDD", "C", 3) : OKW.OKWDelimiterCountOutOfRangeException
• OKWHelper.GetLeftFromDelimiterNumber("AAAAGGBBBBGGDDDD", "GG", 0) : OKW.OKWDelimiterCountOutOfRangeException

Parameters

fpsSource	Signstring to be cut.
fpsDelimiter	Delimiter which is cut. Delimiter itself is no part of the return. Delimiter can exist out of more than 1 sign.
fpiCount	Number of delimiter to be cut. fpiCount is out of the multitude of natural numbers, 1, 2, 3, ... sides of the string, viewed from delimiter fpsDelemeter.

Author

Zoltán Hrabovszki

Date

2013.05.03

        {
            string lvsReturn = string.Empty;
            List<string> lvLsSplitedSource = null;

            bool bOK = false;

            int RangeMin = 1;
            int RangeMax = 1;

            try
            {
                Log.LogFunctionStartDebug("OKWHelper.GetLeftFromDelimiterNumber", "fpsSource", fpsSource, "fpsDelimiter", fpsDelimiter, "fpiCount", fpiCount.ToString());

                if (fpsDelimiter != string.Empty)
                {
                    lvLsSplitedSource = StrSplit(fpsSource, fpsDelimiter);

                    // Gültigen Werte bereich berechnen:
                    RangeMax = lvLsSplitedSource.Count - 1;
                    RangeMin = 1;

                    // 1. Prüfen ob Split Zahl <= Count, anderefalls Exception auslösen...
                    if ((RangeMin <= fpiCount) & (fpiCount <= RangeMax))
                    {
                        // 2. Dann bauen wir den string auf
                        lvsReturn = lvLsSplitedSource[0];

                        for (int i = 1; i < fpiCount; i++)
                        {
                            lvsReturn = lvsReturn + fpsDelimiter + lvLsSplitedSource[i];
                        }
                    }
                    else
                    {
                        string lvsLM = LM.GetMessage("GetLeftFromDelimiterNumber", "OKWDelimiterCountOutOfRangeException", fpiCount.ToString(), RangeMax.ToString());
                        throw new System.IndexOutOfRangeException(lvsLM);
                    }
                }
                else
                {
                    string lvsLM = LM.GetMessage("GetLeftFromDelimiterNumber", "OKWDelimiterIsEmptyException");
                    throw new System.ArgumentException(lvsLM);
                }

                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvsReturn);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }

            return lvsReturn;
        }

Here is the call graph for this function:

static string OKW.OKWHelper.GetRigthFromDelimiterNumber ( string  fpsSource, string  fpsDelimiter, int  fpiCount  )

static

Cuts fpsSource at fpiCount-ten fpsDelimiter and returns the right part of the string.

Valid examples:

• "DDD/EEE" = GetRigthFromDelimiterNumber("AAA/BBB/CCC/DDD/EEE", "/", 3)
• "BBB/CCC/DDD/EEE" = GetRigthFromDelimiterNumber("AAA/BBB/CCC/DDD/EEE", "/", 1)
• "EEE" = GetRigthFromDelimiterNumber("AAA/BBB/CCC/DDD/EEE", "/", 4)

Examples triggering the exception procedure

• OKWHelper.GetRigthFromDelimiterNumber("AAAACBBBB", "", 1) : System.IndexOutOfRangeException
• OKWHelper.GetRigthFromDelimiterNumber("AAAACBBBBCDDDD", "C", 3) : System.IndexOutOfRangeException
• OKWHelper.GetRigthFromDelimiterNumber("AAAAGGBBBBGGDDDD", "GG", 0) : System.IndexOutOfRangeException

Parameters

fpsSource	Quelle
fpsDelimiter	Delimiter which is to be cut.
fpiCount

Returns

Todo:

TODO ZH: Rückgabewert beschreiben.

Author

Zoltán Hrabovszki

Date

2013.05.03

        {
            string lvsReturn = string.Empty;
            List<string> lvLsSplitedSource = null;
            bool bOK = false;
            int RangeMin = 1;
            int RangeMax = 1;
            try
            {
                Log.LogFunctionStartDebug("OKWHelper.GetLeftFromDelimiterNumber", "fpsSource", fpsSource, "fpsDelimiter", fpsDelimiter, "fpiCount", fpiCount.ToString());
                if (fpsDelimiter != string.Empty)
                {
                    lvLsSplitedSource = StrSplit(fpsSource, fpsDelimiter);

                    // Gültigen Werte bereich berechnen:
                    RangeMax = lvLsSplitedSource.Count - 1;
                    RangeMin = 1;

                    // 1. Prüfen ob Split Zahl <= Count, anderefalls Exception auslösen...
                    if ((RangeMin <= fpiCount) & (fpiCount <= RangeMax))
                    {
                        // 2. Dann bauen wir den string auf
                        lvsReturn = lvLsSplitedSource[fpiCount];

                        for (int i = fpiCount + 1; i < lvLsSplitedSource.Count; i++)
                        {
                            lvsReturn = lvsReturn + fpsDelimiter + lvLsSplitedSource[i];
                        }
                    }
                    else
                    {
                        string lvsLM = LM.GetMessage("GetLeftFromDelimiterNumber", "OKWDelimiterCountOutOfRangeException", fpiCount.ToString(), RangeMax.ToString());
                        throw new System.IndexOutOfRangeException(lvsLM);
                    }
                }
                else
                {
                    string lvsLM = LM.GetMessage("GetLeftFromDelimiterNumber", "OKWDelimiterIsEmptyException");
                    throw new System.ArgumentException(lvsLM);
                }

                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvsReturn);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }
            
            return lvsReturn;
        }

Here is the call graph for this function:

static bool OKW.OKWHelper.ListStringCompare ( List< string >  ListString1, List< string >  ListString2  )

static

Compares two ListStrings with view to their content.

Parameters

ListString1	String Nr. 1
ListString2	String Nr. 2 if the string content is identical, else false.

Author

Zoltán Hrabovszki

Date

2013.15.11

        {
            bool lvbReturn = true;
            bool bOK = false;

            Logger.Instance.LogFunctionStartDebug("OKWHelper.ListStringCompare", "ListString1", ListString1.ToString(), "ListString2", ListString2.ToString());

            try
            {
                // HAben beide Listen
                if (ListString1.Count == ListString2.Count)
                {
                    for (int i = 0; i < ListString1.Count; i++)
                    {
                        if (ListString1[i] != ListString2[i])
                        {
                            // ungleich daher abbrechen und false zurückliefern.
                            Logger.Instance.LogPrintDebug(ListString1[i] + "<>" + ListString2[i]);
                            lvbReturn = false;
                            break;
                        }
                        else
                        {
                            lvbReturn = true;
                        }
                    }
                }
                else
                {
                    lvbReturn = false;
                }
                
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Logger.Instance.LogFunctionEndDebug(lvbReturn);
                }
                else
                {
                    Logger.Instance.LogFunctionEndDebug();
                }
            }
            
            return lvbReturn;
        }

Here is the caller graph for this function:

static string OKW.OKWHelper.ListStringConcat ( List< string >  fps_ListString2Concat, string  fps_Separator  )

static

Author

Zoltán Hrabovszki

Date

2013.01.03

        {
            string lvsReturn = string.Empty;
            bool bOK = false;

            Log.LogFunctionStartDebug("OKWHelper.ListStringConcat", "fps_ListString2Concat", fps_ListString2Concat.ToString(), "fps_Separator", fps_Separator);

            try
            {
                lvsReturn = string.Join(fps_Separator, fps_ListString2Concat.ToArray());
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvsReturn);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }

            return lvsReturn;
        }

static bool OKW.OKWHelper.MatchStr ( string  fpsPattern, string  fpsStringToMatch  )

static

Source: http://stackoverflow.com/questions/6907720/need-to-perform-wildcard-etc-search-on-a-string-using-regex.

Parameters

fpsPattern
fpsStringToMatch

Returns

Todo:

TODO ZH: Rückgabewert beschreiben.

        {
            // Variables:
            bool lvbReturn = false;
            bool bOK = false;

            // Action:
            try
            {
                Logger.Instance.LogFunctionStartDebug("OKWHelper.MatchStr", "String fpsPattern", fpsPattern, "String fpsStringToMatch", fpsStringToMatch);

                // Replace the * with an .* and the ? with a dot. Put ^ at the
                // beginning and a $ at the end
                string pattern = "^" + Regex.Escape(fpsPattern).Replace(@"\*", ".*").Replace(@"\?", ".") + "$";

                // Now, run the Regex as you already know
                Regex regex;
                regex = new Regex(pattern);

                lvbReturn = regex.IsMatch(fpsStringToMatch);
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvbReturn);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }
            
            return lvbReturn;
        }

Here is the caller graph for this function:

static bool OKW.OKWHelper.MatchStrIgnoreCase ( string  fpsPattern, string  fpsStringToMatch  )

static

Source: http://stackoverflow.com/questions/6907720/need-to-perform-wildcard-etc-search-on-a-string-using-regex.

Parameters

fpsPattern
fpsStringToMatch

Returns

Todo:

TODO ZH: Rückgabewert beschreiben.

        {
            // Variables:
            bool lvb_Return = false;
            bool bOK = true;

            // Action:
            try
            {
                Logger.Instance.LogFunctionStartDebug("OKWHelper.MatchStrIgnoreCase", "String fpsPattern", fpsPattern, "String fpsStringToMatch", fpsStringToMatch);

                // Replace the * with an .* and the ? with a dot. Put ^ at the
                // beginning and a $ at the end
                string pattern = "^" + Regex.Escape(fpsPattern).Replace(@"\*", ".*").Replace(@"\?", ".") + "$";

                // Now, run the Regex as you already know
                Regex regex;
                regex = new Regex(pattern, RegexOptions.IgnoreCase);

                lvb_Return = regex.IsMatch(fpsStringToMatch);
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Logger.Instance.LogFunctionEndDebug(lvb_Return);
                }
                else
                {
                    Logger.Instance.LogFunctionEndDebug();
                }
            }
            
            return lvb_Return;
        }

static string OKW.OKWHelper.RemoveBeginEndQuotations ( string  fps_StringinQuotations )

static

Removes quotation marks " at the beginning and at the end. Quotation marks being internal of the string will not be removed. If there are no quotation marks at the beginning and at the end, then the return is identical to the input.

Parameters

fps_StringinQuotations

String, which should be removed from quotation marks. without quotation marks at the beginning an the end.

Author

Zoltán Hrabovszki

Date

2013.05.03

        {
            string lvs_Return = Regex.Replace(fps_StringinQuotations, "^\"|\"$", string.Empty);
            return lvs_Return;
        }

static List<string> OKW.OKWHelper.StrArray2ListStr ( string[]  fpsStringArray )

static

Converts a String-Array to a List-String.

Parameters

fpsStringArray

Array to be converted. as a List-String.

Author

Zoltán Hrabovszki

Date

2013.05.03

        {
            Logger.Instance.LogFunctionStartDebug("OKWHelper.StrArray2ListStr", "fpsStringArray", fpsStringArray.ToString());

            List<string> lvls_Splited = new List<string>();
            lvls_Splited.Clear();

            try
            {
                lvls_Splited = new List<string>(fpsStringArray);
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvls_Splited);
            }
            
            return lvls_Splited;
        }

Here is the caller graph for this function:

static bool OKW.OKWHelper.String2Boolean ( string  fpsTrueOrFalse )

static

Converts string "true"/"false" to bool.

true/false.

Exceptions

The	exception OKWNotAllowedValueException is triggerd, if the input Parapere is not "true"/"false".

Parameters

fpbTrueOrFalse

Boolean value to be converted.

Returns

• true is to be changed in "true" and
• falsebecomes "false".

Author

Zoltán Hrabovszki

Date

2013.05.03

        {
            bool lvbReturn = false;
            bool bOK = false;

            string lvsTrueOrFalse = fpsTrueOrFalse.ToLower();

            Logger.Instance.LogFunctionStartDebug("OKWHelper.String2Boolean", "fpsTrueOrFalse", fpsTrueOrFalse);

            try
            {
                if ( lvsTrueOrFalse == "true")
                {
                    lvbReturn = true;
                    bOK = true;
                }
                else if ( lvsTrueOrFalse == "false" )
                {
                    lvbReturn = false;
                    bOK = true;
                }
                else{
                    // alles andere löst ein OKWNotAllowedValueException aus
                    bOK = false;

                    string lvsLM = LM.GetMessage("String2Boolean", "OKWNotAllowedValueException", fpsTrueOrFalse);
                    throw new OKWNotAllowedValueException(lvsLM);
                }
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvbReturn);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }

            return lvbReturn;
        }

static List<string> OKW.OKWHelper.StrSplit ( string  fpsString2Split, string  fpsSeparator  )

static

Splits a string at the given Separator. The separator can consist of more than one sign.

Parameters

fpsString2Split	string to be splitted.
fpsSeparator

Returns

Todo:

TODO ZH: Rückgabewert beschreiben.

Author

Zoltán Hrabovszki

Date

2013.05.03

        {
            bool bOK = false;

            string[] lvsA_Splited;
            List<string> lvls_Splited = new List<string>();

            string[] lvsSeparators = new string[] { fpsSeparator };

            Log.LogFunctionStartDebug("OKWHelper.StrSplit", "fpsString2Split", fpsString2Split, "fpsSeparator", fpsSeparator);

            try
            {
                lvsA_Splited = fpsString2Split.Split(lvsSeparators, StringSplitOptions.None);
                lvls_Splited = StrArray2ListStr(lvsA_Splited);
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvls_Splited);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }
            
            return lvls_Splited;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

LogMessenger OKW.OKWHelper.LM = new LogMessenger("OKWHelper")

staticprivate

Todo:

TODO: für JN review

Logger OKW.OKWHelper.Log = Logger.Instance

staticprivate

Todo:

TODO: für JN review

---

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

• OKW/Develop/OKWHelper.cs