Class UniVocityAbstractDataFormat

java.lang.Object
org.apache.camel.model.IdentifiedType
org.apache.camel.model.DataFormatDefinition
org.apache.camel.model.dataformat.UniVocityAbstractDataFormat
Direct Known Subclasses:
UniVocityCsvDataFormat, UniVocityFixedDataFormat, UniVocityTsvDataFormat

@Metadata(label="dataformat,transformation,csv", title="uniVocity") public abstract class UniVocityAbstractDataFormat extends DataFormatDefinition
Represents the common parts of all uniVocity DataFormat parsers.
  • Field Details

    • nullValue

      @Metadata(label="advanced") protected String nullValue
    • skipEmptyLines

      @Metadata(javaType="java.lang.Boolean", defaultValue="true") protected String skipEmptyLines
    • ignoreTrailingWhitespaces

      @Metadata(javaType="java.lang.Boolean", defaultValue="true") protected String ignoreTrailingWhitespaces
    • ignoreLeadingWhitespaces

      @Metadata(javaType="java.lang.Boolean", defaultValue="true") protected String ignoreLeadingWhitespaces
    • headersDisabled

      @Metadata(javaType="java.lang.Boolean") protected String headersDisabled
    • headers

      protected List<UniVocityHeader> headers
    • headerExtractionEnabled

      @Metadata(javaType="java.lang.Boolean") protected String headerExtractionEnabled
    • numberOfRecordsToRead

      @Metadata(label="advanced", javaType="java.lang.Integer") protected String numberOfRecordsToRead
    • emptyValue

      @Metadata(label="advanced") protected String emptyValue
    • lineSeparator

      @Metadata(label="advanced") protected String lineSeparator
    • normalizedLineSeparator

      @Metadata(label="advanced") protected String normalizedLineSeparator
    • comment

      @Metadata(label="advanced", defaultValue="#") protected String comment
    • lazyLoad

      @Metadata(javaType="java.lang.Boolean") protected String lazyLoad
    • asMap

      @Metadata(javaType="java.lang.Boolean") protected String asMap
  • Constructor Details

    • UniVocityAbstractDataFormat

      protected UniVocityAbstractDataFormat()
    • UniVocityAbstractDataFormat

      protected UniVocityAbstractDataFormat(String dataFormatName)
    • UniVocityAbstractDataFormat

      protected UniVocityAbstractDataFormat(String dataFormatName, org.apache.camel.model.dataformat.UniVocityAbstractDataFormat.AbstractBuilder<?,?> builder)
  • Method Details

    • getNullValue

      public String getNullValue()
    • setNullValue

      public void setNullValue(String nullValue)
      The string representation of a null value.

      The default value is null

    • getSkipEmptyLines

      public String getSkipEmptyLines()
    • setSkipEmptyLines

      public void setSkipEmptyLines(String skipEmptyLines)
      Whether or not the empty lines must be ignored.

      The default value is true

    • getIgnoreTrailingWhitespaces

      public String getIgnoreTrailingWhitespaces()
    • setIgnoreTrailingWhitespaces

      public void setIgnoreTrailingWhitespaces(String ignoreTrailingWhitespaces)
      Whether or not the trailing white spaces must be ignored.

      The default value is true

    • getIgnoreLeadingWhitespaces

      public String getIgnoreLeadingWhitespaces()
    • setIgnoreLeadingWhitespaces

      public void setIgnoreLeadingWhitespaces(String ignoreLeadingWhitespaces)
      Whether or not the leading white spaces must be ignored.

      The default value is true

    • getHeadersDisabled

      public String getHeadersDisabled()
    • setHeadersDisabled

      public void setHeadersDisabled(String headersDisabled)
      Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header.

      The default value is false

    • getHeaders

      public List<UniVocityHeader> getHeaders()
    • setHeaders

      public void setHeaders(List<UniVocityHeader> headers)
      The headers to use.
    • getHeaderExtractionEnabled

      public String getHeaderExtractionEnabled()
    • setHeaderExtractionEnabled

      public void setHeaderExtractionEnabled(String headerExtractionEnabled)
      Whether or not the header must be read in the first line of the test document.

      The default value is false

    • getNumberOfRecordsToRead

      public String getNumberOfRecordsToRead()
    • setNumberOfRecordsToRead

      public void setNumberOfRecordsToRead(String numberOfRecordsToRead)
      The maximum number of record to read.
    • getEmptyValue

      public String getEmptyValue()
    • setEmptyValue

      public void setEmptyValue(String emptyValue)
      The String representation of an empty value.
    • getLineSeparator

      public String getLineSeparator()
    • setLineSeparator

      public void setLineSeparator(String lineSeparator)
      The line separator of the files.

      The default value is to use the JVM platform line separator

    • getNormalizedLineSeparator

      public String getNormalizedLineSeparator()
    • setNormalizedLineSeparator

      public void setNormalizedLineSeparator(String normalizedLineSeparator)
      The normalized line separator of the files.

      The default value is a new line character.

    • getComment

      public String getComment()
    • setComment

      public void setComment(String comment)
      The comment symbol.

      The default value is #

    • getLazyLoad

      public String getLazyLoad()
    • setLazyLoad

      public void setLazyLoad(String lazyLoad)
      Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at once.

      The default value is false

    • getAsMap

      public String getAsMap()
    • setAsMap

      public void setAsMap(String asMap)
      Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected).

      The default value is false