Interface RecordMetaData

public interface RecordMetaData
Metadata with information about Records parsed from the input.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsColumn(String headerName)
    Queries whether a given header name exists in the Records parsed from the input
    FieldSet<String>
    convertFields(Conversion... conversions)
    Associates a sequence of Conversions to fields of a given set of field names
    <T extends Enum<T>>
    FieldSet<T>
    convertFields(Class<T> enumType, Conversion... conversions)
    Associates a sequence of Conversions to fields of a given set of fields
    FieldSet<Integer>
    convertIndexes(Conversion... conversions)
    Associates a sequence of Conversions to fields of a given set of column indexes
    Object
    defaultValueOf(int columnIndex)
    Returns the default value associated with a column (defined using setDefaultValueOf(Column, Object))
    Object
    defaultValueOf(Enum<?> column)
    Returns the default value associated with a column (defined using setDefaultValueOf(Column, Object))
    Object
    defaultValueOf(String headerName)
    Returns the default value associated with a column (defined using setDefaultValueOf(Column, Object))
    String[]
    headers()
    Returns the column names of the Records parsed from the input.
    int
    indexOf(Enum<?> column)
    Returns the index of a given column
    int
    indexOf(String headerName)
    Returns the index of a given column
    String[]
    selectedHeaders()
    Returns the sequence of headers that have been selected.
    <T> void
    setDefaultValueOfColumns(T defaultValue, int... columnIndexes)
    Associates a default value with one or more columns, in case the values contained are null
    <T> void
    setDefaultValueOfColumns(T defaultValue, Enum<?>... columns)
    Associates a default value with one or more columns, in case the values contained are null
    <T> void
    setDefaultValueOfColumns(T defaultValue, String... headerNames)
    Associates a default value with one or more columns, in case the values contained are null
    void
    setTypeOfColumns(Class<?> type, int... columnIndexes)
    Associates a type with one or more column.
    void
    setTypeOfColumns(Class<?> type, Enum... columns)
    Associates a type with one or more column.
    void
    setTypeOfColumns(Class<?> type, String... headerNames)
    Associates a type with one or more column.
    Class<?>
    typeOf(int columnIndex)
    Returns the type associated with a given column, defined with the method setTypeOfColumns(type, columns)
    Class<?>
    typeOf(Enum<?> column)
    Returns the type associated with a given column, defined with the method setTypeOfColumns(type, columns)
    Class<?>
    typeOf(String headerName)
    Returns the type associated with a given column name, defined with the method setTypeOfColumns(type, columns)

  • Method Details

    • indexOf

      int indexOf(Enum<?> column)
      Returns the index of a given column
      Parameters:
      column - the column whose index will be returned
      Returns:
      index of the given column

    • indexOf

      int indexOf(String headerName)
      Returns the index of a given column
      Parameters:
      headerName - name of the column whose index will be returned
      Returns:
      index of the given column

    • typeOf

      Class<?> typeOf(Enum<?> column)
      Returns the type associated with a given column, defined with the method setTypeOfColumns(type, columns)
      Parameters:
      column - the column whose type will be returned
      Returns:
      the type of the given column

    • typeOf

      Class<?> typeOf(String headerName)
      Returns the type associated with a given column name, defined with the method setTypeOfColumns(type, columns)
      Parameters:
      headerName - name of the column whose type will be returned
      Returns:
      the type of the given column

    • typeOf

      Class<?> typeOf(int columnIndex)
      Returns the type associated with a given column, defined with the method setTypeOfColumns(type, columns)
      Parameters:
      columnIndex - the position of the column whose type will be returned
      Returns:
      the type of the given column

    • setTypeOfColumns

      void setTypeOfColumns(Class<?> type, Enum... columns)
      Associates a type with one or more column. This allows the parsed data to be converted automatically to the given type when reading data from a Record, e.g. Record.toFieldObjectMap(String...) will convert the selected field values to their respective types, and then set the result as the values in the map.
      Parameters:
      type - the type to associate with a list of column
      columns - the columns that will be associated with the given type.

    • setTypeOfColumns

      void setTypeOfColumns(Class<?> type, String... headerNames)
      Associates a type with one or more column. This allows the parsed data to be converted automatically to the given type when reading data from a Record, e.g. Record.toFieldObjectMap(String...) will convert the selected field values to their respective types, and then set the result as the values in the map.
      Parameters:
      type - the type to associate with a list of column
      headerNames - the columns that will be associated with the given type.

    • setTypeOfColumns

      void setTypeOfColumns(Class<?> type, int... columnIndexes)
      Associates a type with one or more column. This allows the parsed data to be converted automatically to the given type when reading data from a Record, e.g. Record.toFieldObjectMap(String...) will convert the selected field values to their respective types, and then set the result as the values in the map.
      Parameters:
      type - the type to associate with a list of column
      columnIndexes - the columns that will be associated with the given type.

    • setDefaultValueOfColumns

      <T> void setDefaultValueOfColumns(T defaultValue, Enum<?>... columns)
      Associates a default value with one or more columns, in case the values contained are null
      Type Parameters:
      T - type of the default value.
      Parameters:
      defaultValue - the value to be used for the given column when the parsed result is null
      columns - the columns to be associated with a default value.

    • setDefaultValueOfColumns

      <T> void setDefaultValueOfColumns(T defaultValue, String... headerNames)
      Associates a default value with one or more columns, in case the values contained are null
      Type Parameters:
      T - type of the default value.
      Parameters:
      defaultValue - the value to be used for the given column when the parsed result is null
      headerNames - the column names to be associated with a default value.

    • setDefaultValueOfColumns

      <T> void setDefaultValueOfColumns(T defaultValue, int... columnIndexes)
      Associates a default value with one or more columns, in case the values contained are null
      Type Parameters:
      T - type of the default value.
      Parameters:
      defaultValue - the value to be used for the given column when the parsed result is null
      columnIndexes - the column indexes to be associated with a default value.

    • defaultValueOf

      Object defaultValueOf(Enum<?> column)
      Returns the default value associated with a column (defined using setDefaultValueOf(Column, Object))
      Parameters:
      column - the column whose default value will be returned
      Returns:
      the default value associated with the given column or null.

    • defaultValueOf

      Object defaultValueOf(String headerName)
      Returns the default value associated with a column (defined using setDefaultValueOf(Column, Object))
      Parameters:
      headerName - the column name whose default value will be returned
      Returns:
      the default value associated with the given column or null.

    • defaultValueOf

      Object defaultValueOf(int columnIndex)
      Returns the default value associated with a column (defined using setDefaultValueOf(Column, Object))
      Parameters:
      columnIndex - the column index whose default value will be returned
      Returns:
      the default value associated with the given column or null.

    • convertFields

      <T extends Enum<T>> FieldSet<T> convertFields(Class<T> enumType, Conversion... conversions)
      Associates a sequence of Conversions to fields of a given set of fields
      Type Parameters:
      T - the enumeration type
      Parameters:
      enumType - the type of the enumeration whose values represent headers in the input Records
      conversions - the sequence of conversions to apply
      Returns:
      (modifiable) set of fields to be selected and against which the given conversion sequence will be applied.

    • convertFields

      FieldSet<String> convertFields(Conversion... conversions)
      Associates a sequence of Conversions to fields of a given set of field names
      Parameters:
      conversions - the sequence of conversions to apply
      Returns:
      (modifiable) set of fields names to be selected and against which the given conversion sequence will be applied.

    • convertIndexes

      FieldSet<Integer> convertIndexes(Conversion... conversions)
      Associates a sequence of Conversions to fields of a given set of column indexes
      Parameters:
      conversions - the sequence of conversions to apply
      Returns:
      (modifiable) set of column indexes to be selected and against which the given conversion sequence will be applied.

    • headers

      String[] headers()
      Returns the column names of the Records parsed from the input.

      If the headers are extracted from the input (i.e. CommonParserSettings.isHeaderExtractionEnabled() == true), then these values will be returned.

      If no headers are extracted from the input, then the configured headers in CommonSettings.getHeaders() will be returned.

      Returns:
      the headers associated with the Records parsed from the input

    • selectedHeaders

      String[] selectedHeaders()
      Returns the sequence of headers that have been selected. If no selection has been made, all available headers will be returned, producing the same output as a call to method headers().
      Returns:
      the sequence of selected headers, or all headers if no selection has been made.

    • containsColumn

      boolean containsColumn(String headerName)
      Queries whether a given header name exists in the Records parsed from the input
      Parameters:
      headerName - name of the header
      Returns:
      true if the given header name exists in the input records, otherwise false