Package com.aquima.interactions.framework.connectivity

Interface ICsvResourceMetadata

All Known Implementing Classes:
CsvResourceMetadata
public interface ICsvResourceMetadata
This interface describes the metadata for a CSV resource.
Since:
8.3
Author:
Jon van Leuven

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCharset()
    This method returns the charset used for decoding the csv resource.
    ICsvColumnMetadata[]
    getColumnMetadata()
    This method returns the metadata for all the columns.
    int[]
    getColumnWidths()
    This method returns the column widths for a fixed width text resource.
    char
    getDelimiter()
    This method returns the delimiter to use for separating entries.
    char
    getQuoteCharacter()
    This method returns the character to use for quoted elements.
    boolean
    hasRowHeaders()
    This method returns true if the CSV resource's first row contains the headers.
    boolean
    isFixedWidthText()
    This method returns true the resource should be parsed as a fixed width text resource.

  • Method Details

    • isFixedWidthText

      boolean isFixedWidthText()
      This method returns true the resource should be parsed as a fixed width text resource.
      Returns:
      True if it is a fixed width resource, false if it is a standard CSV resource.

    • getColumnWidths

      int[] getColumnWidths()
      This method returns the column widths for a fixed width text resource.
      Returns:
      An array of column widths.

    • getDelimiter

      char getDelimiter()
      This method returns the delimiter to use for separating entries.
      Returns:
      The delimiter to use for separating entries, may only be one character.

    • getQuoteCharacter

      char getQuoteCharacter()
      This method returns the character to use for quoted elements.
      Returns:
      The character for quoted elements.

    • hasRowHeaders

      boolean hasRowHeaders()
      This method returns true if the CSV resource's first row contains the headers.
      Returns:
      True if the first row are the headers.

    • getColumnMetadata

      ICsvColumnMetadata[] getColumnMetadata()
      This method returns the metadata for all the columns.
      Returns:
      All the columns metadata objects, never null.

    • getCharset

      String getCharset()
      This method returns the charset used for decoding the csv resource.
      Returns:
      Charset defined, or null.