org.jsefa.rbf.config

Class RbfConfiguration<C extends RbfLowLevelConfiguration>

java.lang.Object

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

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

Type Parameters:

C - the type of the RbfLowLevelConfiguration

Direct Known Subclasses:

CsvConfiguration, FlrConfiguration

public abstract class RbfConfiguration<C extends RbfLowLevelConfiguration>
extends Configuration<RbfTypeMappingRegistry,RbfEntryPoint>

The abstract superclass for RBF type configuration classes.

Author:

Norman Lahme-Huetig

Nested Class Summary

Nested classes/interfaces inherited from class org.jsefa.common.config.Configuration

Configuration.Defaults

Constructor Summary

Constructors

Modifier	Constructor and Description
	RbfConfiguration() Constructs a new RbfConfiguration.
protected	RbfConfiguration(RbfConfiguration<C> other) Constructs a new RbfConfiguration as a copy of the given one.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract C	createDefaultLowLevelConfiguration() Creates the default low level configuration to be used if none is explicitly given.
protected RbfTypeMappingRegistry	createDefaultTypeMappingRegistry() Creates the default type mapping registry to be used if none is explicitly given.
LineFilter	getLineFilter() Returns the line filter used to filter lines from an input stream.
Integer	getLineFilterLimit() Returns the maximum number of characters to read from a line for passing it to a LineFilter.
C	getLowLevelConfiguration() Returns the low level configuration object.
Character	getSpecialRecordDelimiter()
void	setLineFilter(LineFilter lineFilter) Sets the line filter to use for filtering lines from an input stream.
void	setLineFilterLimit(Integer lineFilterLimit) Sets the maximum number of characters to read from a line for passing it to a LineFilter.
void	setLowLevelConfiguration(C lowLevelConfig) Sets the low level configuration object.
void	setSpecialRecordDelimiter(Character delimiter) Sets a special record delimiter.

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

createCopy, 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

RbfConfiguration

public RbfConfiguration()

Constructs a new RbfConfiguration.

RbfConfiguration

protected RbfConfiguration(RbfConfiguration<C> other)

Constructs a new RbfConfiguration as a copy of the given one.

Parameters:

other - the other config

Method Detail

getLineFilter

public LineFilter getLineFilter()

Returns the line filter used to filter lines from an input stream.

Returns:

the line filter or null

setLineFilter

public void setLineFilter(LineFilter lineFilter)

Sets the line filter to use for filtering lines from an input stream.

Parameters:

lineFilter - the line filter

getSpecialRecordDelimiter

public Character getSpecialRecordDelimiter()

Returns:

the special record delimiter or null if none exists

setSpecialRecordDelimiter

public void setSpecialRecordDelimiter(Character delimiter)

Sets a special record delimiter.

Parameters:

delimiter - the delimiter

getLineFilterLimit

public Integer getLineFilterLimit()

Returns the maximum number of characters to read from a line for passing it to a LineFilter.

This limit is only used if a special record delimiter is set.

Returns:

the maximum number of characters to read from a line for passing it to a LineFilter.

setLineFilterLimit

public void setLineFilterLimit(Integer lineFilterLimit)

Sets the maximum number of characters to read from a line for passing it to a LineFilter.

This limit is only used if a special record delimiter is set.

Parameters:

lineFilterLimit - the maximum number of characters to read

getLowLevelConfiguration

public C getLowLevelConfiguration()

Returns the low level configuration object.

Returns:

the low level configuration object

setLowLevelConfiguration

public void setLowLevelConfiguration(C lowLevelConfig)

Sets the low level configuration object.

Parameters:

lowLevelConfig - the low level configuration object.

createDefaultTypeMappingRegistry

protected RbfTypeMappingRegistry createDefaultTypeMappingRegistry()

Creates the default type mapping registry to be used if none is explicitly given.

Specified by:

createDefaultTypeMappingRegistry in class Configuration<RbfTypeMappingRegistry,RbfEntryPoint>

Returns:

the default type mapping registry

createDefaultLowLevelConfiguration

protected abstract C createDefaultLowLevelConfiguration()

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

Returns:

the default low level configuration