AbstractParser (FlatPack Parent 4.0.18 API)

java.lang.Object
- net.sf.flatpack.AbstractParser

All Implemented Interfaces:

Parser

Direct Known Subclasses:

AbstractDelimiterParser, AbstractFixedLengthParser
```
public abstract class AbstractParser
extends Object
implements Parser
```
Author:

xhensevb, zepernick

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractParser(Reader dataSourceReader)`
`protected`	`AbstractParser(Reader dataSourceReader, String dataDefinition)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addError(DefaultDataSet ds, String errorDesc, int lineNo, int errorLevel, String lineData)` Adds a new error to this DataSet.
`protected void`	`addError(DefaultDataSet ds, String errorDesc, int lineNo, int errorLevel, String lineData, String lastColName, String lastColValue)` Adds a new error to this DataSet.
`protected void`	`addToCloseReaderList(Reader r)`
`protected void`	`addToMetaData(List<ColumnMetaData> columns)`
`protected void`	`closeReaders()`
`protected abstract DataSet`	`doParse()`
`protected String`	`getDataDefinition()`
`String`	`getDataFileTable()` Returns the table name that will be used to read the MetaData from the db.
`protected Reader`	`getDataSourceReader()`
`String`	`getDataStructureTable()` Returns the table name that will be used to read the MetaData from the db.
`MetaData`	`getPzMetaData()`
`protected abstract void`	`init()`
`protected void`	`initStreamOrSource(InputStream dataSourceStream, File dataSource)`
`boolean`	`isAddSuffixToDuplicateColumnNames()`
`boolean`	`isColumnNamesCaseSensitive()` Default is false
`boolean`	`isFlagEmptyRows()`
`boolean`	`isHandlingShortLines()`
`boolean`	`isIgnoreExtraColumns()`
`boolean`	`isIgnoreParseWarnings()` Default is false
`protected boolean`	`isInitialised()`
`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
`protected void`	`setDataDefinition(String dataDefinition)`
`Parser`	`setDataFileTable(String dataFileTable)` Sets the table name that will be used to read the MetaData from the db.
`protected void`	`setDataSourceReader(Reader dataSourceReader)`
`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)`
`protected void`	`setInitialised(boolean initialised)`
`Parser`	`setNullEmptyStrings(boolean nullEmptyStrings)`
`Parser`	`setPreserveLeadingWhitespace(boolean preserveLeadingWhitespace)` Defaults to `true`.
`Parser`	`setPreserveTrailingWhitespace(boolean preserveTrailingWhitespace)` Defaults to `false`.
`void`	`setPzMetaData(MetaData pzMap)`
`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 storeRawDataToDataSet)` WARNING!! Setting this option has potential to cause high memory usage.
`Stream<Record>`	`stream()` Parse the data and return a stream or records;

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

- Constructor Detail
  - AbstractParser
```
protected AbstractParser(Reader dataSourceReader)
```
  - AbstractParser
```
protected AbstractParser(Reader dataSourceReader,
                         String dataDefinition)
```
- Method Detail
  - isAddSuffixToDuplicateColumnNames
```
public boolean isAddSuffixToDuplicateColumnNames()
```
  - setAddSuffixToDuplicateColumnNames
```
public Parser setAddSuffixToDuplicateColumnNames(boolean addSuffixToDuplicateColumnNames)
```
    Specified by:
    
    setAddSuffixToDuplicateColumnNames in interface Parser
    
    Parameters:
    
    addSuffixToDuplicateColumnNames - when true, add a count to duplicate colum names. eg the second column called "Asset" will become "Asset2".
    
    Returns:
    
    the Parser
  - initStreamOrSource
```
protected void initStreamOrSource(InputStream dataSourceStream,
                                  File dataSource)
                           throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
  - isHandlingShortLines
```
public boolean isHandlingShortLines()
```
    Specified by:
    
    isHandlingShortLines in interface Parser
    
    Returns:
    
    true, lines with less columns then the amount of column headers will be added as empty's instead of producing an error
  - setHandlingShortLines
```
public Parser setHandlingShortLines(boolean handleShortLines)
```
    Specified by:
    
    setHandlingShortLines in interface Parser
    
    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
  - isIgnoreExtraColumns
```
public boolean isIgnoreExtraColumns()
```
    Specified by:
    
    isIgnoreExtraColumns in interface Parser
    
    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
```
public Parser setIgnoreExtraColumns(boolean ignoreExtraColumns)
```
    Specified by:
    
    setIgnoreExtraColumns in interface Parser
    
    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
```
public boolean isPreserveLeadingWhitespace()
```
    Description copied from interface: Parser
    
    Defaults to true.
    
    Specified by:
    
    isPreserveLeadingWhitespace in interface Parser
    
    Returns:
    
    true, the parser will preserve leading whitespace in each column when splitting a line
  - setPreserveLeadingWhitespace
```
public Parser setPreserveLeadingWhitespace(boolean preserveLeadingWhitespace)
```
    Description copied from interface: Parser
    
    Defaults to true.
    
    Specified by:
    
    setPreserveLeadingWhitespace in interface Parser
    
    Parameters:
    
    preserveLeadingWhitespace - when true, the parser will preserve leading whitespace in each column when splitting a line
    
    Returns:
    
    the Parser
  - isPreserveTrailingWhitespace
```
public boolean isPreserveTrailingWhitespace()
```
    Description copied from interface: Parser
    
    Defaults to false.
    
    Specified by:
    
    isPreserveTrailingWhitespace in interface Parser
    
    Returns:
    
    true, the parser will preserve trailing whitespace in each column when splitting a line
  - setPreserveTrailingWhitespace
```
public Parser setPreserveTrailingWhitespace(boolean preserveTrailingWhitespace)
```
    Description copied from interface: Parser
    
    Defaults to false.
    
    Specified by:
    
    setPreserveTrailingWhitespace in interface Parser
    
    Parameters:
    
    preserveTrailingWhitespace - when true, the parser will preserve trailing whitespace in each column when splitting a line
    
    Returns:
    
    the Parser
  - parse
```
public final DataSet parse()
```
    Description copied from interface: Parser
    
    Start the parsing. Will return "null" if the parse fails and the DataSet cannot be created
    
    Specified by:
    
    parse in interface Parser
    
    Returns:
    
    the data set resulting from parsing
  - parseAsStream
```
public final StreamingDataSet parseAsStream()
```
    Description copied from interface: Parser
    
    Parse the data and return an interface where one can extract one record at a time, until next returns false;
    
    Specified by:
    
    parseAsStream in interface Parser
    
    Returns:
    
    a stream of Dataset
  - stream
```
public final Stream<Record> stream()
```
    Description copied from interface: Parser
    
    Parse the data and return a stream or records;
    
    Specified by:
    
    stream in interface Parser
    
    Returns:
    
    a stream of Record
  - doParse
```
protected abstract DataSet doParse()
```
  - init
```
protected abstract void init()
```
  - closeReaders
```
protected void closeReaders()
                     throws IOException
```
    Throws:
    
    IOException
  - addToCloseReaderList
```
protected void addToCloseReaderList(Reader r)
```
  - addToMetaData
```
protected void addToMetaData(List<ColumnMetaData> columns)
```
  - isInitialised
```
protected boolean isInitialised()
```
  - setInitialised
```
protected void setInitialised(boolean initialised)
```
  - getDataDefinition
```
protected String getDataDefinition()
```
  - setDataDefinition
```
protected void setDataDefinition(String dataDefinition)
```
  - addError
```
protected void addError(DefaultDataSet ds,
                        String errorDesc,
                        int lineNo,
                        int errorLevel,
                        String lineData)
```
    Adds a new error to this DataSet. These can be collected, and retrieved after processing
    
    Parameters:
    
    ds - the data set from the parser
    
    errorDesc - String description of error
    
    lineNo - line number error occurred on
    
    errorLevel - errorLevel 1,2,3 1=warning 2=error 3= severe error'
    
    lineData - Data of the line which failed the parse
  - addError
```
protected void addError(DefaultDataSet ds,
                        String errorDesc,
                        int lineNo,
                        int errorLevel,
                        String lineData,
                        String lastColName,
                        String lastColValue)
```
    Adds a new error to this DataSet. These can be collected, and retrieved after processing
    
    Parameters:
    
    ds - the data set from the parser
    
    errorDesc - String description of error
    
    lineNo - line number error occurred on
    
    errorLevel - errorLevel 1,2,3 1=warning 2=error 3= severe error'
    
    lineData - Data of the line which failed the parse
    
    lastColName - Column name which was the last one parsed successfully (in case of too few col)
    
    lastColValue - value of the last Column
  - getDataSourceReader
```
protected Reader getDataSourceReader()
```
    Returns:
    
    the dataSourceReader
  - setDataSourceReader
```
protected void setDataSourceReader(Reader dataSourceReader)
```
    Parameters:
    
    dataSourceReader - the dataSourceReader to set
  - isColumnNamesCaseSensitive
```
public boolean isColumnNamesCaseSensitive()
```
    Description copied from interface: Parser
    
    Default is false
    
    Specified by:
    
    isColumnNamesCaseSensitive in interface Parser
    
    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
```
public Parser setColumnNamesCaseSensitive(boolean columnNamesCaseSensitive)
```
    Description copied from interface: Parser
    
    Default is false
    
    Specified by:
    
    setColumnNamesCaseSensitive in interface Parser
    
    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
```
public boolean isIgnoreParseWarnings()
```
    Description copied from interface: Parser
    
    Default is false
    
    Specified by:
    
    isIgnoreParseWarnings in interface Parser
    
    Returns:
    
    true, warnings encountered during parsing will not be included in the DataSet errors
  - setIgnoreParseWarnings
```
public Parser setIgnoreParseWarnings(boolean ignoreParseWarnings)
```
    Specified by:
    
    setIgnoreParseWarnings in interface Parser
    
    Parameters:
    
    ignoreParseWarnings - when true, warnings encountered during parsing will not be included in the DataSet errors
    
    Returns:
    
    the Parser
  - isNullEmptyStrings
```
public boolean isNullEmptyStrings()
```
    Specified by:
    
    isNullEmptyStrings in interface Parser
    
    Returns:
    
    true, empty Strings will get returned as NULL when calling DataSet.getString()
  - setNullEmptyStrings
```
public Parser setNullEmptyStrings(boolean nullEmptyStrings)
```
    Specified by:
    
    setNullEmptyStrings in interface Parser
    
    Parameters:
    
    nullEmptyStrings - when true, empty Strings will get returned as NULL when calling DataSet.getString()
    
    Returns:
    
    the Parser
  - getPzMetaData
```
public MetaData getPzMetaData()
```
  - setPzMetaData
```
public void setPzMetaData(MetaData pzMap)
```
  - isFlagEmptyRows
```
public boolean isFlagEmptyRows()
```
    Specified by:
    
    isFlagEmptyRows in interface Parser
    
    Returns:
    
    the flagEmptyRows
  - setFlagEmptyRows
```
public Parser setFlagEmptyRows(boolean flagEmptyRows)
```
    Description copied from interface: Parser
    
    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.
    
    Specified by:
    
    setFlagEmptyRows in interface Parser
    
    Parameters:
    
    flagEmptyRows - the flagEmptyRows to set
    
    Returns:
    
    the Parser
  - isStoreRawDataToDataError
```
public boolean isStoreRawDataToDataError()
```
    Specified by:
    
    isStoreRawDataToDataError in interface Parser
    
    Returns:
    
    the storeRawDataToDataError
  - setStoreRawDataToDataError
```
public Parser setStoreRawDataToDataError(boolean storeRawDataToDataError)
```
    Description copied from interface: Parser
    
    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.
    
    Specified by:
    
    setStoreRawDataToDataError in interface Parser
    
    Parameters:
    
    storeRawDataToDataError - the storeRawDataToDataError to set
    
    Returns:
    
    the Parser
  - isStoreRawDataToDataSet
```
public boolean isStoreRawDataToDataSet()
```
    Specified by:
    
    isStoreRawDataToDataSet in interface Parser
    
    Returns:
    
    the storeRawDataToDataSet
  - setStoreRawDataToDataSet
```
public Parser setStoreRawDataToDataSet(boolean storeRawDataToDataSet)
```
    Description copied from interface: Parser
    
    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.
    
    Specified by:
    
    setStoreRawDataToDataSet in interface Parser
    
    Parameters:
    
    storeRawDataToDataSet - the storeRawDataToDataSet to set
    
    Returns:
    
    the Parser
  - getDataFileTable
```
public String getDataFileTable()
```
    Description copied from interface: Parser
    
    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.
    
    Specified by:
    
    getDataFileTable in interface Parser
    
    Returns:
    
    the DATAFILE table name
  - setDataFileTable
```
public Parser setDataFileTable(String dataFileTable)
```
    Description copied from interface: Parser
    
    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.
    
    Specified by:
    
    setDataFileTable in interface Parser
    
    Parameters:
    
    dataFileTable - Name of the table name to use in place of "DATAFILE"
    
    Returns:
    
    the Parser
  - getDataStructureTable
```
public String getDataStructureTable()
```
    Description copied from interface: Parser
    
    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.
    
    Specified by:
    
    getDataStructureTable in interface Parser
    
    Returns:
    
    the DATASTRUCTURE table name
  - setDataStructureTable
```
public Parser setDataStructureTable(String dataStructureTable)
```
    Description copied from interface: Parser
    
    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.
    
    Specified by:
    
    setDataStructureTable in interface Parser
    
    Parameters:
    
    dataStructureTable - Name of the table name to us in placfe of "DATASTRUCTURE"
    
    Returns:
    
    the Parser

Class AbstractParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractParser

AbstractParser

Method Detail

isAddSuffixToDuplicateColumnNames

setAddSuffixToDuplicateColumnNames

initStreamOrSource

isHandlingShortLines

setHandlingShortLines

isIgnoreExtraColumns

setIgnoreExtraColumns

isPreserveLeadingWhitespace

setPreserveLeadingWhitespace

isPreserveTrailingWhitespace

setPreserveTrailingWhitespace

parse

parseAsStream

stream

doParse

init

closeReaders

addToCloseReaderList

addToMetaData

isInitialised

setInitialised

getDataDefinition

setDataDefinition

addError

addError

getDataSourceReader

setDataSourceReader

isColumnNamesCaseSensitive

setColumnNamesCaseSensitive

isIgnoreParseWarnings

setIgnoreParseWarnings

isNullEmptyStrings

setNullEmptyStrings

getPzMetaData

setPzMetaData

isFlagEmptyRows

setFlagEmptyRows

isStoreRawDataToDataError

setStoreRawDataToDataError

isStoreRawDataToDataSet

setStoreRawDataToDataSet

getDataFileTable

setDataFileTable

getDataStructureTable

setDataStructureTable