Package com.aquima.interactions.framework.util

Class CsvMetadataBuilder

java.lang.Object

com.aquima.interactions.framework.util.CsvMetadataBuilder

public class CsvMetadataBuilder
extends Object

Util class for easy datasource creation for a CSV resource connection.

Since:

8.3

Author:

Jon van Leuven

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_CHARSET
static final String	KEY_COLUMN_DATATYPE
static final String	KEY_COLUMN_FORMATPATTERN
static final String	KEY_COLUMN_LOCALECODE
static final String	KEY_COLUMN_VALUEFORMATNAME
static final String	KEY_COLUMNWIDTHS
static final String	KEY_DELIMITER
static final String	KEY_HASROWHEADERS
static final String	KEY_ISFIXEDWIDTHTEXT
static final String	KEY_QUOTECHARACTER

Constructor Summary

Constructors

Constructor	Description
CsvMetadataBuilder()

Method Summary

Modifier and Type	Method	Description
void	addColumnInfo(DataType type)	This method adds column information to the metadata object with a default value format.
void	addColumnInfo(DataType type, String valueFormatName)	This method adds column information to the metadata object
void	addColumnInfo(DataType type, String formatPattern, String localeCode)	This method adds column information to the metadata object
void	setCharset(String charset)
void	setColumnWidths(int[] columnWidths)	This method sets the column widths for a fixed width text resource.
void	setDelimiter(char delimiter)	This method sets the delimiter to use for separating entries.
void	setHasRowHeaders(boolean hasRowHeaders)	This method sets if the CSV resource's first row contains the headers.
void	setIsFixedWidthText(boolean isFixedWidthText)	This method sets if the resource should be parsed as a fixed width text resource.
void	setQuoteCharacter(char quoteCharacter)	This method sets the character to use for quoted elements.
void	toDatasource(IConnectionParameterVisitor visitor)	Use this method to add the metadata to the IConnectionParameterVisitor that is used in by the IResourceConnectionDS.

Methods inherited from class java.lang.Object

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

Field Details

KEY_ISFIXEDWIDTHTEXT

public static final String KEY_ISFIXEDWIDTHTEXT

See Also:

• Constant Field Values

KEY_COLUMNWIDTHS

public static final String KEY_COLUMNWIDTHS

See Also:

• Constant Field Values

KEY_DELIMITER

public static final String KEY_DELIMITER

See Also:

• Constant Field Values

KEY_QUOTECHARACTER

public static final String KEY_QUOTECHARACTER

See Also:

• Constant Field Values

KEY_HASROWHEADERS

public static final String KEY_HASROWHEADERS

See Also:

• Constant Field Values

KEY_CHARSET

public static final String KEY_CHARSET

See Also:

• Constant Field Values

KEY_COLUMN_DATATYPE

public static final String KEY_COLUMN_DATATYPE

See Also:

• Constant Field Values

KEY_COLUMN_FORMATPATTERN

public static final String KEY_COLUMN_FORMATPATTERN

See Also:

• Constant Field Values

KEY_COLUMN_LOCALECODE

public static final String KEY_COLUMN_LOCALECODE

See Also:

• Constant Field Values

KEY_COLUMN_VALUEFORMATNAME

public static final String KEY_COLUMN_VALUEFORMATNAME

See Also:

• Constant Field Values

Constructor Details

CsvMetadataBuilder

public CsvMetadataBuilder()

Method Details

addColumnInfo

public void addColumnInfo(DataType type,
 String formatPattern,
 String localeCode)

This method adds column information to the metadata object

Parameters:

type - The datatype of the column, may not be null.

formatPattern - The format pattern of the column, may be null.

localeCode - The format pattern of the column, may be null (may not be null when a pattern is provided).

addColumnInfo

public void addColumnInfo(DataType type,
 String valueFormatName)

This method adds column information to the metadata object

Parameters:

type - The datatype of the column, may not be null.

valueFormatName - The name of the value format that should be used, may be null.

addColumnInfo

public void addColumnInfo(DataType type)

This method adds column information to the metadata object with a default value format.

Parameters:

type - The datatype of the column, may not be null.

setIsFixedWidthText

public void setIsFixedWidthText(boolean isFixedWidthText)

This method sets if the resource should be parsed as a fixed width text resource.

Parameters:

isFixedWidthText - if the resource should be parsed as a fixed width text resource.

setColumnWidths

public void setColumnWidths(int[] columnWidths)

This method sets the column widths for a fixed width text resource.

Parameters:

columnWidths - the column widths for a fixed width text resource.

setDelimiter

public void setDelimiter(char delimiter)

This method sets the delimiter to use for separating entries.

Parameters:

delimiter - the delimiter to use for separating entries.

setQuoteCharacter

public void setQuoteCharacter(char quoteCharacter)

This method sets the character to use for quoted elements.

Parameters:

quoteCharacter - the character to use for quoted elements.

setHasRowHeaders

public void setHasRowHeaders(boolean hasRowHeaders)

This method sets if the CSV resource's first row contains the headers.

Parameters:

hasRowHeaders - if the CSV resource's first row contains the headers.

setCharset

public void setCharset(String charset)

toDatasource

public void toDatasource(IConnectionParameterVisitor visitor)

Use this method to add the metadata to the IConnectionParameterVisitor that is used in by the IResourceConnectionDS.

Parameters:

visitor - The visitor to add the csv metadata to.

Throws:

InitializationException - This exception is thrown when the connection definition could not be added.