com.univocity.parsers.common.processor.RowProcessor Maven / Gradle / Ivy
Show all versions of univocity-parsers Show documentation
/*******************************************************************************
* 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.*;
/**
* The essential callback interface to handle records parsed by any parser that extends {@link AbstractParser}.
*
* When parsing an input, uniVocity-parsers will obtain the RowProcessor from {@link CommonParserSettings#getRowProcessor()}, and
* delegate each parsed row to {@link RowProcessor#rowProcessed(String[], ParsingContext)}.
*
*
Before parsing the first row, the parser will invoke the {@link RowProcessor#processStarted(ParsingContext)} method.
* By this time the input buffer will be already loaded and ready to be consumed.
*
*
After parsing the last row, all resources are closed and the processing stops. Only after the {@link RowProcessor#processEnded(ParsingContext)} is called so you
* can perform any additional housekeeping you might need.
*
*
More control and information over the parsing process are provided by the {@link ParsingContext} object.
*
*
uniVocity-parsers provides many useful default implementations of this interface in the package {@link com.univocity.parsers.common.processor}, namely:
*
*
* - {@link RowListProcessor}: convenience class for storing the processed rows into a list.
* - {@link ObjectRowProcessor}: used for processing rows and executing conversions of parsed values to objects using instances of {@link Conversion}
* - {@link ObjectRowListProcessor}: convenience class for rows of converted objects using {@link ObjectRowProcessor} into a list.
* - {@link MasterDetailProcessor}: used for reading inputs where records are organized in a master-detail fashion (with a master element that contains a list of associated elements)
* - {@link MasterDetailListProcessor}: convenience class for storing {@link MasterDetailRecord} created by instances created by {@link MasterDetailProcessor} into a list
* - {@link BeanProcessor}: used for automatically create and populate javabeans annotated with the annotations provided in package {@link com.univocity.parsers.annotations}
* - {@link BeanListProcessor}: convenience class for storing all javabeans created by {@link BeanProcessor} into a list
*
*
* @see com.univocity.parsers.common.AbstractParser
* @see com.univocity.parsers.common.CommonParserSettings
* @see com.univocity.parsers.common.ParsingContext
*
* @author uniVocity Software Pty Ltd - [email protected]
*
*/
public interface RowProcessor extends Processor {
/**
* This method will by invoked by the parser once, when it is ready to start processing the input.
*
* @param context A contextual object with information and controls over the current state of the parsing process
*/
void processStarted(ParsingContext context);
/**
* Invoked by the parser after all values of a valid record have been processed.
*
* @param 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 {@link CommonSettings#setSkipEmptyLines(boolean)}
* - it won't contain lines identified by the parser as comments. To disable comment processing set {@link Format#setComment(char)} to '\0'
*
* @param context A contextual object with information and controls over the current state of the parsing process
*/
void rowProcessed(String[] row, ParsingContext context);
/**
* 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 {@link ParsingContext#stop()}.
*
* @param context A contextual object with information and controls over the state of the parsing process
*/
void processEnded(ParsingContext context);
}