com.univocity.parsers.common.processor.core
Class AbstractObjectColumnProcessor<T extends Context>

java.lang.Object
  com.univocity.parsers.common.DefaultConversionProcessor
      com.univocity.parsers.common.processor.core.AbstractObjectProcessor<T>
          com.univocity.parsers.common.processor.core.AbstractObjectColumnProcessor<T>

All Implemented Interfaces:

ConversionProcessor, Processor<T>

Direct Known Subclasses:

ObjectColumnProcessor

public abstract class AbstractObjectColumnProcessor<T extends Context>
extends AbstractObjectProcessor<T>

A Processor implementation for converting rows extracted from any implementation of AbstractParser into columns of objects.

This uses the value conversions provided by Conversion instances.

For each row processed, a sequence of conversions will be executed to generate the appropriate object. Each resulting object will then be stored in a list that contains the values of the corresponding column.

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 AbstractBatchedObjectColumnProcessor instead

Author:

uniVocity Software Pty Ltd - parsers@univocity.com

See Also:

AbstractParser, Processor, ColumnReader, Conversion, AbstractObjectProcessor

Constructor Summary

AbstractObjectColumnProcessor()
Constructs a column processor, pre-allocating room for 1000 rows.

AbstractObjectColumnProcessor(int expectedRowCount)
Constructs a column processor pre-allocating room for the expected number of rows to be processed

Method Summary

List<Object>	getColumn(int columnIndex) Returns the values of a given column.
<V> List<V>	getColumn(int columnIndex, Class<V> columnType) Returns the values of a given column.
List<Object>	getColumn(String columnName) Returns the values of a given column.
<V> List<V>	getColumn(String columnName, Class<V> columnType) Returns the values of a given column.
List<List<Object>>	getColumnValuesAsList() Returns the values processed for each column
Map<Integer,List<Object>>	getColumnValuesAsMapOfIndexes() Returns a map of column indexes and their respective list of values parsed from the input.
Map<String,List<Object>>	getColumnValuesAsMapOfNames() Returns a map of column names and their respective list of values parsed from the input.
String[]	getHeaders() Returns the column headers.
void	processStarted(T context) This method will by invoked by the parser once, when it is ready to start processing the input.
void	putColumnValuesInMapOfIndexes(Map<Integer,List<Object>> map) Fills a given map associating each column index to its list of values
void	putColumnValuesInMapOfNames(Map<String,List<Object>> map) Fills a given map associating each column name to its list o values
void	rowProcessed(Object[] row, T context) Invoked by the processor after all values of a valid record have been processed and converted into an Object array.

Methods inherited from class com.univocity.parsers.common.processor.core.AbstractObjectProcessor

processEnded, rowProcessed

Methods inherited from class com.univocity.parsers.common.DefaultConversionProcessor

applyConversions, convertAll, convertFields, convertIndexes, convertType, handleConversionError, initializeConversions, reverseConversions, toDataProcessingException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractObjectColumnProcessor

public AbstractObjectColumnProcessor()

Constructs a column processor, pre-allocating room for 1000 rows.

AbstractObjectColumnProcessor

public AbstractObjectColumnProcessor(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 Detail

getHeaders

public final String[] getHeaders()

Returns the column headers. This can be either the headers defined in CommonSettings.getHeaders() or the headers parsed in the input when CommonSettings.getHeaders() equals to true

Returns:

the headers of all column parsed.

getColumnValuesAsList

public final List<List<Object>> getColumnValuesAsList()

Returns the values processed for each column

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

public final void putColumnValuesInMapOfNames(Map<String,List<Object>> map)

Fills a given map associating each column name to its list o values

Parameters:

map - the map to hold the values of each column

putColumnValuesInMapOfIndexes

public final void putColumnValuesInMapOfIndexes(Map<Integer,List<Object>> map)

Fills a given map associating each column index to its list of values

Parameters:

map - the map to hold the values of each column

getColumnValuesAsMapOfNames

public final Map<String,List<Object>> getColumnValuesAsMapOfNames()

Returns a map of column names and their respective list of values parsed from the input.

Returns:

a map of column names and their respective list of values.

getColumnValuesAsMapOfIndexes

public final Map<Integer,List<Object>> getColumnValuesAsMapOfIndexes()

Returns a map of column indexes and their respective list of values parsed from the input.

Returns:

a map of column indexes and their respective list of values.

rowProcessed

public void rowProcessed(Object[] row,
                         T context)

Description copied from class: AbstractObjectProcessor

Invoked by the processor after all values of a valid record have been processed and converted into an Object array.

Specified by:

rowProcessed in class AbstractObjectProcessor<T extends Context>

Parameters:

row - object array created with the information extracted by the parser and then converted.

context - A contextual object with information and controls over the current state of the parsing process

processStarted

public void processStarted(T context)

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 interface Processor<T extends Context>

Overrides:

processStarted in class AbstractObjectProcessor<T extends Context>

Parameters:

context - A contextual object with information and controls over the current state of the parsing process

getColumn

public <V> List<V> getColumn(String columnName,
                             Class<V> columnType)

Returns the values of a given column.

Type Parameters:

V - the type of data in that column

Parameters:

columnName - the name of the column in the input.

columnType - the type of data in that column

Returns:

a list with all data stored in the given column

getColumn

public <V> List<V> getColumn(int columnIndex,
                             Class<V> columnType)

Returns the values of a given column.

Type Parameters:

V - the type of data in that column

Parameters:

columnIndex - the position of the column in the input (0-based).

columnType - the type of data in that column

Returns:

a list with all data stored in the given column

getColumn

public List<Object> getColumn(String columnName)

Returns the values of a given column.

Parameters:

columnName - the name of the column in the input.

Returns:

a list with all data stored in the given column

getColumn

public List<Object> getColumn(int columnIndex)

Returns the values of a given column.

Parameters:

columnIndex - the position of the column in the input (0-based).

Returns:

a list with all data stored in the given column