Class AbstractBatchedObjectColumnProcessor<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.AbstractBatchedObjectColumnProcessor<T>
-
- All Implemented Interfaces:
ConversionProcessor
,Processor<T>
- Direct Known Subclasses:
BatchedObjectColumnProcessor
public abstract class AbstractBatchedObjectColumnProcessor<T extends Context> extends AbstractObjectProcessor<T> implements Processor<T>
AProcessor
implementation for converting batches of rows extracted from any implementation ofAbstractParser
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.
During the execution of the process, the
batchProcessed(int)
method will be invoked after a given number of rows has been processed.The user can access the lists with values parsed for all columns using the methods
getColumnValuesAsList()
,getColumnValuesAsMapOfIndexes()
andgetColumnValuesAsMapOfNames()
.After
batchProcessed(int)
is invoked, all values will be discarded and the next batch of column values will be accumulated. This process will repeat until there's no more rows in the input.- Author:
- Univocity Software Pty Ltd - parsers@univocity.com
- See Also:
AbstractParser
,Processor
,BatchedColumnReader
,Conversion
,AbstractObjectProcessor
-
-
Field Summary
-
Fields inherited from class com.univocity.parsers.common.DefaultConversionProcessor
conversions
-
-
Constructor Summary
Constructors Constructor Description AbstractBatchedObjectColumnProcessor(int rowsPerBatch)
Constructs a abstract batched column processor configured to invoke thebatchesProcessed
method after a given number of rows has been processed.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
batchProcessed(int rowsInThisBatch)
int
getBatchesProcessed()
java.util.List<java.lang.Object>
getColumn(int columnIndex)
<V> java.util.List<V>
getColumn(int columnIndex, java.lang.Class<V> columnType)
Returns the values of a given column.java.util.List<java.lang.Object>
getColumn(java.lang.String columnName)
<V> java.util.List<V>
getColumn(java.lang.String columnName, java.lang.Class<V> columnType)
Returns the values of a given column.java.util.List<java.util.List<java.lang.Object>>
getColumnValuesAsList()
java.util.Map<java.lang.Integer,java.util.List<java.lang.Object>>
getColumnValuesAsMapOfIndexes()
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>
getColumnValuesAsMapOfNames()
java.lang.String[]
getHeaders()
int
getRowsPerBatch()
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.void
putColumnValuesInMapOfIndexes(java.util.Map<java.lang.Integer,java.util.List<java.lang.Object>> map)
void
putColumnValuesInMapOfNames(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> map)
void
rowProcessed(java.lang.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
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
-
Methods inherited from interface com.univocity.parsers.common.processor.core.Processor
rowProcessed
-
-
-
-
Constructor Detail
-
AbstractBatchedObjectColumnProcessor
public AbstractBatchedObjectColumnProcessor(int rowsPerBatch)
Constructs a abstract batched column processor configured to invoke thebatchesProcessed
method after a given number of rows has been processed.- Parameters:
rowsPerBatch
- the number of rows to process in each batch.
-
-
Method Detail
-
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 interfaceProcessor<T extends Context>
- Overrides:
processStarted
in classAbstractObjectProcessor<T extends Context>
- Parameters:
context
- A contextual object with information and controls over the current state of the parsing process
-
rowProcessed
public void rowProcessed(java.lang.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 classAbstractObjectProcessor<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
-
processEnded
public void processEnded(T context)
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>
- Overrides:
processEnded
in classAbstractObjectProcessor<T extends Context>
- Parameters:
context
- A contextual object with information and controls over the state of the parsing process
-
getHeaders
public final java.lang.String[] getHeaders()
-
getColumnValuesAsList
public final java.util.List<java.util.List<java.lang.Object>> getColumnValuesAsList()
-
putColumnValuesInMapOfNames
public final void putColumnValuesInMapOfNames(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> map)
-
putColumnValuesInMapOfIndexes
public final void putColumnValuesInMapOfIndexes(java.util.Map<java.lang.Integer,java.util.List<java.lang.Object>> map)
-
getColumnValuesAsMapOfNames
public final java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getColumnValuesAsMapOfNames()
-
getColumnValuesAsMapOfIndexes
public final java.util.Map<java.lang.Integer,java.util.List<java.lang.Object>> getColumnValuesAsMapOfIndexes()
-
getColumn
public java.util.List<java.lang.Object> getColumn(java.lang.String columnName)
-
getColumn
public java.util.List<java.lang.Object> getColumn(int columnIndex)
-
getColumn
public <V> java.util.List<V> getColumn(java.lang.String columnName, java.lang.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> java.util.List<V> getColumn(int columnIndex, java.lang.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
-
getRowsPerBatch
public int getRowsPerBatch()
-
getBatchesProcessed
public int getBatchesProcessed()
-
batchProcessed
public abstract void batchProcessed(int rowsInThisBatch)
-
-