univocity-parsers 2.9.1 · com.univocity.parsers.common.ParserOutput

The ParserOutput is the component that manages records parsed by AbstractParser and their values. It is solely responsible for deciding when:

parsed records should be reordered according to the fields selected in CommonSettings
characters and values parsed in AbstractParser#parseRecord() should be retained or discarded
input headers should be loaded from the records parsed in AbstractParser#parseRecord() or from CommonSettings#getHeaders()

Implementations of this class are made available to concrete parser implementations of AbstractParser.

Field Summary

Modifier and Type	Field and Description
public CharAppender	appender The appender available to parsers for accumulating characters read from the input.
private final CharAppender	appenderInstance
private final CharAppender[]	appenders Stores (shared) references to `CharAppender` for each potential column (as given by `CommonSettings#getMaxColumns()`).
protected int	column Keeps track of the current column being parsed in the input.
private boolean	columnReorderingEnabledSetting
private boolean	columnsReordered
private boolean	columnsToExtractInitialized
private long	currentRecord
private NormalizedString[]	headers
private String[]	headerStrings
private final String	nullValue
pack-priv String[]	parsedHeaders Headers parsed from the input when `CommonParserSettings#headerExtractionEnabled` is `true`, irrespective of any user-provided headers in `CommonParserSettings#getHeaders()`
protected final String[]	parsedValues Stores the values parsed for a record.
private final AbstractParser<?>	parser
public final Deque<String[]>	pendingRecords
private int[]	selectedIndexes
protected final CommonParserSettings<?>	settings
private final boolean	skipEmptyLines
public boolean	trim

Constructor Summary

Access	Constructor and Description
public	ParserOutput(CommonParserSettings<?> the parser configuration settings) Initializes the ParserOutput with the configuration specified in `CommonParserSettings`
public	ParserOutput(AbstractParser<?> the parser whose output will be managed by this class. parser, CommonParserSettings<?> the parser configuration settings) Initializes the ParserOutput with the configuration specified in `CommonParserSettings`

Method Summary

Modifier and Type	Method and Description
public final void	discardValues() Discards the values parsed so far
public void	emptyParsed() Adds a nullValue (as specified in `CommonSettings#getNullValue()`) to the output and prepares the next position in the record to receive more values.
public int	Returns: the position of the current parsed value getCurrentColumn() Returns the position of the current parsed value
public long	Returns: the current record index. getCurrentRecord() Returns the current record index.
pack-priv FieldSelector	getFieldSelector()
public String[]	getHeaderAsStringArray()
public NormalizedString[]	Returns: the headers each field in the input getHeaders() Returns the sequence of values that represent the headers each field in the input.
public int[]	Returns: the selected indexes of all fields as defined in `CommonSettings`. Null if no fields were selected. getSelectedIndexes() Returns the selected indexes of all fields as defined in `CommonSettings`.
private void	initializeColumnsToExtract(NormalizedString[] a sequence of values that represent the headers of the input. This can be either a parsed record or the headers as defined in `CommonSettings#getHeaders()` values) Initializes the sequence of selected fields, if any.
protected void	initializeHeaders()
public boolean	Returns: false if no fields were selected or column reordering has been disabled in `CommonParserSettings#isColumnReorderingEnabled()` true if fields were selected and column reordering has been enabled in `CommonParserSettings#isColumnReorderingEnabled()` isColumnReorderingEnabled() Indicates whether fields selected using the field selection methods (in `CommonSettings`) are being reordered.
pack-priv final void	reset() Resets the parser output and prepares for a new parsing process.
public String[]	Returns: the sequence of parsed values in a record. rowParsed() Gets all values parsed in the `ParserOutput#parsedValues` array
public void	valueParsed() Adds the accumulated value in the appender object to the output and prepares the next position in the record to receive more values.
public void	valueParsed(String the value to be added to the current record position. value) Adds a value processed externally to the output and prepares the next position in the record to receive more values

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

appender back to summary

appender	back to summary
public CharAppender appender The appender available to parsers for accumulating characters read from the input. This attribute is assigned to different instances of CharAppender during parsing process, namely, a (potentially) different CharAppender for each parsed column, taken from `ParserOutput#appenders`[`ParserOutput#column`]

public CharAppender appender

The appender available to parsers for accumulating characters read from the input.

This attribute is assigned to different instances of CharAppender during parsing process, namely, a (potentially) different CharAppender for each parsed column, taken from ParserOutput#appenders[ParserOutput#column]

appenderInstance	back to summary
private final CharAppender appenderInstance

appenders back to summary

appenders	back to summary
private final CharAppender[] appenders Stores (shared) references to `CharAppender` for each potential column (as given by `CommonSettings#getMaxColumns()`). Fields that are not selected will receive an instance of `NoopCharAppender` so all parser calls in `AbstractParser#parseRecord()` to `ParserOutput#appender` will do nothing. Selected fields (given by `CommonParserSettings`) will receive a functional `CharAppender`.

private final CharAppender[] appenders

Stores (shared) references to CharAppender for each potential column (as given by CommonSettings#getMaxColumns()).

Fields that are not selected will receive an instance of NoopCharAppender so all parser calls in AbstractParser#parseRecord() to ParserOutput#appender will do nothing.

Selected fields (given by CommonParserSettings) will receive a functional CharAppender.

column	back to summary
protected int column Keeps track of the current column being parsed in the input. Calls to `ParserOutput#valueParsed` and `ParserOutput#emptyParsed` will increase the column count. This value is reset to zero after a row is parsed.

columnReorderingEnabledSetting	back to summary
private boolean columnReorderingEnabledSetting

columnsReordered	back to summary
private boolean columnsReordered

columnsToExtractInitialized	back to summary
private boolean columnsToExtractInitialized

currentRecord	back to summary
private long currentRecord

headers	back to summary
private NormalizedString[] headers

headerStrings	back to summary
private String[] headerStrings

nullValue	back to summary
private final String nullValue

parsedHeaders	back to summary
pack-priv String[] parsedHeaders Headers parsed from the input when `CommonParserSettings#headerExtractionEnabled` is `true`, irrespective of any user-provided headers in `CommonParserSettings#getHeaders()`

parsedValues	back to summary
protected final String[] parsedValues Stores the values parsed for a record.

parser	back to summary
private final AbstractParser<?> parser

pendingRecords	back to summary
public final Deque<String[]> pendingRecords

selectedIndexes	back to summary
private int[] selectedIndexes

settings	back to summary
protected final CommonParserSettings<?> settings

skipEmptyLines	back to summary
private final boolean skipEmptyLines

trim	back to summary
public boolean trim

Constructor Detail

ParserOutput back to summary

ParserOutput	back to summary
public ParserOutput(CommonParserSettings<?> settings) Initializes the ParserOutput with the configuration specified in `CommonParserSettings` Parameters settings:CommonParserSettings<?> the parser configuration

public ParserOutput(CommonParserSettings<?> settings)

Initializes the ParserOutput with the configuration specified in CommonParserSettings

Parameters

settings:CommonParserSettings<?>: the parser configuration

ParserOutput back to summary

ParserOutput	back to summary
public ParserOutput(AbstractParser<?> parser, CommonParserSettings<?> settings) Initializes the ParserOutput with the configuration specified in `CommonParserSettings` Parameters parser:AbstractParser<?> the parser whose output will be managed by this class. settings:CommonParserSettings<?> the parser configuration

public ParserOutput(AbstractParser<?> parser, CommonParserSettings<?> settings)

Initializes the ParserOutput with the configuration specified in CommonParserSettings

Parameters

parser:AbstractParser<?>: the parser whose output will be managed by this class.
settings:CommonParserSettings<?>: the parser configuration

Method Detail

discardValues	back to summary
public final void discardValues() Discards the values parsed so far

emptyParsed	back to summary
public void emptyParsed() Adds a nullValue (as specified in `CommonSettings#getNullValue()`) to the output and prepares the next position in the record to receive more values.

getCurrentColumn	back to summary
public int getCurrentColumn() Returns the position of the current parsed value Returns:int the position of the current parsed value

getCurrentColumn

back to summary

public int getCurrentColumn()

Returns the position of the current parsed value

Returns:int: the position of the current parsed value

getCurrentRecord back to summary

getCurrentRecord	back to summary
public long getCurrentRecord() Returns the current record index. The number returned here reflects the number of actually parsed and valid records sent to the output of `ParserOutput#rowParsed`. Returns:long the current record index.

public long getCurrentRecord()

Returns the current record index. The number returned here reflects the number of actually parsed and valid records sent to the output of ParserOutput#rowParsed.

Returns:long: the current record index.

getFieldSelector	back to summary
pack-priv FieldSelector getFieldSelector()

getHeaderAsStringArray	back to summary
public String[] getHeaderAsStringArray()

getHeaders back to summary

getHeaders	back to summary
public NormalizedString[] getHeaders() Returns the sequence of values that represent the headers each field in the input. This can be either a parsed record or the headers as defined in `CommonSettings#getHeaders()` Returns:NormalizedString[] the headers each field in the input

public NormalizedString[] getHeaders()

Returns the sequence of values that represent the headers each field in the input. This can be either a parsed record or the headers as defined in CommonSettings#getHeaders()

Returns:NormalizedString[]: the headers each field in the input

getSelectedIndexes back to summary

getSelectedIndexes	back to summary
public int[] getSelectedIndexes() Returns the selected indexes of all fields as defined in `CommonSettings`. Null if no fields were selected. Returns:int[] the selected indexes of all fields as defined in `CommonSettings`. Null if no fields were selected.

public int[] getSelectedIndexes()

Returns the selected indexes of all fields as defined in CommonSettings. Null if no fields were selected.

Returns:int[]: the selected indexes of all fields as defined in CommonSettings. Null if no fields were selected.

initializeColumnsToExtract back to summary

initializeColumnsToExtract	back to summary
private void initializeColumnsToExtract(NormalizedString[] values) Initializes the sequence of selected fields, if any. Parameters values:NormalizedString[] a sequence of values that represent the headers of the input. This can be either a parsed record or the headers as defined in `CommonSettings#getHeaders()`

private void initializeColumnsToExtract(NormalizedString[] values)

Initializes the sequence of selected fields, if any.

Parameters

values:NormalizedString[]: a sequence of values that represent the headers of the input. This can be either a parsed record or the headers as defined in CommonSettings#getHeaders()

initializeHeaders	back to summary
protected void initializeHeaders()

isColumnReorderingEnabled back to summary

isColumnReorderingEnabled	back to summary
public boolean isColumnReorderingEnabled() Indicates whether fields selected using the field selection methods (in `CommonSettings`) are being reordered. Returns:boolean false if no fields were selected or column reordering has been disabled in `CommonParserSettings#isColumnReorderingEnabled()` true if fields were selected and column reordering has been enabled in `CommonParserSettings#isColumnReorderingEnabled()`

public boolean isColumnReorderingEnabled()

Indicates whether fields selected using the field selection methods (in CommonSettings) are being reordered.

Returns:boolean

false if no fields were selected or column reordering has been disabled in CommonParserSettings#isColumnReorderingEnabled()

true if fields were selected and column reordering has been enabled in CommonParserSettings#isColumnReorderingEnabled()

reset	back to summary
pack-priv final void reset() Resets the parser output and prepares for a new parsing process.

rowParsed back to summary

rowParsed	back to summary
public String[] rowParsed() Gets all values parsed in the `ParserOutput#parsedValues` array Returns:String[] the sequence of parsed values in a record.

public String[] rowParsed()

Gets all values parsed in the ParserOutput#parsedValues array

Returns:String[]: the sequence of parsed values in a record.

valueParsed	back to summary
public void valueParsed() Adds the accumulated value in the appender object to the output and prepares the next position in the record to receive more values.

valueParsed	back to summary
public void valueParsed(String value) Adds a value processed externally to the output and prepares the next position in the record to receive more values Parameters value:String the value to be added to the current record position.

valueParsed

back to summary

public void valueParsed(String value)

Adds a value processed externally to the output and prepares the next position in the record to receive more values

Parameters

value:String: the value to be added to the current record position.

public Class ParserOutput

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail