Module datarush.library
Package com.pervasive.datarush.schema

Class FixedWidthTextRecord

  • All Implemented Interfaces:
    RecordTextSchema<FixedSizeTextType>, TextSchema
    public class FixedWidthTextRecord
extends Object
    A definition of a fixed-width record in a text file. As fields as fixed-size, structured text file readers and writers can identify fields based on their position within the record.

    • Constructor Detail

      • FixedWidthTextRecord

        public FixedWidthTextRecord()
        Defines an empty fixed-width record. Default text conversion behavior is used.

        An empty record definition is not meaningful; it is expected that at least one field will be defined before the schema is used. The length of the record is determined from the size of the fields.

        See Also:
        TextConversionDefaults

      • FixedWidthTextRecord

        public FixedWidthTextRecord​(TextConversionDefaults defaults)
        Defines an empty fixed-width record with the specified text conversion behavior.

        An empty record definition is not meaningful; it is expected that at least one field will be defined before the schema is used. The length of the record is determined from the size of the fields.

        Parameters:
        defaults - text conversion behavior to apply by default to the schema

      • FixedWidthTextRecord

        public FixedWidthTextRecord​(TextConversionDefaults defaults,
                            Map<String,​FixedSizeTextType> fieldTypes)
        Defines a record with the specified text conversion behavior and fields. The field order is the iteration order of the provided field mapping.
        Parameters:
        defaults - default text conversion behavior for the schema
        fieldTypes - the defined fields in the record schema default to the schema

    • Method Detail

      • getRecordLength

        public int getRecordLength()
        The defined length of the record.
        Returns:
        the length of the record in characters

      • getFieldSize

        public int getFieldSize​(String name)
        Gets the size of the specified field.
        Parameters:
        name - the field for which to report the size. This field must exist in the schema.
        Returns:
        the defined size of the field

      • getFieldOffset

        public int getFieldOffset​(String name)
        Gets the offset the the specified field from the start of the record.
        Parameters:
        name - the field for which to calculate the offset. This field must exist in the schema.
        Returns:
        the offset from the start of the record, measured in characters

      • getDefaults

        public final TextConversionDefaults getDefaults()
        Description copied from interface: RecordTextSchema
        Gets the default conversion behaviors for fields in the schema which do not explicitly define any. These include settings such as the null indicator for values and whether string values are trimmed or preserved as is.
        Specified by:
        getDefaults in interface RecordTextSchema<T extends TextDataType>
        Returns:
        the default behavior for the schema

      • getTokenType

        public final RecordTokenType getTokenType()
        Description copied from interface: RecordTextSchema
        Gets the type of the token representation of the text record. The fields of the resulting type are in the same order and have the same name as the fields in the schema.
        Specified by:
        getTokenType in interface RecordTextSchema<T extends TextDataType>
        Returns:
        the token type representing the schema

      • getFieldNames

        public final List<String> getFieldNames()
        Description copied from interface: RecordTextSchema
        Gets the names of the fields defined in the record. The names are returned in the order they were defined.
        Specified by:
        getFieldNames in interface RecordTextSchema<T extends TextDataType>
        Returns:
        a list of defined field names

      • isFieldDefined

        public final boolean isFieldDefined​(String name)
        Description copied from interface: RecordTextSchema
        Indicates whether a field with the given name is already defined.
        Specified by:
        isFieldDefined in interface RecordTextSchema<T extends TextDataType>
        Parameters:
        name - the field to check
        Returns:
        true if a field with the name is defined in the schema, false otherwise.

      • defineField

        public final void defineField​(String name,
                              T type)
        Defines a new field in the record with the specified name and type.
        Parameters:
        name - the name associated with the field. The name must be unique amongst all defined fields.
        type - specifies how to convert between text and token values

      • defineField

        public final void defineField​(String name,
                              T type,
                              FieldDomain domain)
        Defines a new field in the record with the specified name and type.
        Parameters:
        name - the name associated with the field. The name must be unique amongst all defined fields.
        type - specifies how to convert between text and token values

      • getFieldType

        public final T getFieldType​(String name)
        Description copied from interface: RecordTextSchema
        Gets the type of the specified fields in the record. The names are returned in the order they were defined.
        Specified by:
        getFieldType in interface RecordTextSchema<T extends TextDataType>
        Parameters:
        name - the field for which to fetch the type
        Returns:
        the text type of the named field

      • setFieldType

        public final void setFieldType​(String name,
                               T newType)
        Modifies the value conversion scheme for an existing field.
        Parameters:
        name - the field to modify. This field must exist in the schema.
        newType - specifies how to convert between text and token values

      • createFieldParser

        public final TokenParser createFieldParser​(String fieldName)
        Description copied from interface: RecordTextSchema
        Creates a new parser for values of the specified field.
        Specified by:
        createFieldParser in interface RecordTextSchema<T extends TextDataType>
        Parameters:
        fieldName - the field for which to obtain a parser
        Returns:
        a parser for converting text values to token values for the field

      • createFieldFormatter

        public final TokenFormatter createFieldFormatter​(String fieldName)
        Description copied from interface: RecordTextSchema
        Creates a new formatter for values of the specified field.
        Specified by:
        createFieldFormatter in interface RecordTextSchema<T extends TextDataType>
        Parameters:
        fieldName - the field for which to obtain a formatter
        Returns:
        a formatter for converting token values to text values for the field