org.apache.camel.model.dataformat

Class BeanioDataFormat

java.lang.Object

org.apache.camel.model.IdentifiedType

org.apache.camel.model.DataFormatDefinition

org.apache.camel.model.dataformat.BeanioDataFormat

All Implemented Interfaces:

DefinitionPropertyPlaceholderConfigurer, OtherAttributesAware, org.apache.camel.spi.PropertyConfigurer, org.apache.camel.spi.PropertyPlaceholderConfigurer

@Metadata(firstVersion="2.10.0",
          label="dataformat,transformation,csv",
          title="BeanIO")
public class BeanioDataFormat
extends DataFormatDefinition

The BeanIO data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats).

Constructor Summary

Constructors

Constructor and Description
BeanioDataFormat()

Method Summary

Modifier and Type	Method and Description
String	getBeanReaderErrorHandlerType()
String	getEncoding()
Boolean	getIgnoreInvalidRecords()
Boolean	getIgnoreUnexpectedRecords()
Boolean	getIgnoreUnidentifiedRecords()
String	getMapping()
String	getStreamName()
Boolean	getUnmarshalSingleObject()
void	setBeanReaderErrorHandlerType(String beanReaderErrorHandlerType) To use a custom org.apache.camel.dataformat.beanio.BeanIOErrorHandler as error handler while parsing.
void	setEncoding(String encoding) The charset to use.
void	setIgnoreInvalidRecords(Boolean ignoreInvalidRecords) Whether to ignore invalid records.
void	setIgnoreUnexpectedRecords(Boolean ignoreUnexpectedRecords) Whether to ignore unexpected records.
void	setIgnoreUnidentifiedRecords(Boolean ignoreUnidentifiedRecords) Whether to ignore unidentified records.
void	setMapping(String mapping) The BeanIO mapping file.
void	setStreamName(String streamName) The name of the stream to use.
void	setUnmarshalSingleObject(Boolean unmarshalSingleObject) This options controls whether to unmarshal as a list of objects or as a single object only.

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

getContentTypeHeader, getDataFormat, getDataFormatName, getOtherAttributes, getShortName, setContentTypeHeader, setDataFormat, setDataFormatName, setOtherAttributes

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

Methods inherited from interface org.apache.camel.model.DefinitionPropertyPlaceholderConfigurer

getReadPropertyPlaceholderOptions, getWritePropertyPlaceholderOptions

Constructor Detail

BeanioDataFormat

public BeanioDataFormat()

Method Detail

getMapping

public String getMapping()

setMapping

public void setMapping(String mapping)

The BeanIO mapping file. Is by default loaded from the classpath. You can prefix with file:, http:, or classpath: to denote from where to load the mapping file.

getStreamName

public String getStreamName()

setStreamName

public void setStreamName(String streamName)

The name of the stream to use.

getIgnoreUnidentifiedRecords

public Boolean getIgnoreUnidentifiedRecords()

setIgnoreUnidentifiedRecords

public void setIgnoreUnidentifiedRecords(Boolean ignoreUnidentifiedRecords)

Whether to ignore unidentified records.

getIgnoreUnexpectedRecords

public Boolean getIgnoreUnexpectedRecords()

setIgnoreUnexpectedRecords

public void setIgnoreUnexpectedRecords(Boolean ignoreUnexpectedRecords)

Whether to ignore unexpected records.

getIgnoreInvalidRecords

public Boolean getIgnoreInvalidRecords()

setIgnoreInvalidRecords

public void setIgnoreInvalidRecords(Boolean ignoreInvalidRecords)

Whether to ignore invalid records.

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

The charset to use.

Is by default the JVM platform default charset.

getBeanReaderErrorHandlerType

public String getBeanReaderErrorHandlerType()

setBeanReaderErrorHandlerType

public void setBeanReaderErrorHandlerType(String beanReaderErrorHandlerType)

To use a custom org.apache.camel.dataformat.beanio.BeanIOErrorHandler as error handler while parsing. Configure the fully qualified class name of the error handler. Notice the options ignoreUnidentifiedRecords, ignoreUnexpectedRecords, and ignoreInvalidRecords may not be in use when you use a custom error handler.

getUnmarshalSingleObject

public Boolean getUnmarshalSingleObject()

setUnmarshalSingleObject

public void setUnmarshalSingleObject(Boolean unmarshalSingleObject)

This options controls whether to unmarshal as a list of objects or as a single object only. The former is the default mode, and the latter is only intended in special use-cases where beanio maps the Camel message to a single POJO bean.