Class AbstractColumnProcessor<T extends Context>
java.lang.Object
com.univocity.parsers.common.processor.core.AbstractColumnProcessor<T>
- All Implemented Interfaces:
ColumnReader<String>
,Processor<T>
- Direct Known Subclasses:
ColumnProcessor
public abstract class AbstractColumnProcessor<T extends Context>
extends Object
implements Processor<T>, ColumnReader<String>
A simple
Processor
implementation that stores values of columns.
Values parsed in each row will be split into columns of Strings. Each column has its own list of values.
At the end of the process, the user can access the lists with values parsed for all columns using the methods getColumnValuesAsList()
,
getColumnValuesAsMapOfIndexes()
and getColumnValuesAsMapOfNames()
.
Note: Storing the values of all columns may be memory intensive. For large inputs, use a AbstractBatchedColumnProcessor
instead
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a column processor, pre-allocating room for 1000 rows.AbstractColumnProcessor
(int expectedRowCount) Constructs a column processor pre-allocating room for the expected number of rows to be processed -
Method Summary
Modifier and TypeMethodDescriptiongetColumn
(int columnIndex) Returns the values of a given column.Returns the values of a given column.Returns the values processed for each columnReturns a map of column indexes and their respective list of values parsed from the input.Returns a map of column names and their respective list of values parsed from the input.final String[]
Returns the column headers.void
processEnded
(T context) This method will by invoked by the parser once, after the parsing process stopped and all resources were closed.void
processStarted
(T context) This method will by invoked by the parser once, when it is ready to start processing the input.final void
Fills a given map associating each column index to its list of valuesfinal void
Fills a given map associating each column name to its list o valuesvoid
rowProcessed
(String[] row, T context) Invoked by the parser after all values of a valid record have been processed.
-
Field Details
-
splitter
-
-
Constructor Details
-
AbstractColumnProcessor
public AbstractColumnProcessor()Constructs a column processor, pre-allocating room for 1000 rows. -
AbstractColumnProcessor
public AbstractColumnProcessor(int expectedRowCount) Constructs a column processor pre-allocating room for the expected number of rows to be processed- Parameters:
expectedRowCount
- the expected number of rows to be processed
-
-
Method Details
-
processStarted
Description copied from interface:Processor
This method will by invoked by the parser once, when it is ready to start processing the input.- Specified by:
processStarted
in interfaceProcessor<T extends Context>
- Parameters:
context
- A contextual object with information and controls over the current state of the parsing process
-
rowProcessed
Description copied from interface:Processor
Invoked by the parser after all values of a valid record have been processed.- Specified by:
rowProcessed
in interfaceProcessor<T extends Context>
- Parameters:
row
- the data extracted by the parser for an individual record. Note that:- it will never by null.
- it will never be empty unless explicitly configured using
CommonSettings.setSkipEmptyLines(boolean)
- it won't contain lines identified by the parser as comments. To disable comment processing set
Format.setComment(char)
to '\0'
context
- A contextual object with information and controls over the current state of the parsing process
-
processEnded
Description copied from interface:Processor
This method will by invoked by the parser once, after the parsing process stopped and all resources were closed.It will always be called by the parser: in case of errors, if the end of the input us reached, or if the user stopped the process manually using
Context.stop()
.- Specified by:
processEnded
in interfaceProcessor<T extends Context>
- Parameters:
context
- A contextual object with information and controls over the state of the parsing process
-
getHeaders
Description copied from interface:ColumnReader
Returns the column headers. This can be either the headers defined inCommonSettings.getHeaders()
or the headers parsed in the input whenCommonSettings.getHeaders()
equals totrue
- Specified by:
getHeaders
in interfaceColumnReader<T extends Context>
- Returns:
- the headers of all column parsed.
-
getColumnValuesAsList
Description copied from interface:ColumnReader
Returns the values processed for each column- Specified by:
getColumnValuesAsList
in interfaceColumnReader<T extends Context>
- Returns:
- a list of lists. The stored lists correspond to the position of the column processed from the input; Each list contains the corresponding values parsed for a column, across multiple rows.
-
putColumnValuesInMapOfNames
Description copied from interface:ColumnReader
Fills a given map associating each column name to its list o values- Specified by:
putColumnValuesInMapOfNames
in interfaceColumnReader<T extends Context>
- Parameters:
map
- the map to hold the values of each column
-
putColumnValuesInMapOfIndexes
Description copied from interface:ColumnReader
Fills a given map associating each column index to its list of values- Specified by:
putColumnValuesInMapOfIndexes
in interfaceColumnReader<T extends Context>
- Parameters:
map
- the map to hold the values of each column
-
getColumnValuesAsMapOfNames
Description copied from interface:ColumnReader
Returns a map of column names and their respective list of values parsed from the input.- Specified by:
getColumnValuesAsMapOfNames
in interfaceColumnReader<T extends Context>
- Returns:
- a map of column names and their respective list of values.
-
getColumnValuesAsMapOfIndexes
Description copied from interface:ColumnReader
Returns a map of column indexes and their respective list of values parsed from the input.- Specified by:
getColumnValuesAsMapOfIndexes
in interfaceColumnReader<T extends Context>
- Returns:
- a map of column indexes and their respective list of values.
-
getColumn
Description copied from interface:ColumnReader
Returns the values of a given column.- Specified by:
getColumn
in interfaceColumnReader<T extends Context>
- Parameters:
columnName
- the name of the column in the input.- Returns:
- a list with all data stored in the given column
-
getColumn
Description copied from interface:ColumnReader
Returns the values of a given column.- Specified by:
getColumn
in interfaceColumnReader<T extends Context>
- Parameters:
columnIndex
- the position of the column in the input (0-based).- Returns:
- a list with all data stored in the given column
-