Class AbstractBatchedColumnProcessor<T extends Context>
- java.lang.Object
-
- com.univocity.parsers.common.processor.core.AbstractBatchedColumnProcessor<T>
-
- All Implemented Interfaces:
Processor<T>
- Direct Known Subclasses:
BatchedColumnProcessor
public abstract class AbstractBatchedColumnProcessor<T extends Context> extends java.lang.Object implements Processor<T>
AProcessor
implementation that stores values of columns in batches. Use this implementation in favor ofAbstractColumnProcessor
when processing large inputs to avoid running out of memory. Values parsed in each row will be split into columns of Strings. Each column has its own list of values.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
,BatchedColumnReader
,Processor
-
-
Constructor Summary
Constructors Constructor Description AbstractBatchedColumnProcessor(int rowsPerBatch)
Constructs a 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.String>
getColumn(int columnIndex)
java.util.List<java.lang.String>
getColumn(java.lang.String columnName)
java.util.List<java.util.List<java.lang.String>>
getColumnValuesAsList()
java.util.Map<java.lang.Integer,java.util.List<java.lang.String>>
getColumnValuesAsMapOfIndexes()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>
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.String>> map)
void
putColumnValuesInMapOfNames(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)
void
rowProcessed(java.lang.String[] row, T context)
Invoked by the parser after all values of a valid record have been processed.
-
-
-
Constructor Detail
-
AbstractBatchedColumnProcessor
public AbstractBatchedColumnProcessor(int rowsPerBatch)
Constructs a 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>
- Parameters:
context
- A contextual object with information and controls over the current state of the parsing process
-
rowProcessed
public void rowProcessed(java.lang.String[] row, T context)
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
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>
- 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.String>> getColumnValuesAsList()
-
putColumnValuesInMapOfNames
public final void putColumnValuesInMapOfNames(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)
-
putColumnValuesInMapOfIndexes
public final void putColumnValuesInMapOfIndexes(java.util.Map<java.lang.Integer,java.util.List<java.lang.String>> map)
-
getColumnValuesAsMapOfNames
public final java.util.Map<java.lang.String,java.util.List<java.lang.String>> getColumnValuesAsMapOfNames()
-
getColumnValuesAsMapOfIndexes
public final java.util.Map<java.lang.Integer,java.util.List<java.lang.String>> getColumnValuesAsMapOfIndexes()
-
getColumn
public java.util.List<java.lang.String> getColumn(java.lang.String columnName)
-
getColumn
public java.util.List<java.lang.String> getColumn(int columnIndex)
-
getRowsPerBatch
public int getRowsPerBatch()
-
getBatchesProcessed
public int getBatchesProcessed()
-
batchProcessed
public abstract void batchProcessed(int rowsInThisBatch)
-
-