Package com.univocity.parsers.common.processor.core

Class BeanConversionProcessor<T>

    • Field Detail

      • beanClass

        final java.lang.Class<T> beanClass

      • constructor

        final java.lang.reflect.Constructor<T> constructor

      • parsedFields

        protected final java.util.Set<FieldMapping> parsedFields

      • lastFieldIndexMapped

        private int lastFieldIndexMapped

      • valuesForMissing

        private java.lang.Object[] valuesForMissing

      • initialized

        protected boolean initialized

      • strictHeaderValidationEnabled

        boolean strictHeaderValidationEnabled

      • row

        private java.lang.Object[] row

      • mappingsForWritingValidated

        private boolean mappingsForWritingValidated

    • Constructor Detail

      • BeanConversionProcessor

        @Deprecated
public BeanConversionProcessor​(java.lang.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 - the class annotated with one or more of the annotations provided in com.univocity.parsers.annotations.

      • BeanConversionProcessor

        public BeanConversionProcessor​(java.lang.Class<T> beanType,
                               MethodFilter methodFilter)
        Initializes the BeanConversionProcessor with the annotated bean class
        Parameters:
        beanType - the class annotated with one or more of the annotations provided in com.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 with Parsed, when both methods target the same field.

    • Method Detail

      • 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 the Parsed annotation

      • getColumnMapper

        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:
        the column mapper

      • initialize

        protected final void initialize​(java.lang.String[] headers)
        Identifies and extracts fields annotated with the Parsed annotation
        Parameters:
        headers - headers parsed from the input.

      • initialize

        protected final void initialize​(NormalizedString[] headers)
        Identifies and extracts fields annotated with the Parsed 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​(java.lang.reflect.AnnotatedElement element,
                  java.lang.String targetName,
                  PropertyWrapper propertyDescriptor,
                  NormalizedString[] headers)

      • processNestedField

        private void processNestedField​(java.lang.Class nestedType,
                                java.lang.reflect.AnnotatedElement element,
                                java.lang.String targetName,
                                PropertyWrapper propertyDescriptor,
                                NormalizedString[] headers,
                                Nested nested)

      • cloneConversions

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

      • processField

        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 - the field to be processed
        Returns:
        true if the given field should be processed, otherwise false.

      • validateMappings

        void validateMappings()

      • describeField

        static java.lang.String describeField​(java.lang.reflect.AnnotatedElement target)

      • setupConversions

        private void setupConversions​(java.lang.reflect.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 - the field and method annotated with Parsed that must be associated with one or more Conversion objects
        mapping - 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

        private java.lang.reflect.Method getConversionMethod​(Conversion conversion,
                                                     java.lang.String methodName)

      • addConversion

        protected void addConversion​(Conversion conversion,
                             FieldMapping mapping)
        Associates a conversion to a field of the java bean class.
        Parameters:
        conversion - The conversion object that must be executed against the given field
        mapping - the helper object that contains information about how a field is mapped.

      • mapValuesToFields

        void mapValuesToFields​(T instance,
                       java.lang.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 - the java bean instance that is going to have its properties set
        row - the values to associate with each field of the javabean.
        context - information about the current parsing process.

      • mapFieldIndexes

        private void mapFieldIndexes​(Context context,
                             java.lang.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 in CommonSettings.getHeaders()
        indexes - 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 - Indicates the indexes provided were reordered and do not match the original sequence of headers.

      • initializeValuesForMissing

        private void initializeValuesForMissing()

      • createBean

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

      • processNestedAttributes

        void processNestedAttributes​(java.lang.String[] row,
                             java.lang.Object instance,
                             Context context)

      • mapFieldsToValues

        private void mapFieldsToValues​(T instance,
                               java.lang.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 read
        row - object array that will receive the values extracted from 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 in CommonSettings.getHeaders()
        indexes - 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 - Indicates the indexes provided were reordered and do not match the original sequence of headers.

      • reverseConversions

        public final java.lang.Object[] reverseConversions​(T bean,
                                                   NormalizedString[] headers,
                                                   int[] indexesToWrite)
        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 in CommonSettings.getHeaders()
        indexesToWrite - 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:
        a row of objects containing the values extracted from the java bean

      • getBeanClass

        public java.lang.Class<T> 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

        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 - the column mappings to use

      • validateMappingsForWriting

        private void validateMappingsForWriting()

      • populateTargetMaps

        private void populateTargetMaps​(java.util.Map<java.lang.Object,​java.lang.Integer> targetCounts,
                                java.util.Map<java.lang.Object,​java.lang.String> targetSources)