AbstractBatchedObjectColumnProcessor (univocity-parsers 2.9.1 API)

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>
```
A Processor implementation for converting batches of 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.

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() and getColumnValuesAsMapOfNames().

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 and Description
`AbstractBatchedObjectColumnProcessor(int rowsPerBatch)` Constructs a abstract batched column processor configured to invoke the `batchesProcessed` method after a given number of rows has been processed.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`batchProcessed(int rowsInThisBatch)` Callback to the user, where the lists with values parsed for all columns can be accessed using the methods `getColumnValuesAsList()`, `getColumnValuesAsMapOfIndexes()` and `getColumnValuesAsMapOfNames()`.
`int`	`getBatchesProcessed()` Returns the number of batches already processed
`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.
`int`	`getRowsPerBatch()` Returns the number of rows processed in each batch
`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(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
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 the batchesProcessed 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 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
  - 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
  - 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 interface Processor<T extends Context>
    
    Overrides:
    
    processEnded in class AbstractObjectProcessor<T extends Context>
    
    Parameters:
    
    context - A contextual object with information and controls over the state of the parsing process
  - 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.
  - 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
  - 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
  - getRowsPerBatch
```
public int getRowsPerBatch()
```
    Returns the number of rows processed in each batch
    
    Returns:
    
    the number of rows per batch
  - getBatchesProcessed
```
public int getBatchesProcessed()
```
    Returns the number of batches already processed
    
    Returns:
    
    the number of batches already processed
  - batchProcessed
```
public abstract void batchProcessed(int rowsInThisBatch)
```
    Callback to the user, where the lists with values parsed for all columns can be accessed using the methods getColumnValuesAsList(), getColumnValuesAsMapOfIndexes() and getColumnValuesAsMapOfNames().
    
    Parameters:
    
    rowsInThisBatch - the number of rows processed in the current batch. This corresponds to the number of elements of each list of each column.

Class AbstractBatchedObjectColumnProcessor<T extends Context>

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.univocity.parsers.common.processor.core.Processor

Constructor Detail

AbstractBatchedObjectColumnProcessor

Method Detail

processStarted

rowProcessed

processEnded

getHeaders

getColumnValuesAsList

putColumnValuesInMapOfNames

putColumnValuesInMapOfIndexes

getColumnValuesAsMapOfNames

getColumnValuesAsMapOfIndexes

getColumn

getColumn

getColumn

getColumn

getRowsPerBatch

getBatchesProcessed

batchProcessed