Class UniVocityCsvDataFormat
- java.lang.Object
-
- org.apache.camel.support.service.BaseService
-
- org.apache.camel.support.service.ServiceSupport
-
- org.apache.camel.dataformat.univocity.AbstractUniVocityDataFormat<com.univocity.parsers.csv.CsvFormat,com.univocity.parsers.csv.CsvWriterSettings,com.univocity.parsers.csv.CsvWriter,com.univocity.parsers.csv.CsvParserSettings,com.univocity.parsers.csv.CsvParser,UniVocityCsvDataFormat>
-
- org.apache.camel.dataformat.univocity.UniVocityCsvDataFormat
-
- All Implemented Interfaces:
AutoCloseable
,org.apache.camel.Service
,org.apache.camel.ShutdownableService
,org.apache.camel.spi.DataFormat
,org.apache.camel.spi.DataFormatName
,org.apache.camel.StatefulService
,org.apache.camel.SuspendableService
@Dataformat("univocity-csv") public class UniVocityCsvDataFormat extends AbstractUniVocityDataFormat<com.univocity.parsers.csv.CsvFormat,com.univocity.parsers.csv.CsvWriterSettings,com.univocity.parsers.csv.CsvWriter,com.univocity.parsers.csv.CsvParserSettings,com.univocity.parsers.csv.CsvParser,UniVocityCsvDataFormat>
This class is the data format that uses the CSV uniVocity parser.
-
-
Field Summary
Fields Modifier and Type Field Description protected Character
delimiter
protected Character
quote
protected Boolean
quoteAllFields
protected Character
quoteEscape
-
Fields inherited from class org.apache.camel.dataformat.univocity.AbstractUniVocityDataFormat
asMap, comment, emptyValue, headerExtractionEnabled, headers, headersDisabled, ignoreLeadingWhitespaces, ignoreTrailingWhitespaces, lazyLoad, lineSeparator, normalizedLineSeparator, nullValue, numberOfRecordsToRead, skipEmptyLines
-
-
Constructor Summary
Constructors Constructor Description UniVocityCsvDataFormat()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
configureFormat(com.univocity.parsers.csv.CsvFormat format)
Configures the format.protected void
configureParserSettings(com.univocity.parsers.csv.CsvParserSettings settings)
Configure the parser settings.protected void
configureWriterSettings(com.univocity.parsers.csv.CsvWriterSettings settings)
Configures the writer settings.protected com.univocity.parsers.csv.CsvParser
createParser(com.univocity.parsers.csv.CsvParserSettings settings)
Creates a new instance of the uniVocity parser.protected com.univocity.parsers.csv.CsvParserSettings
createParserSettings()
Creates a new instance of the parser settings.protected com.univocity.parsers.csv.CsvWriter
createWriter(Writer writer, com.univocity.parsers.csv.CsvWriterSettings settings)
Creates a new instance of the uniVocity writer.protected com.univocity.parsers.csv.CsvWriterSettings
createWriterSettings()
Creates a new instance of the writer settings.String
getDataFormatName()
Character
getDelimiter()
Gets the delimiter symbol.Character
getQuote()
Gets the quote symbol.Boolean
getQuoteAllFields()
Gets whether or not all fields must be quoted.Character
getQuoteEscape()
Gets the quote escape symbol.UniVocityCsvDataFormat
setDelimiter(Character delimiter)
Sets the delimiter symbol.UniVocityCsvDataFormat
setQuote(Character quote)
Sets the quote symbol.UniVocityCsvDataFormat
setQuoteAllFields(Boolean quoteAllFields)
Gets whether or not all fields must be quoted.UniVocityCsvDataFormat
setQuoteEscape(Character quoteEscape)
Sets the quote escape symbol.-
Methods inherited from class org.apache.camel.dataformat.univocity.AbstractUniVocityDataFormat
doStart, doStop, getComment, getEmptyValue, getHeaderExtractionEnabled, getHeaders, getIgnoreLeadingWhitespaces, getIgnoreTrailingWhitespaces, getLineSeparator, getNormalizedLineSeparator, getNullValue, getNumberOfRecordsToRead, getSkipEmptyLines, isAsMap, isHeadersDisabled, isLazyLoad, marshal, setAsMap, setComment, setEmptyValue, setHeaderExtractionEnabled, setHeaders, setHeadersDisabled, setIgnoreLeadingWhitespaces, setIgnoreTrailingWhitespaces, setLazyLoad, setLineSeparator, setNormalizedLineSeparator, setNullValue, setNumberOfRecordsToRead, setSkipEmptyLines, unmarshal
-
Methods inherited from class org.apache.camel.support.service.BaseService
build, doBuild, doFail, doInit, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Method Detail
-
getQuoteAllFields
public Boolean getQuoteAllFields()
Gets whether or not all fields must be quoted. Ifnull
then the default settings value is used.- Returns:
- whether or not all fields must be quoted
- See Also:
CsvWriterSettings.getQuoteAllFields()
-
setQuoteAllFields
public UniVocityCsvDataFormat setQuoteAllFields(Boolean quoteAllFields)
Gets whether or not all fields must be quoted. Ifnull
then the default settings value is used.- Parameters:
quoteAllFields
- whether or not all fields must be quoted- Returns:
- current data format instance, fluent API
- See Also:
CsvWriterSettings.setQuoteAllFields(boolean)
-
getQuote
public Character getQuote()
Gets the quote symbol. Ifnull
then the default format value is used.- Returns:
- the quote symbol
- See Also:
CsvFormat.getQuote()
-
setQuote
public UniVocityCsvDataFormat setQuote(Character quote)
Sets the quote symbol. Ifnull
then the default format value is used.- Parameters:
quote
- the quote symbol- Returns:
- current data format instance, fluent API
- See Also:
CsvFormat.setQuote(char)
-
getQuoteEscape
public Character getQuoteEscape()
Gets the quote escape symbol. Ifnull
then the default format value is used.- Returns:
- the quote escape symbol
- See Also:
CsvFormat.getQuoteEscape()
-
setQuoteEscape
public UniVocityCsvDataFormat setQuoteEscape(Character quoteEscape)
Sets the quote escape symbol. Ifnull
then the default format value is used.- Parameters:
quoteEscape
- the quote escape symbol- Returns:
- current data format instance, fluent API
- See Also:
CsvFormat.setQuoteEscape(char)
-
getDelimiter
public Character getDelimiter()
Gets the delimiter symbol. Ifnull
then the default format value is used.- Returns:
- the delimiter symbol
- See Also:
CsvFormat.getDelimiter()
-
setDelimiter
public UniVocityCsvDataFormat setDelimiter(Character delimiter)
Sets the delimiter symbol. Ifnull
then the default format value is used.- Parameters:
delimiter
- the delimiter symbol- Returns:
- current data format instance, fluent API
- See Also:
CsvFormat.setDelimiter(char)
-
createWriterSettings
protected com.univocity.parsers.csv.CsvWriterSettings createWriterSettings()
Creates a new instance of the writer settings.- Specified by:
createWriterSettings
in classAbstractUniVocityDataFormat<com.univocity.parsers.csv.CsvFormat,com.univocity.parsers.csv.CsvWriterSettings,com.univocity.parsers.csv.CsvWriter,com.univocity.parsers.csv.CsvParserSettings,com.univocity.parsers.csv.CsvParser,UniVocityCsvDataFormat>
- Returns:
- New instance of the writer settings
-
configureWriterSettings
protected void configureWriterSettings(com.univocity.parsers.csv.CsvWriterSettings settings)
Configures the writer settings.- Overrides:
configureWriterSettings
in classAbstractUniVocityDataFormat<com.univocity.parsers.csv.CsvFormat,com.univocity.parsers.csv.CsvWriterSettings,com.univocity.parsers.csv.CsvWriter,com.univocity.parsers.csv.CsvParserSettings,com.univocity.parsers.csv.CsvParser,UniVocityCsvDataFormat>
- Parameters:
settings
- Writer settings to configure
-
createWriter
protected com.univocity.parsers.csv.CsvWriter createWriter(Writer writer, com.univocity.parsers.csv.CsvWriterSettings settings)
Creates a new instance of the uniVocity writer.- Specified by:
createWriter
in classAbstractUniVocityDataFormat<com.univocity.parsers.csv.CsvFormat,com.univocity.parsers.csv.CsvWriterSettings,com.univocity.parsers.csv.CsvWriter,com.univocity.parsers.csv.CsvParserSettings,com.univocity.parsers.csv.CsvParser,UniVocityCsvDataFormat>
- Parameters:
writer
- Output writer to usesettings
- Writer settings to use- Returns:
- New uinstance of the uniVocity writer
-
createParserSettings
protected com.univocity.parsers.csv.CsvParserSettings createParserSettings()
Creates a new instance of the parser settings.- Specified by:
createParserSettings
in classAbstractUniVocityDataFormat<com.univocity.parsers.csv.CsvFormat,com.univocity.parsers.csv.CsvWriterSettings,com.univocity.parsers.csv.CsvWriter,com.univocity.parsers.csv.CsvParserSettings,com.univocity.parsers.csv.CsvParser,UniVocityCsvDataFormat>
- Returns:
- New instance of the parser settings
-
configureParserSettings
protected void configureParserSettings(com.univocity.parsers.csv.CsvParserSettings settings)
Configure the parser settings.- Overrides:
configureParserSettings
in classAbstractUniVocityDataFormat<com.univocity.parsers.csv.CsvFormat,com.univocity.parsers.csv.CsvWriterSettings,com.univocity.parsers.csv.CsvWriter,com.univocity.parsers.csv.CsvParserSettings,com.univocity.parsers.csv.CsvParser,UniVocityCsvDataFormat>
- Parameters:
settings
- Parser settings to configure
-
createParser
protected com.univocity.parsers.csv.CsvParser createParser(com.univocity.parsers.csv.CsvParserSettings settings)
Creates a new instance of the uniVocity parser.- Specified by:
createParser
in classAbstractUniVocityDataFormat<com.univocity.parsers.csv.CsvFormat,com.univocity.parsers.csv.CsvWriterSettings,com.univocity.parsers.csv.CsvWriter,com.univocity.parsers.csv.CsvParserSettings,com.univocity.parsers.csv.CsvParser,UniVocityCsvDataFormat>
- Parameters:
settings
- Parser settings to use- Returns:
- New instance of the uniVocity parser
-
configureFormat
protected void configureFormat(com.univocity.parsers.csv.CsvFormat format)
Configures the format.- Overrides:
configureFormat
in classAbstractUniVocityDataFormat<com.univocity.parsers.csv.CsvFormat,com.univocity.parsers.csv.CsvWriterSettings,com.univocity.parsers.csv.CsvWriter,com.univocity.parsers.csv.CsvParserSettings,com.univocity.parsers.csv.CsvParser,UniVocityCsvDataFormat>
- Parameters:
format
- format to configure
-
getDataFormatName
public String getDataFormatName()
-
-