Class BeanConversionProcessor<T>
java.lang.Object
com.univocity.parsers.common.DefaultConversionProcessor
com.univocity.parsers.common.processor.core.BeanConversionProcessor<T>
- Type Parameters:
T
- the annotated class type.
- All Implemented Interfaces:
ConversionProcessor
- Direct Known Subclasses:
AbstractBeanProcessor
,BeanWriterProcessor
The base class for
Processor
and RowWriterProcessor
implementations that support java beans annotated with the annotations provided in
com.univocity.parsers.annotations
.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ColumnMapping
(package private) final Constructor<T>
protected boolean
private int
private boolean
protected final MethodFilter
private FieldMapping[]
private Map<FieldMapping,
BeanConversionProcessor<?>> protected final Set<FieldMapping>
private FieldMapping[]
private Object[]
(package private) boolean
private NormalizedString[]
protected final HeaderTransformer
private Object[]
Fields inherited from class com.univocity.parsers.common.DefaultConversionProcessor
conversions
-
Constructor Summary
ConstructorsConstructorDescriptionBeanConversionProcessor
(Class<T> beanType) Deprecated.BeanConversionProcessor
(Class<T> beanType, HeaderTransformer transformer, MethodFilter methodFilter) BeanConversionProcessor
(Class<T> beanType, MethodFilter methodFilter) Initializes the BeanConversionProcessor with the annotated bean class -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addConversion
(Conversion conversion, FieldMapping mapping) Associates a conversion to a field of the java bean class.private boolean
applyDefaultConversion
(Conversion lastConversionApplied, Conversion defaultConversion) protected FieldConversionMapping
Creates a copy of the manually defined conversions to be applied over any columns.createBean
(String[] row, Context context) Converts a record with values extracted from the parser into a java bean instance.(package private) BeanConversionProcessor<?>
createNestedProcessor
(Annotation annotation, Class nestedType, FieldMapping fieldMapping, HeaderTransformer transformer) (package private) static String
describeField
(AnnotatedElement target) Returns the class of the annotated java bean instances that will be manipulated by this processor.final ColumnMapper
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 conversion, String methodName) (package private) Map<FieldMapping,
BeanConversionProcessor<?>> private void
final void
Identifies and extracts fields annotated with theParsed
annotationprotected final void
initialize
(NormalizedString[] headers) Identifies and extracts fields annotated with theParsed
annotationprotected final void
initialize
(String[] headers) Identifies and extracts fields annotated with theParsed
annotationprivate void
boolean
Returns a flag indicating whether all headers declared in the annotated class must be present in the input.private void
mapFieldIndexes
(Context context, Object[] row, NormalizedString[] headers, int[] indexes, boolean columnsReordered) Identifies which fields are associated with which columns in a row.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.(package private) 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 instanceprivate int
private void
protected boolean
processField
(FieldMapping field) Determines whether or not an annotated field should be processed.(package private) void
processField
(AnnotatedElement element, String targetName, PropertyWrapper propertyDescriptor, NormalizedString[] headers) (package private) void
processNestedAttributes
(String[] row, Object instance, Context context) private void
processNestedField
(Class nestedType, AnnotatedElement element, String targetName, PropertyWrapper propertyDescriptor, NormalizedString[] headers, Nested nested) final Object[]
reverseConversions
(T bean, NormalizedString[] headers, int[] indexesToWrite) Converts a java bean instance into a sequence of values for writing.void
setColumnMapper
(ColumnMapper columnMapper) Copies the given column mappings over to this processor.void
setStrictHeaderValidationEnabled
(boolean strictHeaderValidationEnabled) Defines whether all headers declared in the annotated class must be present in the input.private void
setupConversions
(AnnotatedElement target, FieldMapping mapping) Goes through each field and method annotated withParsed
and extracts the sequence ofConversion
elements associated with each one.(package private) void
private void
Methods inherited from class com.univocity.parsers.common.DefaultConversionProcessor
applyConversions, convertAll, convertFields, convertIndexes, convertType, handleConversionError, initializeConversions, reverseConversions, toDataProcessingException
-
Field Details
-
beanClass
-
constructor
-
parsedFields
-
lastFieldIndexMapped
private int lastFieldIndexMapped -
readOrder
-
missing
-
valuesForMissing
-
initialized
protected boolean initialized -
strictHeaderValidationEnabled
boolean strictHeaderValidationEnabled -
syntheticHeaders
-
row
-
nestedAttributes
-
transformer
-
methodFilter
-
columnMapper
-
mappingsForWritingValidated
private boolean mappingsForWritingValidated
-
-
Constructor Details
-
BeanConversionProcessor
Deprecated.Use theBeanConversionProcessor(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
- the class annotated with one or more of the annotations provided incom.univocity.parsers.annotations
.
-
BeanConversionProcessor
Initializes the BeanConversionProcessor with the annotated bean class- Parameters:
beanType
- the class annotated with one or more of the annotations provided incom.univocity.parsers.annotations
.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 withParsed
, when both methods target the same field.
-
BeanConversionProcessor
BeanConversionProcessor(Class<T> beanType, HeaderTransformer transformer, MethodFilter methodFilter)
-
-
Method Details
-
isStrictHeaderValidationEnabled
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:
- flag indicating whether strict validation of headers is enabled.
-
initialize
public final void initialize()Identifies and extracts fields annotated with theParsed
annotation -
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 withParsed
norNested
. Any mappings defined with the column mapper will take precedence over these annotations.- Returns:
- the column mapper
-
initialize
Identifies and extracts fields annotated with theParsed
annotation- Parameters:
headers
- headers parsed from the input.
-
initialize
Identifies and extracts fields annotated with theParsed
annotation- Parameters:
headers
- headers parsed from the input.
-
identifyLiterals
private void identifyLiterals() -
setStrictHeaderValidationEnabled
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
- flag indicating whether strict validation of headers is enabled.
-
processField
void processField(AnnotatedElement element, String targetName, PropertyWrapper propertyDescriptor, NormalizedString[] headers) -
processNestedField
private void processNestedField(Class nestedType, AnnotatedElement element, String targetName, PropertyWrapper propertyDescriptor, NormalizedString[] headers, Nested nested) -
cloneConversions
Creates a copy of the manually defined conversions to be applied over any columns.- Returns:
- a copy of the currently defined conversions
-
getNestedAttributes
Map<FieldMapping,BeanConversionProcessor<?>> getNestedAttributes() -
createNestedProcessor
BeanConversionProcessor<?> createNestedProcessor(Annotation annotation, Class nestedType, FieldMapping fieldMapping, HeaderTransformer transformer) -
processField
Determines whether or not an annotated field should be processed. Can be overridden by subclasses for fine grained control.- Parameters:
field
- the field to be processed- Returns:
true
if the given field should be processed, otherwisefalse
.
-
validateMappings
void validateMappings() -
describeField
-
setupConversions
Goes through each field and method annotated withParsed
and extracts the sequence ofConversion
elements associated with each one.- Parameters:
target
- the field and method annotated withParsed
that must be associated with one or moreConversion
objectsmapping
- a helper class to store information how the field or method is mapped to a parsed record.
-
applyDefaultConversion
private boolean applyDefaultConversion(Conversion lastConversionApplied, Conversion defaultConversion) -
getConversionMethod
-
addConversion
Associates a conversion to a field of the java bean class.- Parameters:
conversion
- The conversion object that must be executed against the given fieldmapping
- the helper object that contains information about how a field is mapped.
-
mapValuesToFields
Goes through a list of objects and associates each value to a particular field of a java bean instance- Parameters:
instance
- the java bean instance that is going to have its properties setrow
- the values to associate with each field of the javabean.context
- information about the current parsing process.
-
mapFieldIndexes
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
- A row with values for the given java bean.headers
- 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 inCommonSettings.getHeaders()
indexes
- The indexes of the headers or row that are actually being used. May be null if no fields have been selected usingCommonSettings.selectFields(String...)
orCommonSettings.selectIndexes(Integer...)
columnsReordered
- Indicates the indexes provided were reordered and do not match the original sequence of headers.
-
nonNullReadOrderLength
private int nonNullReadOrderLength() -
initializeValuesForMissing
private void initializeValuesForMissing() -
createBean
Converts a record with values extracted from the parser into a java bean instance.- Parameters:
row
- The values extracted from the parsercontext
- The current state of the parsing process- Returns:
- an instance of the java bean type defined in this class constructor.
-
processNestedAttributes
-
mapFieldsToValues
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
- the java bean instance to be readrow
- object array that will receive the values extracted from java beanheaders
- 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 inCommonSettings.getHeaders()
indexes
- The indexes of the headers or row that are actually being used. May be null if no fields have been selected usingCommonSettings.selectFields(String...)
orCommonSettings.selectIndexes(Integer...)
columnsReordered
- Indicates the indexes provided were reordered and do not match the original sequence of headers.
-
reverseConversions
Converts a java bean instance into a sequence of values for writing.- Parameters:
bean
- an instance of the type defined in this class constructor.headers
- All field names used to produce records in a given destination. May be null if no headers have been defined inCommonSettings.getHeaders()
indexesToWrite
- The indexes of the headers that are actually being written. May be null if no fields have been selected usingCommonSettings.selectFields(String...)
orCommonSettings.selectIndexes(Integer...)
- Returns:
- a row of objects containing the values extracted from the java bean
-
getBeanClass
Returns the class of the annotated java bean instances that will be manipulated by this processor.- Returns:
- the class of the annotated java bean instances that will be manipulated by this processor.
-
setColumnMapper
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
- the column mappings to use
-
validateMappingsForWriting
private void validateMappingsForWriting() -
populateTargetMaps
-
BeanConversionProcessor(Class, MethodFilter)
constructor instead.