OKW.OKW_Helper Klassenreferenz

Klasse enthält OKW-Hilfsfunktionen. Mehr ...

Zusammengehörigkeiten von OKW.OKW_Helper:

Öffentliche, statische Methoden
static string	Boolean2String (bool fpbTrueOrFalse)
	Konvertiert bool true/false nach string "true"/"false". Mehr ...
static string	GetLeftFromDelimiterNumber (string fpsSource, string fpsDelimiter, int fpiCount)
	Der String wird am fpiCount-ten Trennzeichen abgetrennt und die linke Hälfte des String wird zurückgegeben. Mehr ...
static string	GetRigthFromDelimiterNumber (string fpsSource, string fpsDelimiter, int fpiCount)
	Schneidet fpsSource am fpiCount-ten fpsDelimiter ab und liefert den rechten Teil des string zurück. Mehr ...
static bool	ListStringCompare (List< string > ListString1, List< string > ListString2)
	Vergleicht zwei ListStrings inhaltlich miteinander. Mehr ...
static string	ListStringConcat (List< string > fps_ListString2Concat, string fps_Separator)
	Wandelt List<string> in einen string um und trennt die Werte durch das vorgegebene Trennzeichen voneinander. Mehr ...
static bool	MatchStr (string fpsPattern, string fpsStringToMatch)
	Quelle: http://stackoverflow.com/questions/6907720/need-to-perform-wildcard-etc-search-on-a-string-using-regex. Mehr ...
static bool	MatchStrIgnoreCase (string fpsPattern, string fpsStringToMatch)
	Quelle: http://stackoverflow.com/questions/6907720/need-to-perform-wildcard-etc-search-on-a-string-using-regex. Mehr ...
static string	RemoveBeginEndQuotations (string fps_StringinQuotations)
	Entfernt Anführungstriche " am Anfang und am Ende. Anführungstriche, die sich im String-Inneren befinden, werden nicht entfernt. Sind am Anfang und Ende keine Anführungstriche, dann ist der Rückgabewert gleich dem Eingabewert. Mehr ...
static List< string >	StrArray2ListStr (string[] fpsStringArray)
	Konvertiert einen String-Array nach List-String. Mehr ...
static bool	String2Boolean (string fpsTrueOrFalse)
	Konvertiert string "true"/"false" nach bool. Mehr ...
static List< string >	StrSplit (string fpsString2Split, string fpsSeparator)
	Splittet einen string am angegebenen Separator auf. Der Separator kann aus mehr als einem Zeichen bestehen. Mehr ...

Statische, private Attribute
static Logger	Log = Logger.Instance
	Hält eine Referenz auf die Klasse Logger vor. Mehr ...
static LogMessenger	LM = new LogMessenger("OKWHelper")
	Hält eine Referenz auf die Klasse LogMessenger für die sprachabhängige Log-Ausgabe vor. Mehr ...

Ausführliche Beschreibung

Klasse enthält OKW-Hilfsfunktionen.

Diese Klasse kann und soll auch in projektspezifischen Klassen verwendet werden.

Definiert in Zeile 63 der Datei OKW_Helper.cs.

Dokumentation der Elementfunktionen

static string OKW.OKW_Helper.Boolean2String ( bool  fpbTrueOrFalse )

static

Konvertiert bool true/false nach string "true"/"false".

Parameter

fpbTrueOrFalse

Zu konvertierender boolischer Wert.

Rückgabe

• true wird umgewandelt in "true" und
• falsewird zu "false".

Autor

Zoltán Hrabovszki

Datum

2013.05.03

Definiert in Zeile 108 der Datei OKW_Helper.cs.

        {
            string lvsReturn = string.Empty;

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

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

            return lvsReturn;
        }

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

static

Der String wird am fpiCount-ten Trennzeichen abgetrennt und die linke Hälfte des String wird zurückgegeben.

Es wird eine Ausnahme (exception) ausgelöst, wenn

• das Trennzeichen leer ist: OKW.OKWDelimiterIsEmptyException
• fpiCount ist nicht im gültigen Bereich(1 >= fpiCount > c= Anzahl Trennzeichen): OKW.OKWDelimiterCountOutOfRangeException

Gültige Beispiele:

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

Beispiele mit Auslösung der Ausnahmeprozedur

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

Parameter

fpsSource	Zeichenkette, welche geschnitten wird.
fpsDelimiter	Trennzeichen an der geschnitten wird. Das Trennzeichen selbst gehört nicht zum Ergebnis. Trennzeichen kann aus mehr als einem Zeichen bestehen.
fpiCount	Nummer des Trennzeichen, an der geschnitten wird. fpiCount ist aus der Menge der natürlichen Zahlen, 1, 2, 3, ... Seiten des string, gesehen vom Trennzeichen fpsDelemeter.

Autor

Zoltán Hrabovszki

Datum

2013.05.03

Definiert in Zeile 182 der Datei OKW_Helper.cs.

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

            bool bOK = false;

            int RangeMin = 1;
            int RangeMax = 1;

            try
            {
                Log.LogFunctionStartDebug("OKW_Helper.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;
        }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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

static

Schneidet fpsSource am fpiCount-ten fpsDelimiter ab und liefert den rechten Teil des string zurück.

Gültige Beispiele:

• "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)

Beispiele mit Auslösung der Ausnahmeprozedur

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

Parameter

fpsSource	Quelle.
fpsDelimiter	Trennzeichen an dem geschnitten werden soll.
fpiCount

Rückgabe

Noch zu erledigen:

TODO ZH: Rückgabewert beschreiben.

Autor

Zoltán Hrabovszki

Datum

2013.05.03

Definiert in Zeile 284 der Datei OKW_Helper.cs.

        {
            string lvsReturn = string.Empty;
            List<string> lvLsSplitedSource = null;
            bool bOK = false;
            int RangeMin = 1;
            int RangeMax = 1;
            try
            {
                Log.LogFunctionStartDebug("OKW_Helper.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;
        }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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

static

Vergleicht zwei ListStrings inhaltlich miteinander.

Parameter

ListString1	String Nr. 1
ListString2	String Nr. 2 falls die strings identischen Inhalt haben, sonst false.

Autor

Zoltán Hrabovszki

Datum

2013.15.11

Definiert in Zeile 361 der Datei OKW_Helper.cs.

        {
            bool lvbReturn = true;
            bool bOK = false;

            Logger.Instance.LogFunctionStartDebug("OKW_Helper.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;
        }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

static

Wandelt List<string> in einen string um und trennt die Werte durch das vorgegebene Trennzeichen voneinander.

Fügt die Elemente des ListString aneinander. Die Werte sind ggf. mit Separator getrennt. Der Separator kann aus string.Empty, einem oder mehr als einem Zeichen bestehen.

Siehe auch: http://stackoverflow.com/questions/3575029/c-sharp-liststring-to-string-with-delimiter

Bemerkungen

Für das sprachabhängige Zusammenfügen und Splitten von strings und List<string> verwende:

• OKW.LogMessenger.Instance.SplitHSEP()
• OKW.LogMessenger.Instance.SplitVSEP()

Parameter

fps_ListString2Concat	Liste der zu verbindenden Strings
fps_Separator	Trennzeichen (Separator) der verwendet werden soll.

Rückgabe

Noch zu erledigen:

TODO ZH: Rückgabewert beschreiben.

Changes List<string> to a string and departs the values with the given delimiter.

Adds the elements of ListString together. The values are possibly devided with a separator. The separator can consist oder string.Empty, one ore more signs.

Have a view to: http://stackoverflow.com/questions/3575029/c-sharp-liststring-to-string-with-delimiter

Bemerkungen

For the language depending merging and splitting of strings and List<string> use:

• OKW.LogMessenger.Instance.SplitHSEP()
• OKW.LogMessenger.Instance.SplitVSEP()

Parameter

fps_ListString2Concat	List of Strings to be merged
fps_Separator	delimiter (Separator) which should be used.

Rückgabe

Noch zu erledigen:

TODO ZH: Rückgabewert beschreiben.

Autor

Zoltán Hrabovszki

Datum

2013.01.03

Definiert in Zeile 449 der Datei OKW_Helper.cs.

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

            Log.LogFunctionStartDebug("OKW_Helper.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;
        }

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

static

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

Parameter

fpsPattern
fpsStringToMatch

Rückgabe

Noch zu erledigen:

TODO ZH: Rückgabewert beschreiben.

Definiert in Zeile 491 der Datei OKW_Helper.cs.

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

            // Action:
            try
            {
                Logger.Instance.LogFunctionStartDebug("OKW_Helper.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;
        }

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

static

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

Parameter

fpsPattern
fpsStringToMatch

Rückgabe

Noch zu erledigen:

TODO ZH: Rückgabewert beschreiben.

Definiert in Zeile 543 der Datei OKW_Helper.cs.

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

            // Action:
            try
            {
                Logger.Instance.LogFunctionStartDebug("OKW_Helper.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.OKW_Helper.RemoveBeginEndQuotations ( string  fps_StringinQuotations )

static

Entfernt Anführungstriche " am Anfang und am Ende. Anführungstriche, die sich im String-Inneren befinden, werden nicht entfernt. Sind am Anfang und Ende keine Anführungstriche, dann ist der Rückgabewert gleich dem Eingabewert.

Parameter

fps_StringinQuotations

String, welcher von Anführungstrichen befreit werden soll. ohne Anführungstriche am Anfang und Ende.

Definiert in Zeile 600 der Datei OKW_Helper.cs.

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

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

static

Konvertiert einen String-Array nach List-String.

Parameter

fpsStringArray

Zu konvertierender Array. als List-String.

Autor

Zoltán Hrabovszki

Datum

2013.05.03

Definiert in Zeile 623 der Datei OKW_Helper.cs.

        {
            Logger.Instance.LogFunctionStartDebug("OKW_Helper.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;
        }

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

static bool OKW.OKW_Helper.String2Boolean ( string  fpsTrueOrFalse )

static

Konvertiert string "true"/"false" nach bool.

true/false.

Ausnahmebehandlung

Die	Ausnahme OKWNotAllowedValueException wird ausgelöst, wenn der Eingabwert nicht "true"/"false" ist .

Parameter

fpsTrueOrFalse

Zu konvertierender string Wert.

Rückgabe

• true wird umgewandelt in "true" und
• falsewird zu "false".

Autor

Zoltán Hrabovszki

Datum

2013.05.03

Definiert in Zeile 672 der Datei OKW_Helper.cs.

        {
            bool lvbReturn = false;
            bool bOK = false;

            string lvsTrueOrFalse = fpsTrueOrFalse.ToLower();

            Logger.Instance.LogFunctionStartDebug("OKW_Helper.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;
        }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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

static

Splittet einen string am angegebenen Separator auf. Der Separator kann aus mehr als einem Zeichen bestehen.

Parameter

fpsString2Split	Zu splittender String.
fpsSeparator

Rückgabe

Noch zu erledigen:

TODO ZH: Rückgabewert beschreiben.

Autor

Zoltán Hrabovszki

Datum

2013.05.03

Definiert in Zeile 737 der Datei OKW_Helper.cs.

        {
            bool bOK = false;

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

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

            Log.LogFunctionStartDebug("OKW_Helper.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;
        }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Dokumentation der Datenelemente

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

staticprivate

Hält eine Referenz auf die Klasse LogMessenger für die sprachabhängige Log-Ausgabe vor.

Diese Variable wird im Konstruktor initialisiert.

Bemerkungen

Die Datei mit den Sprachabhängigen Log-Ausgaben zu dieser Klasse ist: /XML/Log/CurrentObject.xml

Definiert in Zeile 79 der Datei OKW_Helper.cs.

Logger OKW.OKW_Helper.Log = Logger.Instance

staticprivate

Hält eine Referenz auf die Klasse Logger vor.

Definiert in Zeile 72 der Datei OKW_Helper.cs.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• OKW/OKW_Helper.cs