OKW_Helper.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.*;
 
import javax.xml.xpath.XPathExpressionException;
 
import okw.exceptions.*;
import okw.log.Logger_Sngltn;
 
public class OKW_Helper
{
 
    private static Logger_Sngltn        Log = Logger_Sngltn.getInstance();
 
    private static LogMessenger LM  = new LogMessenger("OKW_Helper");
 
    public static String Boolean2String( Boolean fpbTrueOrFalse )
    {
        String lvsReturn = "";
        
        Log.LogFunctionStartDebug("OKW_Helper.Boolean2String", "fpbTrueOrFalse", fpbTrueOrFalse.toString());
 
        try
        {
            if (fpbTrueOrFalse)
            {
                lvsReturn = "true";
            }
            else
            {
                lvsReturn = "false";
            }
        }
        finally
        {
            Log.LogFunctionEndDebug(lvsReturn);
        }
 
        return lvsReturn;
    }
 
    public static String getLeftFromDelimiterNumber( String fpsSource, String fpsDelimiter, Integer fpiCount ) throws XPathExpressionException
    {
        String lvsReturn = "";
        ArrayList<String> lvLsSplitedSource = null;
 
        int RangeMin = 1;
        int RangeMax = 1;
 
        try
        {
            Log.LogFunctionStartDebug("OKW_Helper.GetLeftFromDelimiterNumber", "fpsSource", fpsSource, "fpsDelimiter",
                    fpsDelimiter, "fpiCount", fpiCount.toString());
 
            if ( ! "".equals( fpsDelimiter ) )
            {
                lvLsSplitedSource = splitString(fpsSource, fpsDelimiter);
 
                // Gültigen Werte bereich berechnen:
                RangeMax = lvLsSplitedSource.size() - 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.get(0);
 
                    for (int i = 1; i < fpiCount; i++)
                    {
                        lvsReturn = lvsReturn + fpsDelimiter + lvLsSplitedSource.get(i);
                    }
                }
                else
                {
                    String lvsLM = LM.GetMessage("GetLeftFromDelimiterNumber", "OKWDelimiterCountOutOfRangeException",
                            fpiCount, RangeMax);
                    throw new IndexOutOfBoundsException(lvsLM);
                }
            }
            else
            {
                String lvsLM = LM.GetMessage("GetLeftFromDelimiterNumber", "OKWDelimiterIsEmptyException");
                throw new IllegalArgumentException(lvsLM);
            }
        }
        finally
        {
            Log.LogFunctionEndDebug(lvsReturn);
        }
 
        return lvsReturn;
    }
 
    public static String getRightFromDelimiterNumber( String fpsSource, String fpsDelimiter, Integer fpiCount ) throws XPathExpressionException
    {
        String lvsReturn = "";
        List<String> lvLsSplitedSource = null;
        int RangeMin = 1;
        int RangeMax = 1;
        try
        {
            Log.LogFunctionStartDebug("OKW_Helper.GetRigthFromDelimiterNumber", "fpsSource", fpsSource, "fpsDelimiter",
                    fpsDelimiter, "fpiCount", fpiCount.toString());
            
            if (  ! "".equals( fpsDelimiter ))
            {
                lvLsSplitedSource = splitString(fpsSource, fpsDelimiter);
 
                // Gültigen Werte bereich berechnen:
                RangeMax = lvLsSplitedSource.size() - 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.get(fpiCount);
 
                    for (int i = fpiCount + 1; i < lvLsSplitedSource.size(); i++)
                    {
                        lvsReturn = lvsReturn + fpsDelimiter + lvLsSplitedSource.get(i);
                    }
                }
                else
                {
                    String lvsLM = LM.GetMessage("GetRightFromDelimiterNumber", "OKWDelimiterCountOutOfRangeException",
                            fpiCount, RangeMax);
                    throw new IndexOutOfBoundsException(lvsLM);
                }
            }
            else
            {
                String lvsLM = LM.GetMessage("GetRightFromDelimiterNumber", "OKWDelimiterIsEmptyException");
                throw new IllegalArgumentException(lvsLM);
            }
        }
        finally
        {
            Log.LogFunctionEndDebug(lvsReturn);
        }
 
        return lvsReturn;
    }
 
    public static Boolean compareListString( List<String> ListString1, List<String> ListString2 )
    {
        Boolean lvbReturn = true;
 
        Log.LogFunctionStartDebug("OKW_Helper.ListStringCompare", "ListString1", ListString1.toString(), "ListString2",
                ListString2.toString());
 
        try
        {
            // HAben beide Listen
            if (ListString1.size() == ListString2.size())
            {
                for (int i = 0; i < ListString1.size(); i++)
                {
                    if (ListString1.get(i) != ListString2.get(i))
                    {
                        // ungleich daher abbrechen und false zurückliefern.
                        Log.LogPrintDebug(ListString1.get(i) + "<>" + ListString2.get(i));
                        lvbReturn = false;
                        break;
                    }
                    else
                    {
                        lvbReturn = true;
                    }
                }
            }
            else
            {
                lvbReturn = false;
            }
        }
        finally
        {
            Log.LogFunctionEndDebug(lvbReturn);
        }
 
        return lvbReturn;
    }
 
    public static String concatListString( ArrayList<String> fps_ListString2Concat, String fps_Delimiter )
    {
        String lvsReturn = "";
 
        Log.LogFunctionStartDebug("OKW_Helper.ListStringConcat", "fps_ListString2Concat",
                fps_ListString2Concat.toString(), "fps_Separator", fps_Delimiter);
 
        try
        {
            StringBuilder sb = new StringBuilder();
            
            for (int i=0;  i<fps_ListString2Concat.size(); i++)
            {
                if (i > 0)
                {
                    sb.append(fps_Delimiter);
                }
 
                sb.append(fps_ListString2Concat.get(i));
            }
 
            lvsReturn = sb.toString();
        }
        finally
        {
            Log.LogFunctionEndDebug(lvsReturn);
        }
 
        return lvsReturn;
    }
 
    public static Boolean matchString( String fpsPattern, String fpsStringToMatch )
    {
        // Variables:
        Boolean lvbReturn = false;
 
        // Action:
        try
        {
            Log.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
            // c#:String pattern = "^" + Regex.Escape(fpsPattern).Replace("\\*",
            // ".*").Replace("\\?", ".") + "$";
            String pattern = "^" + fpsPattern.replace("*", ".*").replace("?", ".") + "$";
 
            // c#: Regex regex;
            // c#: regex = new Regex(pattern);
 
            // C#: lvb_Return = regex.IsMatch(fpsStringToMatch);
            lvbReturn = fpsStringToMatch.matches(pattern);
        }
        finally
        {
                Log.LogFunctionEndDebug(lvbReturn);
        }
 
        return lvbReturn;
    }
 
    public static Boolean matchStrIgnoreCase( String fpsPattern, String fpsStringToMatch )
    {
        // Variables:
        Boolean lvbReturn = false;
 
        // Action:
        try
        {
            Log.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
            // c#:String pattern = "^" + Regex.Escape(fpsPattern).Replace("\\*",
            // ".*").Replace("\\?", ".") + "$";
            String pattern = "^" + fpsPattern.replace("*", ".*").replace("?", ".") + "$";
 
            // Now, run the Regex as you already know
            // c#: Regex regex;
            // c#: regex = new Regex(pattern, RegexOptions.IgnoreCase);
 
            // C#: lvb_Return = regex.IsMatch(fpsStringToMatch);
            lvbReturn = fpsStringToMatch.matches("(?i:" + pattern + ")");
        }
        finally
        {
            Log.LogFunctionEndDebug(lvbReturn);
        }
 
        return lvbReturn;
    }
 
    public static String removeBeginEndQuotations( String fps_StringinQuotations )
    {
 
        String lvsReturn = fps_StringinQuotations.replaceAll("^\"|\"$", "");
 
        return lvsReturn;
    }
 
    public static ArrayList<String> StringArray2ListStr( String[] fpsStringArray )
    {
        Log.LogFunctionStartDebug("OKW_Helper.StrArray2ListStr", "fpsStringArray", fpsStringArray.toString());
 
        ArrayList<String> lvls_Splited = new ArrayList<String>();
        lvls_Splited.clear();
 
        try
        {
            for (String lvsElement : fpsStringArray)
            {
                lvls_Splited.add(lvsElement);
            }
        }
        finally
        {
            Log.LogFunctionEndDebug(lvls_Splited);
        }
 
        return lvls_Splited;
    }
 
 
    public static Boolean String2Boolean( String fpsTrueOrFalse ) throws XPathExpressionException
    {
        Boolean lvbReturn = false;
        Boolean bOK = false;
 
        String lvsTrueOrFalse = fpsTrueOrFalse.toLowerCase();
 
        Log.LogFunctionStartDebug("OKW_Helper.String2Boolean", "fpsTrueOrFalse", fpsTrueOrFalse);
 
        try
        {
            if ( "true".equals( lvsTrueOrFalse ) )
            {
                lvbReturn = true;
                bOK = true;
            }
            else if ( "false".equals( lvsTrueOrFalse ) )
            {
                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;
    }
 
 
    public static ArrayList<String> splitString(String fpsString2Split, String fpsSeparator)
    {
        ArrayList<String> SplitedList = new ArrayList<String>();
        int offset = 0;
        
        Log.LogFunctionStartDebug("OKW_Helper.StrSplit", "fpsString2Split", fpsString2Split, "fpsSeparator",
                fpsSeparator);
 
        try
        {       
        while (true)
        {
            int index = fpsString2Split.indexOf(fpsSeparator, offset);
            if (index == -1)
            {
                SplitedList.add(fpsString2Split.substring(offset));
                break;
            }
            else
            {
                SplitedList.add(fpsString2Split.substring(offset, index));
                offset = (index + fpsSeparator.length());
            }
        }
    }
    finally
    {
        Log.LogFunctionEndDebug(SplitedList);
    }
        
        return SplitedList;
    }
    
    
    public static String repeatString( char c, Integer n )
    {
        StringBuilder lvsReturn = new StringBuilder();
        
        for (Integer x = 0; x < n; x++)
            lvsReturn.append(c);
        
        return lvsReturn.toString();
    }
    
 
    public static String repeatString( String c, Integer n )
    {
        StringBuilder lvsReturn = new StringBuilder();
        
        for (Integer x = 0; x < n; x++)
            lvsReturn.append(c);
        
        return lvsReturn.toString();
    }
 
    public static Boolean isStringNullOrEmpty( String fpsString)
    {
        // Variables
        Boolean lvbReturn = true;
        
        // Action
        if(fpsString != null && !fpsString.isEmpty())
        {
            lvbReturn = false;
        }
        
        // Return
        return lvbReturn;
    }
}