com.univocity.parsers.common.processor.BatchedObjectColumnProcessor Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2014 Univocity Software Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************/
package com.univocity.parsers.common.processor;
import com.univocity.parsers.common.*;
import com.univocity.parsers.common.processor.core.*;
import com.univocity.parsers.conversions.*;
/**
*
* A {@link RowProcessor} implementation for converting batches of rows extracted from any implementation of {@link AbstractParser} into columns of objects.
* This uses the value conversions provided by {@link 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 {@link #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 {@link #getColumnValuesAsList()},
* {@link #getColumnValuesAsMapOfIndexes()} and {@link #getColumnValuesAsMapOfNames()}.
* After {@link #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.
*
* @see AbstractParser
* @see RowProcessor
* @see AbstractBatchedColumnProcessor
* @see Conversion
*
* @author Univocity Software Pty Ltd - [email protected]
*
*/
public abstract class BatchedObjectColumnProcessor extends AbstractBatchedObjectColumnProcessor implements RowProcessor {
/**
* Constructs a batched column processor configured to invoke the {@link #batchesProcessed} method after a given number of rows has been processed.
* @param rowsPerBatch the number of rows to process in each batch.
*/
public BatchedObjectColumnProcessor(int rowsPerBatch) {
super(rowsPerBatch);
}
}