org.jsefa.csv.config

Class CsvConfiguration

java.lang.Object

org.jsefa.common.config.Configuration<RbfTypeMappingRegistry,RbfEntryPoint>

org.jsefa.rbf.config.RbfConfiguration<CsvLowLevelConfiguration>

org.jsefa.csv.config.CsvConfiguration

public final class CsvConfiguration
extends RbfConfiguration<CsvLowLevelConfiguration>

A configuration object used when creating a CSV IO factory. It uses lazy initialization.

Author:

Norman Lahme-Huetig

See Also:

Configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CsvConfiguration.Defaults Set of default configuration values.

Constructor Summary

Constructors

Constructor and Description
CsvConfiguration() Constructs a new CsvConfiguration.

Method Summary

Methods

Modifier and Type	Method and Description
CsvConfiguration	createCopy() Creates a copy of this Configuration.
protected CsvLowLevelConfiguration	createDefaultLowLevelConfiguration() Creates the default low level configuration to be used if none is explicitly given.
String	getDefaultNoValueString() Returns the default no value string.
QuoteMode	getDefaultQuoteMode() Returns the default quote mode.
char	getEscapeCharacter() Returns the escape character.
char	getFieldDelimiter() Returns the delimiter used to separate the CSV fields.
String	getLineBreak() Returns the line break String.
char	getQuoteCharacter() Returns the quote used to surround a field.
EscapeMode	getQuoteCharacterEscapeMode() Returns the escape mode for the quote character.
boolean	getUseDelimiterAfterLastField() Returns true if the last CSV field should end with a delimiter.
void	setDefaultNoValueString(String defaultNoValueString) Sets the default no value string.
void	setDefaultQuoteMode(QuoteMode defaultQuoteMode) Sets the default quote mode.
void	setEscapeCharacter(char escapeCharacter) Sets the escape character.
void	setFieldDelimiter(char fieldDelimiter) Sets the delimiter to be used to separate the CSV fields.
void	setLineBreak(String lineBreak) Sets the line break String.
void	setQuoteCharacter(char quoteCharacter) Sets the quote character.
void	setQuoteCharacterEscapeMode(EscapeMode quoteCharacterEscapeMode) Sets the escape mode for the quote character.
void	setUseDelimiterAfterLastField(boolean useDelimiterAfterLastField) Specifies whether the last CSV field should end with a delimiter or not.

Methods inherited from class org.jsefa.rbf.config.RbfConfiguration

createDefaultTypeMappingRegistry, getLineFilter, getLineFilterLimit, getLowLevelConfiguration, getSpecialRecordDelimiter, setLineFilter, setLineFilterLimit, setLowLevelConfiguration, setSpecialRecordDelimiter

Methods inherited from class org.jsefa.common.config.Configuration

getEntryPoints, getObjectAccessorProvider, getSimpleTypeConverterProvider, getTypeMappingRegistry, getValidationMode, getValidatorProvider, setEntryPoints, setObjectAccessorProvider, setSimpleTypeConverterProvider, setTypeMappingRegistry, setValidationMode, setValidatorProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvConfiguration

public CsvConfiguration()

Constructs a new CsvConfiguration.

Method Detail

createCopy

public CsvConfiguration createCopy()

Creates a copy of this Configuration.

Specified by:

createCopy in class Configuration<RbfTypeMappingRegistry,RbfEntryPoint>

Returns:

a copy of this Configuration

getDefaultQuoteMode

public QuoteMode getDefaultQuoteMode()

Returns the default quote mode.

Returns:

a quote mode

getDefaultNoValueString

public String getDefaultNoValueString()

Returns the default no value string.

Returns:

a no value string

setDefaultQuoteMode

public void setDefaultQuoteMode(QuoteMode defaultQuoteMode)

Sets the default quote mode.

Parameters:

defaultQuoteMode - a quote mode

setDefaultNoValueString

public void setDefaultNoValueString(String defaultNoValueString)

Sets the default no value string.

Parameters:

defaultNoValueString - a no value string

getFieldDelimiter

public char getFieldDelimiter()

Returns the delimiter used to separate the CSV fields.

Returns:

the delimiter

See Also:

CsvLowLevelConfiguration.getFieldDelimiter()

getQuoteCharacter

public char getQuoteCharacter()

Returns the quote used to surround a field.

Returns:

the quote character

See Also:

CsvLowLevelConfiguration.getQuoteCharacter()

getEscapeCharacter

public char getEscapeCharacter()

Returns the escape character.

Returns:

the escape character

See Also:

CsvLowLevelConfiguration.getEscapeCharacter()

getQuoteCharacterEscapeMode

public EscapeMode getQuoteCharacterEscapeMode()

Returns the escape mode for the quote character.

Returns:

an escape mode

See Also:

CsvLowLevelConfiguration.getQuoteCharacterEscapeMode()

getUseDelimiterAfterLastField

public boolean getUseDelimiterAfterLastField()

Returns true if the last CSV field should end with a delimiter.

Returns:

true, if the last CSV field should end with a delimiter; otherwise false

See Also:

CsvLowLevelConfiguration.getUseDelimiterAfterLastField()

getLineBreak

public String getLineBreak()

Returns the line break String.

Returns:

the line break String

See Also:

LowLevelConfiguration.getLineBreak()

setFieldDelimiter

public void setFieldDelimiter(char fieldDelimiter)

Sets the delimiter to be used to separate the CSV fields.

Parameters:

fieldDelimiter - the delimiter

See Also:

CsvLowLevelConfiguration.setFieldDelimiter(char)

setQuoteCharacter

public void setQuoteCharacter(char quoteCharacter)

Sets the quote character.

Parameters:

quoteCharacter - the quote character

See Also:

CsvLowLevelConfiguration.setQuoteCharacter(char)

setEscapeCharacter

public void setEscapeCharacter(char escapeCharacter)

Sets the escape character.

Parameters:

escapeCharacter - the escape character

See Also:

CsvLowLevelConfiguration.setEscapeCharacter(char)

setUseDelimiterAfterLastField

public void setUseDelimiterAfterLastField(boolean useDelimiterAfterLastField)

Specifies whether the last CSV field should end with a delimiter or not.

Parameters:

useDelimiterAfterLastField - true, if the last CSV field should end with a delimiter; otherwise false.

See Also:

CsvLowLevelConfiguration.setUseDelimiterAfterLastField(boolean)

setQuoteCharacterEscapeMode

public void setQuoteCharacterEscapeMode(EscapeMode quoteCharacterEscapeMode)

Sets the escape mode for the quote character.

Parameters:

quoteCharacterEscapeMode - the escape mode

See Also:

CsvLowLevelConfiguration.setQuoteCharacterEscapeMode(org.jsefa.csv.lowlevel.config.EscapeMode)

setLineBreak

public void setLineBreak(String lineBreak)

Sets the line break String.

Parameters:

lineBreak - the line break String

See Also:

LowLevelConfiguration.setLineBreak(java.lang.String)

createDefaultLowLevelConfiguration

protected CsvLowLevelConfiguration createDefaultLowLevelConfiguration()

Creates the default low level configuration to be used if none is explicitly given.

Specified by:

createDefaultLowLevelConfiguration in class RbfConfiguration<CsvLowLevelConfiguration>

Returns:

the default low level configuration