univocity-parsers 2.9.1 · com.univocity.parsers.common.processor.core.BeanConversionProcessor

Modifier and Type	Field and Description
pack-priv final Class<T>	beanClass
private ColumnMapping	columnMapper
pack-priv final Constructor<T>	constructor
protected boolean	initialized
private int	lastFieldIndexMapped
private boolean	mappingsForWritingValidated
protected final MethodFilter	methodFilter
private FieldMapping[]	missing
private Map<FieldMapping, BeanConversionProcessor<?>>	nestedAttributes
protected final Set<FieldMapping>	parsedFields
private FieldMapping[]	readOrder
private Object[]	row
pack-priv boolean	strictHeaderValidationEnabled
private NormalizedString[]	syntheticHeaders
protected final HeaderTransformer	transformer
private Object[]	valuesForMissing

Access	Constructor and Description
public	BeanConversionProcessor(Class<T> the class annotated with one or more of the annotations provided in `com.univocity.parsers.annotations`. beanType) Deprecated Use the `BeanConversionProcessor(Class, MethodFilter)` constructor instead. Initializes the BeanConversionProcessor with the annotated bean class.
public	BeanConversionProcessor(Class<T> the class annotated with one or more of the annotations provided in `com.univocity.parsers.annotations`. beanType, MethodFilter filter to apply over annotated methods when the processor is reading data from beans (to write values to an output) or writing values into beans (when parsing). It is used to choose either a "get" or a "set" method annotated with `Parsed`, when both methods target the same field. methodFilter) Initializes the BeanConversionProcessor with the annotated bean class
pack-priv	BeanConversionProcessor(Class<T> beanType, HeaderTransformer transformer, MethodFilter methodFilter)

Method Summary

Modifier and Type	Method and Description
protected void	addConversion(Conversion<I, O> The conversion object that must be executed against the given field conversion, FieldMapping the helper object that contains information about how a field is mapped. mapping) Associates a conversion to a field of the java bean class.
private boolean	applyDefaultConversion(Conversion<I, O> lastConversionApplied, Conversion<I, O> defaultConversion)
protected FieldConversionMapping	Returns: a copy of the currently defined conversions cloneConversions() Creates a copy of the manually defined conversions to be applied over any columns.
public T	Returns: an instance of the java bean type defined in this class constructor. createBean(String[] The values extracted from the parser row, Context The current state of the parsing process context) Converts a record with values extracted from the parser into a java bean instance.
pack-priv BeanConversionProcessor<?>	createNestedProcessor(Annotation annotation, Class<T> nestedType, FieldMapping fieldMapping, HeaderTransformer transformer)
pack-priv static String	describeField(AnnotatedElement target)
public Class<T>	Returns: the class of the annotated java bean instances that will be manipulated by this processor. getBeanClass() Returns the class of the annotated java bean instances that will be manipulated by this processor.
public final ColumnMapper	Returns: the column mapper getColumnMapper() Returns a mapper that allows users to manually define mappings from attributes/methods of a given class to columns to be parsed or written.
private Method	getConversionMethod(Conversion<I, O> conversion, String methodName)
pack-priv Map<FieldMapping, BeanConversionProcessor<?>>	getNestedAttributes()
private void	identifyLiterals()
public final void	initialize() Identifies and extracts fields annotated with the `Parsed` annotation
protected final void	initialize(String[] headers parsed from the input. headers) Identifies and extracts fields annotated with the `Parsed` annotation
protected final void	initialize(NormalizedString[] headers parsed from the input. headers) Identifies and extracts fields annotated with the `Parsed` annotation
private void	initializeValuesForMissing()
public boolean	Returns: flag indicating whether strict validation of headers is enabled. isStrictHeaderValidationEnabled() Returns a flag indicating whether all headers declared in the annotated class must be present in the input.
private void	mapFieldIndexes(Context context, Object[] A row with values for the given java bean. row, NormalizedString[] The names of all fields of the record (including any header that is not mapped to the java bean). May be null if no headers have been defined in `CommonSettings#getHeaders()` headers, int[] The indexes of the headers or row that are actually being used. May be null if no fields have been selected using `CommonSettings#selectFields(String...)` or `CommonSettings#selectIndexes(Integer...)` indexes, boolean Indicates the indexes provided were reordered and do not match the original sequence of headers. columnsReordered) Identifies which fields are associated with which columns in a row.
private void	mapFieldsToValues(T the java bean instance to be read instance, Object[] object array that will receive the values extracted from java bean row, NormalizedString[] The names of all fields of the record (including any header that is not mapped to the java bean). May be null if no headers have been defined in `CommonSettings#getHeaders()` headers, int[] The indexes of the headers or row that are actually being used. May be null if no fields have been selected using `CommonSettings#selectFields(String...)` or `CommonSettings#selectIndexes(Integer...)` indexes, boolean Indicates the indexes provided were reordered and do not match the original sequence of headers. columnsReordered) Iterates over all fields in the java bean instance and extracts its values.
pack-priv void	mapValuesToFields(T the java bean instance that is going to have its properties set instance, Object[] the values to associate with each field of the javabean. row, Context information about the current parsing process. context) Goes through a list of objects and associates each value to a particular field of a java bean instance
private int	nonNullReadOrderLength()
private void	populateTargetMaps(Map<Object, Integer> targetCounts, Map<Object, String> targetSources)
pack-priv void	processField(AnnotatedElement element, String targetName, PropertyWrapper propertyDescriptor, NormalizedString[] headers)
protected boolean	Returns: `true` if the given field should be processed, otherwise `false`. processField(FieldMapping the field to be processed field) Determines whether or not an annotated field should be processed.
pack-priv void	processNestedAttributes(String[] row, Object instance, Context context)
private void	processNestedField(Class<T> nestedType, AnnotatedElement element, String targetName, PropertyWrapper propertyDescriptor, NormalizedString[] headers, Nested nested)
public final Object[]	Returns: a row of objects containing the values extracted from the java bean reverseConversions(T an instance of the type defined in this class constructor. bean, 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) Converts a java bean instance into a sequence of values for writing.
public void	setColumnMapper(ColumnMapper the column mappings to use columnMapper) Copies the given column mappings over to this processor.
public void	setStrictHeaderValidationEnabled(boolean flag indicating whether strict validation of headers is enabled. strictHeaderValidationEnabled) Defines whether all headers declared in the annotated class must be present in the input.
private void	setupConversions(AnnotatedElement the field and method annotated with `Parsed` that must be associated with one or more `Conversion` objects target, FieldMapping a helper class to store information how the field or method is mapped to a parsed record. mapping) Goes through each field and method annotated with `Parsed` and extracts the sequence of `Conversion` elements associated with each one.
pack-priv void	validateMappings()
private void	validateMappingsForWriting()

Inherited from com.univocity.parsers.common.DefaultConversionProcessor:: applyConversions convertAll convertFields convertIndexes convertType handleConversionError initializeConversions reverseConversions toDataProcessingException

beanClass	back to summary
pack-priv final Class<T> beanClass

columnMapper	back to summary
private ColumnMapping columnMapper

constructor	back to summary
pack-priv final Constructor<T> constructor

initialized	back to summary
protected boolean initialized

lastFieldIndexMapped	back to summary
private int lastFieldIndexMapped

mappingsForWritingValidated	back to summary
private boolean mappingsForWritingValidated

methodFilter	back to summary
protected final MethodFilter methodFilter

missing	back to summary
private FieldMapping[] missing

nestedAttributes	back to summary
private Map<FieldMapping, BeanConversionProcessor<?>> nestedAttributes

parsedFields	back to summary
protected final Set<FieldMapping> parsedFields

readOrder	back to summary
private FieldMapping[] readOrder

row	back to summary
private Object[] row

strictHeaderValidationEnabled	back to summary
pack-priv boolean strictHeaderValidationEnabled

syntheticHeaders	back to summary
private NormalizedString[] syntheticHeaders

transformer	back to summary
protected final HeaderTransformer transformer

valuesForMissing	back to summary
private Object[] valuesForMissing

BeanConversionProcessor	back to summary
public BeanConversionProcessor(Class<T> beanType) Deprecated Use the `BeanConversionProcessor(Class, MethodFilter)` constructor instead. Initializes the BeanConversionProcessor with the annotated bean class. If any method of the given class has annotations, only the setter methods will be used (getters will be ignored), making this processor useful mostly for parsing into instances of the given class. Parameters beanType:Class<T> the class annotated with one or more of the annotations provided in `com.univocity.parsers.annotations`. Annotations @Deprecated

BeanConversionProcessor	back to summary
public BeanConversionProcessor(Class<T> beanType, MethodFilter methodFilter) Initializes the BeanConversionProcessor with the annotated bean class Parameters beanType:Class<T> the class annotated with one or more of the annotations provided in `com.univocity.parsers.annotations`. methodFilter:MethodFilter filter to apply over annotated methods when the processor is reading data from beans (to write values to an output) or writing values into beans (when parsing). It is used to choose either a "get" or a "set" method annotated with `Parsed`, when both methods target the same field.

BeanConversionProcessor	back to summary
pack-priv BeanConversionProcessor(Class<T> beanType, HeaderTransformer transformer, MethodFilter methodFilter)

Method Detail

addConversion	back to summary
protected void addConversion(Conversion<I, O> conversion, FieldMapping mapping) Associates a conversion to a field of the java bean class. Parameters conversion:Conversion<I, O> The conversion object that must be executed against the given field mapping:FieldMapping the helper object that contains information about how a field is mapped. Annotations @SuppressWarnings:rawtypes

addConversion

back to summary

protected void addConversion(Conversion<I, O> conversion, FieldMapping mapping)

Associates a conversion to a field of the java bean class.

Parameters

conversion:Conversion<I, O>: The conversion object that must be executed against the given field
mapping:FieldMapping: the helper object that contains information about how a field is mapped.

Annotations

@SuppressWarnings:rawtypes

applyDefaultConversion	back to summary
private boolean applyDefaultConversion(Conversion<I, O> lastConversionApplied, Conversion<I, O> defaultConversion) Annotations @SuppressWarnings:rawtypes

cloneConversions	back to summary
protected FieldConversionMapping cloneConversions() Creates a copy of the manually defined conversions to be applied over any columns. Returns:FieldConversionMapping a copy of the currently defined conversions

cloneConversions

back to summary

protected FieldConversionMapping cloneConversions()

Creates a copy of the manually defined conversions to be applied over any columns.

Returns:FieldConversionMapping: a copy of the currently defined conversions

createBean	back to summary
public T createBean(String[] row, Context context) Converts a record with values extracted from the parser into a java bean instance. Parameters row:String[] The values extracted from the parser context:Context The current state of the parsing process Returns:T an instance of the java bean type defined in this class constructor.

createBean

back to summary

public T createBean(String[] row, Context context)

Converts a record with values extracted from the parser into a java bean instance.

Parameters

row:String[]: The values extracted from the parser
context:Context: The current state of the parsing process

Returns:T

an instance of the java bean type defined in this class constructor.

createNestedProcessor	back to summary
pack-priv BeanConversionProcessor<?> createNestedProcessor(Annotation annotation, Class<T> nestedType, FieldMapping fieldMapping, HeaderTransformer transformer)

describeField	back to summary
pack-priv static String describeField(AnnotatedElement target)

getBeanClass	back to summary
public Class<T> getBeanClass() Returns the class of the annotated java bean instances that will be manipulated by this processor. Returns:Class<T> the class of the annotated java bean instances that will be manipulated by this processor.

getBeanClass

back to summary

public Class<T> getBeanClass()

Returns the class of the annotated java bean instances that will be manipulated by this processor.

Returns:Class<T>: the class of the annotated java bean instances that will be manipulated by this processor.

getColumnMapper back to summary

getColumnMapper	back to summary
public final ColumnMapper getColumnMapper() Returns a mapper that allows users to manually define mappings from attributes/methods of a given class to columns to be parsed or written. This allows users to use instances of classes that are not annotated with `Parsed` nor `Nested`. Any mappings defined with the column mapper will take precedence over these annotations. Returns:ColumnMapper the column mapper

public final ColumnMapper getColumnMapper()

Returns a mapper that allows users to manually define mappings from attributes/methods of a given class to columns to be parsed or written. This allows users to use instances of classes that are not annotated with Parsed nor Nested. Any mappings defined with the column mapper will take precedence over these annotations.

Returns:ColumnMapper: the column mapper

getConversionMethod	back to summary
private Method getConversionMethod(Conversion<I, O> conversion, String methodName) Annotations @SuppressWarnings:rawtypes

getNestedAttributes	back to summary
pack-priv Map<FieldMapping, BeanConversionProcessor<?>> getNestedAttributes()

identifyLiterals	back to summary
private void identifyLiterals()

initialize	back to summary
public final void initialize() Identifies and extracts fields annotated with the `Parsed` annotation

initialize back to summary

initialize	back to summary
protected final void initialize(String[] headers) Identifies and extracts fields annotated with the `Parsed` annotation Parameters headers:String[] headers parsed from the input.

protected final void initialize(String[] headers)

Identifies and extracts fields annotated with the Parsed annotation

Parameters

headers:String[]: headers parsed from the input.

initialize back to summary

initialize	back to summary
protected final void initialize(NormalizedString[] headers) Identifies and extracts fields annotated with the `Parsed` annotation Parameters headers:NormalizedString[] headers parsed from the input.

protected final void initialize(NormalizedString[] headers)

Identifies and extracts fields annotated with the Parsed annotation

Parameters

headers:NormalizedString[]: headers parsed from the input.

initializeValuesForMissing	back to summary
private void initializeValuesForMissing()

isStrictHeaderValidationEnabled	back to summary
public boolean isStrictHeaderValidationEnabled() Returns a flag indicating whether all headers declared in the annotated class must be present in the input. If enabled, an exception will be thrown in case the input data does not contain all headers required. Returns:boolean flag indicating whether strict validation of headers is enabled.

isStrictHeaderValidationEnabled

back to summary

public boolean isStrictHeaderValidationEnabled()

Returns a flag indicating whether all headers declared in the annotated class must be present in the input. If enabled, an exception will be thrown in case the input data does not contain all headers required.

Returns:boolean: flag indicating whether strict validation of headers is enabled.

mapFieldIndexes back to summary

mapFieldIndexes	back to summary
private void mapFieldIndexes(Context context, Object[] row, NormalizedString[] headers, int[] indexes, boolean columnsReordered) Identifies which fields are associated with which columns in a row. Parameters row:Object[] A row with values for the given java bean. headers:NormalizedString[] The names of all fields of the record (including any header that is not mapped to the java bean). May be null if no headers have been defined in `CommonSettings#getHeaders()` indexes:int[] The indexes of the headers or row that are actually being used. May be null if no fields have been selected using `CommonSettings#selectFields(String...)` or `CommonSettings#selectIndexes(Integer...)` columnsReordered:boolean Indicates the indexes provided were reordered and do not match the original sequence of headers.

private void mapFieldIndexes(Context context, Object[] row, NormalizedString[] headers, int[] indexes, boolean columnsReordered)

Identifies which fields are associated with which columns in a row.

Parameters

row:Object[]: A row with values for the given java bean.
headers:NormalizedString[]: The names of all fields of the record (including any header that is not mapped to the java bean). May be null if no headers have been defined in CommonSettings#getHeaders()
indexes:int[]: The indexes of the headers or row that are actually being used. May be null if no fields have been selected using CommonSettings#selectFields(String...) or CommonSettings#selectIndexes(Integer...)
columnsReordered:boolean: Indicates the indexes provided were reordered and do not match the original sequence of headers.

mapFieldsToValues back to summary

mapFieldsToValues	back to summary
private void mapFieldsToValues(T instance, Object[] row, NormalizedString[] headers, int[] indexes, boolean columnsReordered) Iterates over all fields in the java bean instance and extracts its values. Parameters instance:T the java bean instance to be read row:Object[] object array that will receive the values extracted from java bean headers:NormalizedString[] The names of all fields of the record (including any header that is not mapped to the java bean). May be null if no headers have been defined in `CommonSettings#getHeaders()` indexes:int[] The indexes of the headers or row that are actually being used. May be null if no fields have been selected using `CommonSettings#selectFields(String...)` or `CommonSettings#selectIndexes(Integer...)` columnsReordered:boolean Indicates the indexes provided were reordered and do not match the original sequence of headers.

private void mapFieldsToValues(T instance, Object[] row, NormalizedString[] headers, int[] indexes, boolean columnsReordered)

Iterates over all fields in the java bean instance and extracts its values.

Parameters

instance:T: the java bean instance to be read
row:Object[]: object array that will receive the values extracted from java bean
headers:NormalizedString[]: The names of all fields of the record (including any header that is not mapped to the java bean). May be null if no headers have been defined in CommonSettings#getHeaders()
indexes:int[]: The indexes of the headers or row that are actually being used. May be null if no fields have been selected using CommonSettings#selectFields(String...) or CommonSettings#selectIndexes(Integer...)
columnsReordered:boolean: Indicates the indexes provided were reordered and do not match the original sequence of headers.

mapValuesToFields	back to summary
pack-priv void mapValuesToFields(T instance, Object[] row, Context context) Goes through a list of objects and associates each value to a particular field of a java bean instance Parameters instance:T the java bean instance that is going to have its properties set row:Object[] the values to associate with each field of the javabean. context:Context information about the current parsing process.

mapValuesToFields

back to summary

pack-priv void mapValuesToFields(T instance, Object[] row, Context context)

Goes through a list of objects and associates each value to a particular field of a java bean instance

Parameters

instance:T: the java bean instance that is going to have its properties set
row:Object[]: the values to associate with each field of the javabean.
context:Context: information about the current parsing process.

nonNullReadOrderLength	back to summary
private int nonNullReadOrderLength()

populateTargetMaps	back to summary
private void populateTargetMaps(Map<Object, Integer> targetCounts, Map<Object, String> targetSources)

processField	back to summary
pack-priv void processField(AnnotatedElement element, String targetName, PropertyWrapper propertyDescriptor, NormalizedString[] headers)

processField back to summary

processField	back to summary
protected boolean processField(FieldMapping field) Determines whether or not an annotated field should be processed. Can be overridden by subclasses for fine grained control. Parameters field:FieldMapping the field to be processed Returns:boolean `true` if the given field should be processed, otherwise `false`.

protected boolean processField(FieldMapping field)

Determines whether or not an annotated field should be processed. Can be overridden by subclasses for fine grained control.

Parameters

field:FieldMapping: the field to be processed

Returns:boolean

true if the given field should be processed, otherwise false.

processNestedAttributes	back to summary
pack-priv void processNestedAttributes(String[] row, Object instance, Context context)

processNestedField	back to summary
private void processNestedField(Class<T> nestedType, AnnotatedElement element, String targetName, PropertyWrapper propertyDescriptor, NormalizedString[] headers, Nested nested)

reverseConversions back to summary

reverseConversions	back to summary
public final Object[] reverseConversions(T bean, NormalizedString[] headers, int[] indexesToWrite) Converts a java bean instance into a sequence of values for writing. Parameters bean:T an instance of the type defined in this class constructor. 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:Object[] a row of objects containing the values extracted from the java bean

public final Object[] reverseConversions(T bean, NormalizedString[] headers, int[] indexesToWrite)

Converts a java bean instance into a sequence of values for writing.

Parameters

bean:T: an instance of the type defined in this class constructor.
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:Object[]

a row of objects containing the values extracted from the java bean

setColumnMapper	back to summary
public void setColumnMapper(ColumnMapper columnMapper) Copies the given column mappings over to this processor. Further changes to the given object won't be reflected on the copy stored internally. Parameters columnMapper:ColumnMapper the column mappings to use

setColumnMapper

back to summary

public void setColumnMapper(ColumnMapper columnMapper)

Copies the given column mappings over to this processor. Further changes to the given object won't be reflected on the copy stored internally.

Parameters

columnMapper:ColumnMapper: the column mappings to use

setStrictHeaderValidationEnabled	back to summary
public void setStrictHeaderValidationEnabled(boolean strictHeaderValidationEnabled) Defines whether all headers declared in the annotated class must be present in the input. If enabled, an exception will be thrown in case the input data does not contain all headers required. Parameters strictHeaderValidationEnabled:boolean flag indicating whether strict validation of headers is enabled.

setStrictHeaderValidationEnabled

back to summary

public void setStrictHeaderValidationEnabled(boolean strictHeaderValidationEnabled)

Defines whether all headers declared in the annotated class must be present in the input. If enabled, an exception will be thrown in case the input data does not contain all headers required.

Parameters

strictHeaderValidationEnabled:boolean: flag indicating whether strict validation of headers is enabled.

setupConversions back to summary

private void setupConversions(AnnotatedElement target, FieldMapping mapping)

Goes through each field and method annotated with Parsed and extracts the sequence of Conversion elements associated with each one.

Parameters

target:AnnotatedElement: the field and method annotated with Parsed that must be associated with one or more Conversion objects
mapping:FieldMapping: a helper class to store information how the field or method is mapped to a parsed record.

Annotations

@SuppressWarnings:rawtypes

validateMappings	back to summary
pack-priv void validateMappings()

validateMappingsForWriting	back to summary
private void validateMappingsForWriting()

public Class BeanConversionProcessor<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail