org.apache.camel.model.dataformat

Class UniVocityAbstractDataFormat

java.lang.Object

org.apache.camel.model.IdentifiedType

org.apache.camel.model.DataFormatDefinition

org.apache.camel.model.dataformat.UniVocityAbstractDataFormat

All Implemented Interfaces:

OtherAttributesAware

Direct Known Subclasses:

UniVocityCsvDataFormat, UniVocityFixedWidthDataFormat, UniVocityTsvDataFormat

@Metadata(label="dataformat,transformation,csv",
          title="uniVocity")
public abstract class UniVocityAbstractDataFormat
extends DataFormatDefinition

Represents the common parts of all uniVocity DataFormat parsers.

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	asMap
protected String	comment
protected String	emptyValue
protected Boolean	headerExtractionEnabled
protected List<UniVocityHeader>	headers
protected Boolean	headersDisabled
protected Boolean	ignoreLeadingWhitespaces
protected Boolean	ignoreTrailingWhitespaces
protected Boolean	lazyLoad
protected String	lineSeparator
protected String	normalizedLineSeparator
protected String	nullValue
protected Integer	numberOfRecordsToRead
protected Boolean	skipEmptyLines

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UniVocityAbstractDataFormat()
protected	UniVocityAbstractDataFormat(String dataFormatName)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureDataFormat(DataFormat dataFormat, CamelContext camelContext) Allows derived classes to customize the data format
Boolean	getAsMap()
String	getComment()
String	getEmptyValue()
Boolean	getHeaderExtractionEnabled()
List<UniVocityHeader>	getHeaders()
Boolean	getHeadersDisabled()
Boolean	getIgnoreLeadingWhitespaces()
Boolean	getIgnoreTrailingWhitespaces()
Boolean	getLazyLoad()
String	getLineSeparator()
String	getNormalizedLineSeparator()
String	getNullValue()
Integer	getNumberOfRecordsToRead()
Boolean	getSkipEmptyLines()
void	setAsMap(Boolean asMap) Whether the unmarshalling should produce maps for the lines values instead of lists.
void	setComment(String comment) The comment symbol.
void	setEmptyValue(String emptyValue) The String representation of an empty value
void	setHeaderExtractionEnabled(Boolean headerExtractionEnabled) Whether or not the header must be read in the first line of the test document The default value is false
void	setHeaders(List<UniVocityHeader> headers) The headers to use.
void	setHeadersDisabled(Boolean headersDisabled) Whether or not the headers are disabled.
void	setIgnoreLeadingWhitespaces(Boolean ignoreLeadingWhitespaces) Whether or not the leading white spaces must be ignored.
void	setIgnoreTrailingWhitespaces(Boolean ignoreTrailingWhitespaces) Whether or not the trailing white spaces must ignored.
void	setLazyLoad(Boolean lazyLoad) Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one.
void	setLineSeparator(String lineSeparator) The line separator of the files The default value is to use the JVM platform line separator
void	setNormalizedLineSeparator(String normalizedLineSeparator) The normalized line separator of the files The default value is \n
void	setNullValue(String nullValue) The string representation of a null value.
void	setNumberOfRecordsToRead(Integer numberOfRecordsToRead) The maximum number of record to read.
void	setSkipEmptyLines(Boolean skipEmptyLines) Whether or not the empty lines must be ignored.
protected static Character	singleCharOf(String attributeName, String string)

Methods inherited from class org.apache.camel.model.DataFormatDefinition

configureDataFormat, createDataFormat, getDataFormat, getDataFormat, getDataFormat, getDataFormatName, getOtherAttributes, getShortName, setDataFormat, setDataFormatName, setOtherAttributes, setProperty, setProperty

Methods inherited from class org.apache.camel.model.IdentifiedType

getId, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nullValue

protected String nullValue

skipEmptyLines

@Metadata(defaultValue="true")
protected Boolean skipEmptyLines

ignoreTrailingWhitespaces

@Metadata(defaultValue="true")
protected Boolean ignoreTrailingWhitespaces

ignoreLeadingWhitespaces

@Metadata(defaultValue="true")
protected Boolean ignoreLeadingWhitespaces

headersDisabled

protected Boolean headersDisabled

headers

protected List<UniVocityHeader> headers

headerExtractionEnabled

protected Boolean headerExtractionEnabled

numberOfRecordsToRead

protected Integer numberOfRecordsToRead

emptyValue

protected String emptyValue

lineSeparator

protected String lineSeparator

normalizedLineSeparator

@Metadata(defaultValue="\\n")
protected String normalizedLineSeparator

comment

@Metadata(defaultValue="#")
protected String comment

lazyLoad

protected Boolean lazyLoad

asMap

protected Boolean asMap

Constructor Detail

UniVocityAbstractDataFormat

protected UniVocityAbstractDataFormat()

UniVocityAbstractDataFormat

protected UniVocityAbstractDataFormat(String dataFormatName)

Method Detail

getNullValue

public String getNullValue()

setNullValue

public void setNullValue(String nullValue)

The string representation of a null value.

The default value is null

getSkipEmptyLines

public Boolean getSkipEmptyLines()

setSkipEmptyLines

public void setSkipEmptyLines(Boolean skipEmptyLines)

Whether or not the empty lines must be ignored.

The default value is true

getIgnoreTrailingWhitespaces

public Boolean getIgnoreTrailingWhitespaces()

setIgnoreTrailingWhitespaces

public void setIgnoreTrailingWhitespaces(Boolean ignoreTrailingWhitespaces)

Whether or not the trailing white spaces must ignored.

The default value is true

getIgnoreLeadingWhitespaces

public Boolean getIgnoreLeadingWhitespaces()

setIgnoreLeadingWhitespaces

public void setIgnoreLeadingWhitespaces(Boolean ignoreLeadingWhitespaces)

Whether or not the leading white spaces must be ignored.

The default value is true

getHeadersDisabled

public Boolean getHeadersDisabled()

setHeadersDisabled

public void setHeadersDisabled(Boolean 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 Boolean getHeaderExtractionEnabled()

setHeaderExtractionEnabled

public void setHeaderExtractionEnabled(Boolean headerExtractionEnabled)

Whether or not the header must be read in the first line of the test document

The default value is false

getNumberOfRecordsToRead

public Integer getNumberOfRecordsToRead()

setNumberOfRecordsToRead

public void setNumberOfRecordsToRead(Integer 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 \n

getComment

public String getComment()

setComment

public void setComment(String comment)

The comment symbol.

The default value is #

getLazyLoad

public Boolean getLazyLoad()

setLazyLoad

public void setLazyLoad(Boolean lazyLoad)

Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one.

The default value is false

getAsMap

public Boolean getAsMap()

setAsMap

public void setAsMap(Boolean 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

configureDataFormat

protected void configureDataFormat(DataFormat dataFormat,
                       CamelContext camelContext)

Description copied from class: DataFormatDefinition

Allows derived classes to customize the data format

Overrides:

configureDataFormat in class DataFormatDefinition

singleCharOf

protected static Character singleCharOf(String attributeName,
                     String string)