@Metadata(firstVersion="1.3.0", label="dataformat,transformation,csv", title="CSV") public class CsvDataFormat extends DataFormatDefinition
Constructor and Description |
---|
CsvDataFormat() |
CsvDataFormat(boolean lazyLoad) |
CsvDataFormat(String delimiter) |
Modifier and Type | Method and Description |
---|---|
protected void |
configureDataFormat(DataFormat dataFormat,
CamelContext camelContext)
Allows derived classes to customize the data format
|
Boolean |
getAllowMissingColumnNames() |
String |
getCommentMarker() |
Boolean |
getCommentMarkerDisabled() |
String |
getDelimiter() |
String |
getEscape() |
Boolean |
getEscapeDisabled() |
String |
getFormatName() |
String |
getFormatRef() |
List<String> |
getHeader() |
Boolean |
getHeaderDisabled()
Use for disabling headers
|
Boolean |
getIgnoreEmptyLines() |
Boolean |
getIgnoreHeaderCase() |
Boolean |
getIgnoreSurroundingSpaces() |
Boolean |
getLazyLoad() |
String |
getNullString() |
Boolean |
getNullStringDisabled() |
String |
getQuote() |
Boolean |
getQuoteDisabled() |
String |
getQuoteMode() |
String |
getRecordConverterRef() |
String |
getRecordSeparator() |
String |
getRecordSeparatorDisabled() |
Boolean |
getSkipHeaderRecord() |
Boolean |
getTrailingDelimiter() |
Boolean |
getTrim() |
Boolean |
getUseMaps() |
Boolean |
getUseOrderedMaps() |
void |
setAllowMissingColumnNames(Boolean allowMissingColumnNames)
Whether to allow missing column names.
|
void |
setCommentMarker(String commentMarker)
Sets the comment marker of the reference format.
|
void |
setCommentMarkerDisabled(Boolean commentMarkerDisabled)
Disables the comment marker of the reference format.
|
void |
setDelimiter(String delimiter)
Sets the delimiter to use.
|
void |
setEscape(String escape)
Sets the escape character to use
|
void |
setEscapeDisabled(Boolean escapeDisabled)
Use for disabling using escape character
|
void |
setFormatName(String formatName)
The name of the format to use, the default value is CSVFormat.DEFAULT
|
void |
setFormatRef(String formatRef)
The reference format to use, it will be updated with the other format options, the default value is CSVFormat.DEFAULT
|
void |
setHeader(List<String> header)
To configure the CSV headers
|
void |
setHeaderDisabled(Boolean headerDisabled) |
void |
setIgnoreEmptyLines(Boolean ignoreEmptyLines)
Whether to ignore empty lines.
|
void |
setIgnoreHeaderCase(Boolean ignoreHeaderCase)
Sets whether or not to ignore case when accessing header names.
|
void |
setIgnoreSurroundingSpaces(Boolean ignoreSurroundingSpaces)
Whether to ignore surrounding spaces
|
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 |
setNullString(String nullString)
Sets the null string
|
void |
setNullStringDisabled(Boolean nullStringDisabled)
Used to disable null strings
|
void |
setQuote(String quote)
Sets the quote which by default is "
|
void |
setQuoteDisabled(Boolean quoteDisabled)
Used to disable quotes
|
void |
setQuoteMode(String quoteMode)
Sets the quote mode
|
void |
setRecordConverterRef(String recordConverterRef)
Refers to a custom CsvRecordConverter to lookup from the registry to use.
|
void |
setRecordSeparator(String recordSeparator)
Sets the record separator (aka new line) which by default is new line characters (CRLF)
|
void |
setRecordSeparatorDisabled(String recordSeparatorDisabled)
Used for disabling record separator
|
void |
setSkipHeaderRecord(Boolean skipHeaderRecord)
Whether to skip the header record in the output
|
void |
setTrailingDelimiter(Boolean trailingDelimiter)
Sets whether or not to add a trailing delimiter.
|
void |
setTrim(Boolean trim)
Sets whether or not to trim leading and trailing blanks.
|
void |
setUseMaps(Boolean useMaps)
Whether the unmarshalling should produce maps (HashMap)for the lines values instead of lists.
|
void |
setUseOrderedMaps(Boolean useOrderedMaps)
Whether the unmarshalling should produce ordered maps (LinkedHashMap) for the lines values instead of lists.
|
configureDataFormat, createDataFormat, getContentTypeHeader, getDataFormat, getDataFormat, getDataFormat, getDataFormatName, getOtherAttributes, getShortName, setContentTypeHeader, setDataFormat, setDataFormatName, setOtherAttributes, setProperty, setProperty
getId, setId
public CsvDataFormat()
public CsvDataFormat(String delimiter)
public CsvDataFormat(boolean lazyLoad)
protected void configureDataFormat(DataFormat dataFormat, CamelContext camelContext)
DataFormatDefinition
configureDataFormat
in class DataFormatDefinition
public String getFormatRef()
public void setFormatRef(String formatRef)
public String getFormatName()
public void setFormatName(String formatName)
public Boolean getCommentMarkerDisabled()
public void setCommentMarkerDisabled(Boolean commentMarkerDisabled)
public String getCommentMarker()
public void setCommentMarker(String commentMarker)
public String getDelimiter()
public void setDelimiter(String delimiter)
public Boolean getEscapeDisabled()
public void setEscapeDisabled(Boolean escapeDisabled)
public Boolean getHeaderDisabled()
public void setHeaderDisabled(Boolean headerDisabled)
public Boolean getAllowMissingColumnNames()
public void setAllowMissingColumnNames(Boolean allowMissingColumnNames)
public Boolean getIgnoreEmptyLines()
public void setIgnoreEmptyLines(Boolean ignoreEmptyLines)
public Boolean getIgnoreSurroundingSpaces()
public void setIgnoreSurroundingSpaces(Boolean ignoreSurroundingSpaces)
public Boolean getNullStringDisabled()
public void setNullStringDisabled(Boolean nullStringDisabled)
public String getNullString()
public void setNullString(String nullString)
public Boolean getQuoteDisabled()
public void setQuoteDisabled(Boolean quoteDisabled)
public String getRecordSeparatorDisabled()
public void setRecordSeparatorDisabled(String recordSeparatorDisabled)
public String getRecordSeparator()
public void setRecordSeparator(String recordSeparator)
public Boolean getSkipHeaderRecord()
public void setSkipHeaderRecord(Boolean skipHeaderRecord)
public String getQuoteMode()
public void setQuoteMode(String quoteMode)
public Boolean getLazyLoad()
public void setLazyLoad(Boolean lazyLoad)
public Boolean getUseMaps()
public void setUseMaps(Boolean useMaps)
public Boolean getUseOrderedMaps()
public void setUseOrderedMaps(Boolean useOrderedMaps)
public String getRecordConverterRef()
public void setRecordConverterRef(String recordConverterRef)
public void setIgnoreHeaderCase(Boolean ignoreHeaderCase)
public Boolean getIgnoreHeaderCase()
public void setTrailingDelimiter(Boolean trailingDelimiter)
public Boolean getTrailingDelimiter()
Apache Camel