Parser (FlatPack Parent 4.0.18 API)

All Known Implementing Classes:

AbstractDelimiterParser, AbstractFixedLengthParser, AbstractParser, BuffReaderDelimParser, BuffReaderFixedParser, DBBuffReaderDelimParser, DBBuffReaderFixedParser, DBDelimiterParser, DBFixedLengthParser, DelimiterParser, FixedLengthParser
```
public interface Parser
```
PZParser is ready to parse the data and return an object that can then be traversed. The default parser should NOT handle short lines, the user can change it prior to calling parse.

Author:

Benoit Xhenseval, Paul Zepernick

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getDataFileTable()` Returns the table name that will be used to read the MetaData from the db.
`String`	`getDataStructureTable()` Returns the table name that will be used to read the MetaData from the db.
`boolean`	`isColumnNamesCaseSensitive()` Default is false
`boolean`	`isFlagEmptyRows()`
`boolean`	`isHandlingShortLines()`
`boolean`	`isIgnoreExtraColumns()`
`boolean`	`isIgnoreParseWarnings()` Default is false
`boolean`	`isNullEmptyStrings()`
`boolean`	`isPreserveLeadingWhitespace()` Defaults to `true`.
`boolean`	`isPreserveTrailingWhitespace()` Defaults to `false`.
`boolean`	`isStoreRawDataToDataError()`
`boolean`	`isStoreRawDataToDataSet()`
`DataSet`	`parse()` Start the parsing.
`StreamingDataSet`	`parseAsStream()` Parse the data and return an interface where one can extract one record at a time, until next returns false;
`Parser`	`setAddSuffixToDuplicateColumnNames(boolean addSuffixToDuplicateColumnNames)`
`Parser`	`setColumnNamesCaseSensitive(boolean columnNamesCaseSensitive)` Default is false
`Parser`	`setDataFileTable(String dataFileTable)` Sets the table name that will be used to read the MetaData from the db.
`Parser`	`setDataStructureTable(String dataStructureTable)` Sets the table name that will be used to read the MetaData from the db.
`Parser`	`setFlagEmptyRows(boolean flagEmptyRows)` when true, will analyze the row to see if all elements are empty and place a flag on the DataSet indicating if the row is empty.
`Parser`	`setHandlingShortLines(boolean handleShortLines)`
`Parser`	`setIgnoreExtraColumns(boolean ignoreExtraColumns)`
`Parser`	`setIgnoreParseWarnings(boolean ignoreParseWarnings)`
`Parser`	`setNullEmptyStrings(boolean nullEmptyStrings)`
`Parser`	`setPreserveLeadingWhitespace(boolean preserveLeadingWhitespace)` Defaults to `true`.
`Parser`	`setPreserveTrailingWhitespace(boolean preserveTrailingWhitespace)` Defaults to `false`.
`Parser`	`setStoreRawDataToDataError(boolean storeRawDataToDataError)` when true, the parser will place the data of the line which failed the parse and place it into the DataError object.
`Parser`	`setStoreRawDataToDataSet(boolean storeRawDataToDataError)` WARNING!! Setting this option has potential to cause high memory usage.
`Stream<Record>`	`stream()` Parse the data and return a stream or records;

- Method Detail
  - parse
```
DataSet parse()
```
    Start the parsing. Will return "null" if the parse fails and the DataSet cannot be created
    
    Returns:
    
    the data set resulting from parsing
  - parseAsStream
```
StreamingDataSet parseAsStream()
```
    Parse the data and return an interface where one can extract one record at a time, until next returns false;
    
    Returns:
    
    a stream of Dataset
    
    Since:
    
    3.4
  - stream
```
Stream<Record> stream()
```
    Parse the data and return a stream or records;
    
    Returns:
    
    a stream of Record
    
    Since:
    
    4.0
  - isHandlingShortLines
```
boolean isHandlingShortLines()
```
    Returns:
    
    true, lines with less columns then the amount of column headers will be added as empty's instead of producing an error
  - setHandlingShortLines
```
Parser setHandlingShortLines(boolean handleShortLines)
```
    Parameters:
    
    handleShortLines - - when flagged as true, lines with less columns then the amount of column headers will be added as empty's instead of producing an error
    
    Returns:
    
    the Parser
  - setAddSuffixToDuplicateColumnNames
```
Parser setAddSuffixToDuplicateColumnNames(boolean addSuffixToDuplicateColumnNames)
```
    Parameters:
    
    addSuffixToDuplicateColumnNames - when true, add a count to duplicate colum names. eg the second column called "Asset" will become "Asset2".
    
    Returns:
    
    the Parser
  - isIgnoreExtraColumns
```
boolean isIgnoreExtraColumns()
```
    Returns:
    
    true, detail lines with a length or column count > the mapping definition will be truncated and the reader will NOT register these lines as errors in the DataError collection.
  - setIgnoreExtraColumns
```
Parser setIgnoreExtraColumns(boolean ignoreExtraColumns)
```
    Parameters:
    
    ignoreExtraColumns - when true, detail lines with a length or column count > the mapping definition will be truncated and the reader will NOT register these lines as errors in the DataError collection.
    
    Returns:
    
    the Parser
  - isPreserveLeadingWhitespace
```
boolean isPreserveLeadingWhitespace()
```
    Defaults to true.
    
    Returns:
    
    true, the parser will preserve leading whitespace in each column when splitting a line
  - setPreserveLeadingWhitespace
```
Parser setPreserveLeadingWhitespace(boolean preserveLeadingWhitespace)
```
    Defaults to true.
    
    Parameters:
    
    preserveLeadingWhitespace - when true, the parser will preserve leading whitespace in each column when splitting a line
    
    Returns:
    
    the Parser
  - isPreserveTrailingWhitespace
```
boolean isPreserveTrailingWhitespace()
```
    Defaults to false.
    
    Returns:
    
    true, the parser will preserve trailing whitespace in each column when splitting a line
  - setPreserveTrailingWhitespace
```
Parser setPreserveTrailingWhitespace(boolean preserveTrailingWhitespace)
```
    Defaults to false.
    
    Parameters:
    
    preserveTrailingWhitespace - when true, the parser will preserve trailing whitespace in each column when splitting a line
    
    Returns:
    
    the Parser
  - isColumnNamesCaseSensitive
```
boolean isColumnNamesCaseSensitive()
```
    Default is false
    
    Returns:
    
    true, column names will have to be an exact match when retrieving the value of a column. Example when true: Column name = AColumnName ; getString("acolumnname") would fail Example when false: Column name = AColumnName ; getString("acolumnname") would pass
  - setColumnNamesCaseSensitive
```
Parser setColumnNamesCaseSensitive(boolean columnNamesCaseSensitive)
```
    Default is false
    
    Parameters:
    
    columnNamesCaseSensitive - when true, column names will have to be an exact match when retrieving the value of a column. Example when true: Column name = AColumnName ; getString("acolumnname") would fail Example when false: Column name = AColumnName ; getString("acolumnname") would pass
    
    Returns:
    
    the Parser
  - isIgnoreParseWarnings
```
boolean isIgnoreParseWarnings()
```
    Default is false
    
    Returns:
    
    true, warnings encountered during parsing will not be included in the DataSet errors
  - setIgnoreParseWarnings
```
Parser setIgnoreParseWarnings(boolean ignoreParseWarnings)
```
    Parameters:
    
    ignoreParseWarnings - when true, warnings encountered during parsing will not be included in the DataSet errors
    
    Returns:
    
    the Parser
  - isNullEmptyStrings
```
boolean isNullEmptyStrings()
```
    Returns:
    
    true, empty Strings will get returned as NULL when calling DataSet.getString()
  - setNullEmptyStrings
```
Parser setNullEmptyStrings(boolean nullEmptyStrings)
```
    Parameters:
    
    nullEmptyStrings - when true, empty Strings will get returned as NULL when calling DataSet.getString()
    
    Returns:
    
    the Parser
  - isFlagEmptyRows
```
boolean isFlagEmptyRows()
```
    Returns:
    
    flagEmptyRows when true, will analyze the row to see if all elements are empty and place a flag on the DataSet indicating if the row is empty
  - setFlagEmptyRows
```
Parser setFlagEmptyRows(boolean flagEmptyRows)
```
    when true, will analyze the row to see if all elements are empty and place a flag on the DataSet indicating if the row is empty. This will slow down the parse and should only be used when necessary. It is off by default.
    
    Parameters:
    
    flagEmptyRows - true if we need to flag empty rows
    
    Returns:
    
    the Parser
  - isStoreRawDataToDataError
```
boolean isStoreRawDataToDataError()
```
    Returns:
    
    when true, the parser will place the data of the line which failed the parse and place it into the DataError object. DataError.getRawData() can be called to retrieve the line.
  - setStoreRawDataToDataError
```
Parser setStoreRawDataToDataError(boolean storeRawDataToDataError)
```
    when true, the parser will place the data of the line which failed the parse and place it into the DataError object. DataError.getRawData() can be called to retrieve the line.
    
    Parameters:
    
    storeRawDataToDataError - true if we need to store each lines
    
    Returns:
    
    the Parser
  - isStoreRawDataToDataSet
```
boolean isStoreRawDataToDataSet()
```
    Returns:
    
    when true, the parser will place the data of the line into the DataSet object. DataSet.getRawData() can be called to retrieve the line.
  - setStoreRawDataToDataSet
```
Parser setStoreRawDataToDataSet(boolean storeRawDataToDataError)
```
    WARNING!! Setting this option has potential to cause high memory usage. when true, the parser will place the data of the line into the DataSet object. DataSet.getRawData() can be called to retrieve the line.
    
    Parameters:
    
    storeRawDataToDataError - true if we need to store the raw data
    
    Returns:
    
    the Parser
  - getDataFileTable
```
String getDataFileTable()
```
    Returns the table name that will be used to read the MetaData from the db. The default table name is DATAFILE. This may be problimatic for some who are using case sensistive db table names or who wish to provide a different table name in the db. This is only applicable when using a database for file mappings.
    
    Returns:
    
    the DATAFILE table name
  - setDataFileTable
```
Parser setDataFileTable(String dataFileTable)
```
    Sets the table name that will be used to read the MetaData from the db. The default table name is DATAFILE. This may be problimatic for some who are using case sensistive db table names or who wish to provide a different table name in the db. This is only applicable when using a database for file mappings.
    
    Parameters:
    
    dataFileTable - Name of the table name to use in place of "DATAFILE"
    
    Returns:
    
    the Parser
  - getDataStructureTable
```
String getDataStructureTable()
```
    Returns the table name that will be used to read the MetaData from the db. The default table name is DATASTRUCTURE. This may be problimatic for some who are using case sensistive db table names or who wish to provide a different table name in the db. This is only applicable when using a database for file mappings.
    
    Returns:
    
    the DATASTRUCTURE table name
  - setDataStructureTable
```
Parser setDataStructureTable(String dataStructureTable)
```
    Sets the table name that will be used to read the MetaData from the db. The default table name is DATASTRUCTURE. This may be problimatic for some who are using case sensistive db table names or who wish to provide a different table name in the db. This is only applicable when using a database for file mappings.
    
    Parameters:
    
    dataStructureTable - Name of the table name to us in placfe of "DATASTRUCTURE"
    
    Returns:
    
    the Parser

Interface Parser

Method Summary

Method Detail

parse

parseAsStream

stream

isHandlingShortLines

setHandlingShortLines

setAddSuffixToDuplicateColumnNames

isIgnoreExtraColumns

setIgnoreExtraColumns

isPreserveLeadingWhitespace

setPreserveLeadingWhitespace

isPreserveTrailingWhitespace

setPreserveTrailingWhitespace

isColumnNamesCaseSensitive

setColumnNamesCaseSensitive

isIgnoreParseWarnings

setIgnoreParseWarnings

isNullEmptyStrings

setNullEmptyStrings

isFlagEmptyRows

setFlagEmptyRows

isStoreRawDataToDataError

setStoreRawDataToDataError

isStoreRawDataToDataSet

setStoreRawDataToDataSet

getDataFileTable

setDataFileTable

getDataStructureTable

setDataStructureTable