ParserUtils (FlatPack Parent 4.0.18 API)

java.lang.Object
- net.sf.flatpack.util.ParserUtils

```
public final class ParserUtils
extends Object
```
Static utilities that are used to perform parsing in the DataSet class These can also be used for low level parsing, if not wishing to use the DataSet class.

Author:

Paul Zepernick, Benoit Xhenseval

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Map<String,Integer>`	`buidColumnIndexMap(List<ColumnMetaData> columns, Parser p)` Build a map of name/position based on a list of ColumnMetaData.
`static List<ColumnMetaData>`	`buildMDFromSQLTable(Connection con, String dataDefinition, Parser parser)` Returns a definition of pz column metadata from a given pz datastructure held in an SQL database
`static Map<String,Integer>`	`calculateRecordLengths(MetaData columnMD)`
`static String`	`getCMDKeyForDelimitedFile(MetaData columnMD, List<String> lineElements)`
`static int`	`getColumnIndex(String key, MetaData columnMD, String colName, boolean columNameCaseSensitive)`
`static List<ColumnMetaData>`	`getColumnMetaData(String key, MetaData columnMD)`
`static int`	`getDelimiterOffset(String line, int start, char delimiter)` reads from the specified point in the line and returns how many chars to the specified delimiter
`static MetaData`	`getPZMetaDataFromFile(String line, char delimiter, char qualifier, Parser p, boolean addSuffixToDuplicateColumnNames)` Returns a list of ColumnMetaData objects.
`static boolean`	`isListElementsEmpty(List<String> l)` Checks a list of <String> elements to see if every element in the list is empty.
`static boolean`	`isMultiLine(char[] chrArry, char delimiter, char qualifier)` Determines if the given line is the first part of a multiline record.
`static Properties`	`loadConvertProperties()` Retrieves the conversion table for use with the getObject() method in IDataSet
`static String`	`lTrim(String value)` Removes empty space from the beginning of a string
`static String`	`lTrimKeepTabs(String value)` Removes empty space from the beginning of a string, except for tabs
`static String`	`padding(int repeat, char padChar)` Returns padding using the specified delimiter repeated to a given length.
`static String`	`replace(String text, String searchString, String replacement, int max)` Using a much faster String Replace from Apache!
`static String`	`rTrim(String value)` Removes empty space from the end of a string
`static Object`	`runPzConverter(Properties classXref, String value, Class<?> typeToReturn)` Converts a String value to the appropriate Object via the correct net.sf.flatpack.converter.PZConverter implementation
`static List<String>`	`splitLine(String line, char delimiter, char qualifier, int initialSize, boolean preserveLeadingWhitespace, boolean preserveTrailingWhitespace)` Returns an ArrayList of items in a delimited string.
`static String`	`stripNonDoubleChars(String value)` Removes chars from the String that could not be parsed into a Double value
`static String`	`stripNonLongChars(String value)` Removes chars from the String that could not be parsed into a Long value PZStringUtils.stripNonLongChars("1000.25") = "1000" Method will truncate everything to the right of the decimal place when encountered.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - splitLine
```
public static List<String> splitLine(String line,
                                     char delimiter,
                                     char qualifier,
                                     int initialSize,
                                     boolean preserveLeadingWhitespace,
                                     boolean preserveTrailingWhitespace)
```
    Returns an ArrayList of items in a delimited string. If there is no qualifier around the text, the qualifier parameter can be left null, or empty. There should not be any line breaks in the string. Each line of the file should be passed in individually. Elements which are not qualified will have leading and trailing white space removed. This includes unqualified elements, which may be contained in an unqualified parse: "data", data ,"data" Special thanks to Benoit for contributing this much improved speedy parser :0)
    
    Parameters:
    
    line - - String of data to be parsed
    
    delimiter - - Delimiter separating each element
    
    qualifier - - qualifier which is surrounding the text
    
    initialSize - - initial capacity of the List size
    
    preserveLeadingWhitespace - Keep any leading spaces
    
    preserveTrailingWhitespace - Keep any trailing spaces
    
    Returns:
    
    List
  - replace
```
public static String replace(String text,
                             String searchString,
                             String replacement,
                             int max)
```
    Using a much faster String Replace from Apache!
    
    See Also:
    
    StackOverflow
  - getDelimiterOffset
```
public static int getDelimiterOffset(String line,
                                     int start,
                                     char delimiter)
```
    reads from the specified point in the line and returns how many chars to the specified delimiter
    
    Parameters:
    
    line -
    
    start -
    
    delimiter -
    
    Returns:
    
    int
  - lTrim
```
public static String lTrim(String value)
```
    Removes empty space from the beginning of a string
    
    Parameters:
    
    value - - to be trimmed
    
    Returns:
    
    String
  - lTrimKeepTabs
```
public static String lTrimKeepTabs(String value)
```
    Removes empty space from the beginning of a string, except for tabs
    
    Parameters:
    
    value - - to be trimmed
    
    Returns:
    
    String
  - rTrim
```
public static String rTrim(String value)
```
    Removes empty space from the end of a string
    
    Parameters:
    
    value - - to be trimmed
    
    Returns:
    
    String
  - getPZMetaDataFromFile
```
public static MetaData getPZMetaDataFromFile(String line,
                                             char delimiter,
                                             char qualifier,
                                             Parser p,
                                             boolean addSuffixToDuplicateColumnNames)
```
    Returns a list of ColumnMetaData objects. This is for use with delimited files. The first line of the file which contains data will be used as the column names
    
    Parameters:
    
    line -
    
    delimiter -
    
    qualifier -
    
    p - PZParser used to specify additional option when working with the ColumnMetaData. Can be null
    
    addSuffixToDuplicateColumnNames -
    
    Returns:
    
    PZMetaData
  - isMultiLine
```
public static boolean isMultiLine(char[] chrArry,
                                  char delimiter,
                                  char qualifier)
```
    Determines if the given line is the first part of a multiline record. It does this by verifying that the qualifer on the last element is not closed
    
    Parameters:
    
    chrArry - - char data of the line
    
    delimiter - - delimiter being used
    
    qualifier - - qualifier being used
    
    Returns:
    
    boolean
  - calculateRecordLengths
```
public static Map<String,Integer> calculateRecordLengths(MetaData columnMD)
```
  - getCMDKeyForDelimitedFile
```
public static String getCMDKeyForDelimitedFile(MetaData columnMD,
                                               List<String> lineElements)
```
  - getColumnMetaData
```
public static List<ColumnMetaData> getColumnMetaData(String key,
                                                     MetaData columnMD)
```
  - getColumnIndex
```
public static int getColumnIndex(String key,
                                 MetaData columnMD,
                                 String colName,
                                 boolean columNameCaseSensitive)
```
  - padding
```
public static String padding(int repeat,
                             char padChar)
```
    Returns padding using the specified delimiter repeated to a given length.
```
                PZStringUtils.padding(0, 'e')  = ""
                PZStringUtils.padding(3, 'e')  = "eee"
                PZStringUtils.padding(-2, 'e') = IndexOutOfBoundsException
 
```
    Note: this method doesn't not support padding with Unicode Supplementary Characters as they require a pair of chars to be represented.
    Parameters:
    
    repeat - number of times to repeat delim
    
    padChar - character to repeat
    
    Returns:
    
    String with repeated character
    
    Throws:
    
    IndexOutOfBoundsException
  - buidColumnIndexMap
```
public static Map<String,Integer> buidColumnIndexMap(List<ColumnMetaData> columns,
                                                     Parser p)
```
    Build a map of name/position based on a list of ColumnMetaData.
    
    Parameters:
    
    columns -
    
    p - Reference to Parser which can provide additional options on how the map should be build. This can be NULL.
    
    Returns:
    
    a new Map
  - stripNonLongChars
```
public static String stripNonLongChars(String value)
```
    Removes chars from the String that could not be parsed into a Long value PZStringUtils.stripNonLongChars("1000.25") = "1000" Method will truncate everything to the right of the decimal place when encountered.
    
    Parameters:
    
    value -
    
    Returns:
    
    String
  - stripNonDoubleChars
```
public static String stripNonDoubleChars(String value)
```
    Removes chars from the String that could not be parsed into a Double value
    
    Parameters:
    
    value -
    
    Returns:
    
    String
  - loadConvertProperties
```
public static Properties loadConvertProperties()
                                        throws IOException
```
    Retrieves the conversion table for use with the getObject() method in IDataSet
    
    Returns:
    
    Properties Properties contained in the pzconvert.properties file
    
    Throws:
    
    IOException
  - isListElementsEmpty
```
public static boolean isListElementsEmpty(List<String> l)
```
    Checks a list of <String> elements to see if every element in the list is empty.
    
    Parameters:
    
    l - List of <String>
    
    Returns:
    
    boolean true when all elements are empty
  - runPzConverter
```
public static Object runPzConverter(Properties classXref,
                                    String value,
                                    Class<?> typeToReturn)
```
    Converts a String value to the appropriate Object via the correct net.sf.flatpack.converter.PZConverter implementation
    
    Parameters:
    
    classXref - Properties holding class cross reference
    
    value - Value to be converted to the Object
    
    typeToReturn - Type of object to be returned
    
    Returns:
    
    Object
    
    Throws:
    
    FPConvertException
  - buildMDFromSQLTable
```
public static List<ColumnMetaData> buildMDFromSQLTable(Connection con,
                                                       String dataDefinition,
                                                       Parser parser)
                                                throws SQLException
```
    Returns a definition of pz column metadata from a given pz datastructure held in an SQL database
    
    Parameters:
    
    con - Database connection containing the Datafile and Datastructure tables
    
    dataDefinition - Name of the data definition stored in the Datafile table
    
    parser - Instance of the parser being used for the file. It will be checked to get the table names for the DATASTRUCTURE table and DATAFILE table.
    
    Returns:
    
    List
    
    Throws:
    
    SQLException

Class ParserUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

splitLine

replace

getDelimiterOffset

lTrim

lTrimKeepTabs

rTrim

getPZMetaDataFromFile

isMultiLine

calculateRecordLengths

getCMDKeyForDelimitedFile

getColumnMetaData

getColumnIndex

padding

buidColumnIndexMap

stripNonLongChars

stripNonDoubleChars

loadConvertProperties

isListElementsEmpty

runPzConverter

buildMDFromSQLTable