univocity-parsers 2.9.1 · com.univocity.parsers.common.DefaultConversionProcessor

Modifier and Type	Field and Description
pack-priv Context	context
protected FieldConversionMapping	conversions
private Map<Class<?>, Conversion<I, O>[]>	conversionsByType
private boolean	conversionsInitialized
pack-priv ProcessorErrorHandler<T extends Context>	errorHandler
private int[]	fieldIndexes
private boolean	fieldsReordered
private int[]	reverseFieldIndexes

Access	Constructor and Description
public	DefaultConversionProcessor()

Method Summary

Modifier and Type	Method and Description
public final Object[]	Returns: an row of Object instances containing the values obtained after the execution of all conversions. Fields that do not have any conversion defined will just be copied to the object array into their original positions. applyConversions(String[] the parsed record with its individual records as extracted from the original input. row, Context the current state of the parsing process. context) Executes the sequences of conversions defined using `DefaultConversionProcessor#convertFields(Conversion...)`, `DefaultConversionProcessor#convertIndexes(Conversion...)` and `DefaultConversionProcessor#convertAll(Conversion...)`, for every field in the given row.
private boolean	applyConversionsByType(boolean reverse, Object[] row, boolean[] convertedFlags)
private Object	applyTypeConversion(boolean revert, Object input)
public final void	convertAll(Conversion<I, O>... The sequence of conversions to be executed in all elements of a record conversions) Implements com.univocity.parsers.common.ConversionProcessor.convertAll. Applies a set of `Conversion` objects over all elements of a record
public final FieldSet<String>	convertFields(Conversion<I, O>... The sequence of conversions to be executed in a set of field indexes. conversions) Implements com.univocity.parsers.common.ConversionProcessor.convertFields. Applies a set of `Conversion` objects over fields of a record by name.
public final FieldSet<Integer>	convertIndexes(Conversion<I, O>... The sequence of conversions to be executed in a set of field indexes. conversions) Implements com.univocity.parsers.common.ConversionProcessor.convertIndexes. Applies a set of `Conversion` objects over indexes of a record.
public final void	convertType(Class<?> the type over which a sequence of conversions should be applied type, Conversion<I, O>... the sequence of conversions to apply over values of the given type. conversions) Implements com.univocity.parsers.common.ConversionProcessor.convertType. Applies a sequence of conversions over values of a given type.
private FieldConversionMapping	getConversions()
protected final boolean	Returns: `true` if the error has been handled by the user and the record can still be processed, otherwise `false` if the record should be discarded. handleConversionError(Throwable the exception that occurred when applying a conversion ex, Object[] the record being processed at the time the exception happened. row, int the column if the given row, whose value could not be converted. If negative, it's not possible to keep the record. column) Handles an error that occurred when applying conversions over a value.
protected void	initializeConversions(String[] row, Context context)
private void	populateReverseFieldIndexes()
public final boolean	Returns: `true` if the the row should be discarded reverseConversions(boolean flag to indicate whether the conversion sequence should be executed in the reverse order of its declaration. executeInReverseOrder, Object[] the row of objects that will be converted row, NormalizedString[] All field names used to produce records in a given destination. May be null if no headers have been defined in `CommonSettings#getHeaders()` headers, int[] The indexes of the headers that are actually being written. May be null if no fields have been selected using `CommonSettings#selectFields(String...)` or `CommonSettings#selectIndexes(Integer...)` indexesToWrite) Executes the sequences of reverse conversions defined using `DefaultConversionProcessor#convertFields(Conversion...)`, `DefaultConversionProcessor#convertIndexes(Conversion...)` and `DefaultConversionProcessor#convertAll(Conversion...)`, for every field in the given row.
protected DataProcessingException	toDataProcessingException(Throwable ex, Object[] row, int column)
private boolean	validateAllValues(Object[] objectRow)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

context	back to summary
pack-priv Context context

conversions	back to summary
protected FieldConversionMapping conversions

conversionsByType	back to summary
private Map<Class<?>, Conversion<I, O>[]> conversionsByType

conversionsInitialized	back to summary
private boolean conversionsInitialized

errorHandler	back to summary
pack-priv ProcessorErrorHandler<T extends Context> errorHandler

fieldIndexes	back to summary
private int[] fieldIndexes

fieldsReordered	back to summary
private boolean fieldsReordered

reverseFieldIndexes	back to summary
private int[] reverseFieldIndexes

DefaultConversionProcessor	back to summary
public DefaultConversionProcessor()

Method Detail

applyConversions back to summary

applyConversions	back to summary
public final Object[] applyConversions(String[] row, Context context) Executes the sequences of conversions defined using `DefaultConversionProcessor#convertFields(Conversion...)`, `DefaultConversionProcessor#convertIndexes(Conversion...)` and `DefaultConversionProcessor#convertAll(Conversion...)`, for every field in the given row. Each field will be transformed using the `Conversion#execute(Object)` method. In general the conversions will process a String and convert it to some object value (such as booleans, dates, etc). Parameters row:String[] the parsed record with its individual records as extracted from the original input. context:Context the current state of the parsing process. Returns:Object[] an row of Object instances containing the values obtained after the execution of all conversions. Fields that do not have any conversion defined will just be copied to the object array into their original positions.

public final Object[] applyConversions(String[] row, Context context)

Executes the sequences of conversions defined using DefaultConversionProcessor#convertFields(Conversion...), DefaultConversionProcessor#convertIndexes(Conversion...) and DefaultConversionProcessor#convertAll(Conversion...), for every field in the given row.

Each field will be transformed using the Conversion#execute(Object) method.

In general the conversions will process a String and convert it to some object value (such as booleans, dates, etc).

Parameters

row:String[]: the parsed record with its individual records as extracted from the original input.
context:Context: the current state of the parsing process.

Returns:Object[]

an row of Object instances containing the values obtained after the execution of all conversions.

Fields that do not have any conversion defined will just be copied to the object array into their original positions.

applyConversionsByType	back to summary
private boolean applyConversionsByType(boolean reverse, Object[] row, boolean[] convertedFlags)

applyTypeConversion	back to summary
private Object applyTypeConversion(boolean revert, Object input)

convertAll back to summary

convertAll	back to summary
public final void convertAll(Conversion<I, O>... conversions) Implements com.univocity.parsers.common.ConversionProcessor.convertAll. Doc from com.univocity.parsers.common.ConversionProcessor.convertAll. Applies a set of `Conversion` objects over all elements of a record Parameters conversions:Conversion<I, O>[] The sequence of conversions to be executed in all elements of a record Annotations @Override @SuppressWarnings:rawtypes, unchecked

public final void convertAll(Conversion<I, O>... conversions)

Implements com.univocity.parsers.common.ConversionProcessor.convertAll.

Doc from com.univocity.parsers.common.ConversionProcessor.convertAll.

Applies a set of Conversion objects over all elements of a record

Parameters

conversions:Conversion<I, O>[]: The sequence of conversions to be executed in all elements of a record

Annotations

@Override
@SuppressWarnings:rawtypes, unchecked

convertFields back to summary

convertFields	back to summary
public final FieldSet<String> convertFields(Conversion<I, O>... conversions) Implements com.univocity.parsers.common.ConversionProcessor.convertFields. Doc from com.univocity.parsers.common.ConversionProcessor.convertFields. Applies a set of `Conversion` objects over fields of a record by name. The idiom to define which fields should have these conversions applied is as follows: processor.convertFields(Conversions.trim(), Conversions.toUpperCase()).add("name", "position"); // applies trim and uppercase conversions to fields with headers "name" and "position" Parameters conversions:Conversion<I, O>[] The sequence of conversions to be executed in a set of field indexes. Returns:FieldSet<String> A `FieldSet` for field names. Annotations @Override @SuppressWarnings:unchecked, rawtypes

public final FieldSet<String> convertFields(Conversion<I, O>... conversions)

Implements com.univocity.parsers.common.ConversionProcessor.convertFields.

Doc from com.univocity.parsers.common.ConversionProcessor.convertFields.

Applies a set of Conversion objects over fields of a record by name.

The idiom to define which fields should have these conversions applied is as follows:


processor.convertFields(Conversions.trim(), Conversions.toUpperCase()).add("name", "position"); // applies trim and uppercase conversions to fields with headers "name" and "position"

Parameters

conversions:Conversion<I, O>[]: The sequence of conversions to be executed in a set of field indexes.

Returns:FieldSet<String>

A FieldSet for field names.

Annotations

@Override
@SuppressWarnings:unchecked, rawtypes

convertIndexes back to summary

convertIndexes	back to summary
public final FieldSet<Integer> convertIndexes(Conversion<I, O>... conversions) Implements com.univocity.parsers.common.ConversionProcessor.convertIndexes. Doc from com.univocity.parsers.common.ConversionProcessor.convertIndexes. Applies a set of `Conversion` objects over indexes of a record. The idiom to define which indexes should have these conversions applies is as follows: processor.convertIndexes(Conversions.trim(), Conversions.toUpperCase()).add(2, 5); // applies trim and uppercase conversions to fields in indexes 2 and 5 Parameters conversions:Conversion<I, O>[] The sequence of conversions to be executed in a set of field indexes. Returns:FieldSet<Integer> A `FieldSet` for indexes. Annotations @Override @SuppressWarnings:unchecked, rawtypes

public final FieldSet<Integer> convertIndexes(Conversion<I, O>... conversions)

Implements com.univocity.parsers.common.ConversionProcessor.convertIndexes.

Doc from com.univocity.parsers.common.ConversionProcessor.convertIndexes.

Applies a set of Conversion objects over indexes of a record.

The idiom to define which indexes should have these conversions applies is as follows:


processor.convertIndexes(Conversions.trim(), Conversions.toUpperCase()).add(2, 5); // applies trim and uppercase conversions to fields in indexes 2 and 5

Parameters

conversions:Conversion<I, O>[]: The sequence of conversions to be executed in a set of field indexes.

Returns:FieldSet<Integer>

A FieldSet for indexes.

Annotations

@Override
@SuppressWarnings:unchecked, rawtypes

convertType	back to summary
public final void convertType(Class<?> type, Conversion<I, O>... conversions) Implements com.univocity.parsers.common.ConversionProcessor.convertType. Doc from com.univocity.parsers.common.ConversionProcessor.convertType. Applies a sequence of conversions over values of a given type. Used for writing. Parameters type:Class<?> the type over which a sequence of conversions should be applied conversions:Conversion<I, O>[] the sequence of conversions to apply over values of the given type. Annotations @Override

convertType

back to summary

public final void convertType(Class<?> type, Conversion<I, O>... conversions)

Implements com.univocity.parsers.common.ConversionProcessor.convertType.

Doc from com.univocity.parsers.common.ConversionProcessor.convertType.

Applies a sequence of conversions over values of a given type. Used for writing.

Parameters

type:Class<?>: the type over which a sequence of conversions should be applied
conversions:Conversion<I, O>[]: the sequence of conversions to apply over values of the given type.

Annotations

@Override

getConversions	back to summary
private FieldConversionMapping getConversions()

handleConversionError back to summary

handleConversionError	back to summary
protected final boolean handleConversionError(Throwable ex, Object[] row, int column) Handles an error that occurred when applying conversions over a value. If the user defined a `ProcessorErrorHandler` the user will receive the exception and is able to determine whether or not processing should continue, discarding the record. If the error handler is an instance of `RetryableErrorHandler`, the user can provide a default value to use in place of the one that could not be converted, and decide whether or not the record should be kept with the use of the `RetryableErrorHandler#keepRecord()` method. Parameters ex:Throwable the exception that occurred when applying a conversion row:Object[] the record being processed at the time the exception happened. column:int the column if the given row, whose value could not be converted. If negative, it's not possible to keep the record. Returns:boolean `true` if the error has been handled by the user and the record can still be processed, otherwise `false` if the record should be discarded.

protected final boolean handleConversionError(Throwable ex, Object[] row, int column)

Handles an error that occurred when applying conversions over a value. If the user defined a ProcessorErrorHandler the user will receive the exception and is able to determine whether or not processing should continue, discarding the record. If the error handler is an instance of RetryableErrorHandler, the user can provide a default value to use in place of the one that could not be converted, and decide whether or not the record should be kept with the use of the RetryableErrorHandler#keepRecord() method.

Parameters

ex:Throwable: the exception that occurred when applying a conversion
row:Object[]: the record being processed at the time the exception happened.
column:int: the column if the given row, whose value could not be converted. If negative, it's not possible to keep the record.

Returns:boolean

true if the error has been handled by the user and the record can still be processed, otherwise false if the record should be discarded.

initializeConversions	back to summary
protected void initializeConversions(String[] row, Context context)

populateReverseFieldIndexes	back to summary
private void populateReverseFieldIndexes()

reverseConversions back to summary

reverseConversions	back to summary
public final boolean reverseConversions(boolean executeInReverseOrder, Object[] row, NormalizedString[] headers, int[] indexesToWrite) Executes the sequences of reverse conversions defined using `DefaultConversionProcessor#convertFields(Conversion...)`, `DefaultConversionProcessor#convertIndexes(Conversion...)` and `DefaultConversionProcessor#convertAll(Conversion...)`, for every field in the given row. Each field will be transformed using the `Conversion#revert(Object)` method. In general the conversions will process an Object (such as a Boolean, Date, etc), and convert it to a String representation. Parameters executeInReverseOrder:boolean flag to indicate whether the conversion sequence should be executed in the reverse order of its declaration. row:Object[] the row of objects that will be converted headers:NormalizedString[] All field names used to produce records in a given destination. May be null if no headers have been defined in `CommonSettings#getHeaders()` indexesToWrite:int[] The indexes of the headers that are actually being written. May be null if no fields have been selected using `CommonSettings#selectFields(String...)` or `CommonSettings#selectIndexes(Integer...)` Returns:boolean `true` if the the row should be discarded

public final boolean reverseConversions(boolean executeInReverseOrder, Object[] row, NormalizedString[] headers, int[] indexesToWrite)

Executes the sequences of reverse conversions defined using DefaultConversionProcessor#convertFields(Conversion...), DefaultConversionProcessor#convertIndexes(Conversion...) and DefaultConversionProcessor#convertAll(Conversion...), for every field in the given row.

Each field will be transformed using the Conversion#revert(Object) method.

In general the conversions will process an Object (such as a Boolean, Date, etc), and convert it to a String representation.

Parameters

executeInReverseOrder:boolean: flag to indicate whether the conversion sequence should be executed in the reverse order of its declaration.
row:Object[]: the row of objects that will be converted
headers:NormalizedString[]: All field names used to produce records in a given destination. May be null if no headers have been defined in CommonSettings#getHeaders()
indexesToWrite:int[]: The indexes of the headers that are actually being written. May be null if no fields have been selected using CommonSettings#selectFields(String...) or CommonSettings#selectIndexes(Integer...)

Returns:boolean

true if the the row should be discarded

toDataProcessingException	back to summary
protected DataProcessingException toDataProcessingException(Throwable ex, Object[] row, int column)

validateAllValues	back to summary
private boolean validateAllValues(Object[] objectRow)

public abstract Class DefaultConversionProcessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail