Package org.dashbuilder.dataset.impl

Class CSVDataSetDefBuilderImpl

java.lang.Object

org.dashbuilder.dataset.impl.AbstractDataSetDefBuilder<CSVDataSetDefBuilderImpl>

org.dashbuilder.dataset.impl.CSVDataSetDefBuilderImpl

All Implemented Interfaces:

CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>, DataSetDefBuilder<CSVDataSetDefBuilderImpl>

public class CSVDataSetDefBuilderImpl
extends AbstractDataSetDefBuilder<CSVDataSetDefBuilderImpl>
implements CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Field Summary

Fields inherited from class org.dashbuilder.dataset.impl.AbstractDataSetDefBuilder

def

Constructor Summary

Constructors

Constructor	Description
CSVDataSetDefBuilderImpl()

Method Summary

Modifier and Type	Method	Description
CSVDataSetDefBuilderImpl	allColumns(boolean all)	It tells the CSV provider whether to include all the columns in the CSV defintion or only those columns explicitly declared into the data set definition.
protected DataSetDef	createDataSetDef()
CSVDataSetDefBuilderImpl	date(String columnId, String datePattern)	Set the pattern for the specified date column.
CSVDataSetDefBuilderImpl	datePattern(String datePattern)	Set the overall pattern used to read date columns.
CSVDataSetDefBuilderImpl	escapeChar(char escape)	Set the escape char.
CSVDataSetDefBuilderImpl	filePath(String path)	The CSV file path
CSVDataSetDefBuilderImpl	fileURL(String url)	A valid CSV stream URL
CSVDataSetDefBuilderImpl	number(String columnId, String numberPattern)	Set the pattern for the specified numeric column.
CSVDataSetDefBuilderImpl	numberPattern(String numberPattern)	Set the overall pattern used to read numeric columns.
CSVDataSetDefBuilderImpl	quoteChar(char quote)	Set the quote symbol.
CSVDataSetDefBuilderImpl	separatorChar(char separator)	Set the CSV column separator char.

Methods inherited from class org.dashbuilder.dataset.impl.AbstractDataSetDefBuilder

buildDef, cacheOff, cacheOn, column, date, label, name, number, pushOff, pushOn, refreshOff, refreshOn, text, uuid

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dashbuilder.dataset.def.DataSetDefBuilder

buildDef, cacheOff, cacheOn, column, date, label, name, number, pushOff, pushOn, refreshOff, refreshOn, text, uuid

Constructor Detail

CSVDataSetDefBuilderImpl

public CSVDataSetDefBuilderImpl()

Method Detail

createDataSetDef

protected DataSetDef createDataSetDef()

Specified by:

createDataSetDef in class AbstractDataSetDefBuilder<CSVDataSetDefBuilderImpl>

fileURL

public CSVDataSetDefBuilderImpl fileURL(String url)

Description copied from interface: CSVDataSetDefBuilder

A valid CSV stream URL

Specified by:

fileURL in interface CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Parameters:

url - A valid URL to a CSV stream

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

filePath

public CSVDataSetDefBuilderImpl filePath(String path)

Description copied from interface: CSVDataSetDefBuilder

The CSV file path

Specified by:

filePath in interface CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Parameters:

path - A valid path to a local file.

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

allColumns

public CSVDataSetDefBuilderImpl allColumns(boolean all)

Description copied from interface: CSVDataSetDefBuilder

It tells the CSV provider whether to include all the columns in the CSV defintion or only those columns explicitly declared into the data set definition.

Specified by:

allColumns in interface CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Parameters:

all - If tru all the CSV columns will be part of the data set (default true).

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

separatorChar

public CSVDataSetDefBuilderImpl separatorChar(char separator)

Description copied from interface: CSVDataSetDefBuilder

Set the CSV column separator char.

Specified by:

separatorChar in interface CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Parameters:

separator - An string for separating columns

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

quoteChar

public CSVDataSetDefBuilderImpl quoteChar(char quote)

Description copied from interface: CSVDataSetDefBuilder

Set the quote symbol.

Specified by:

quoteChar in interface CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Parameters:

quote - A char representing the quote symbol

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

escapeChar

public CSVDataSetDefBuilderImpl escapeChar(char escape)

Description copied from interface: CSVDataSetDefBuilder

Set the escape char.

Specified by:

escapeChar in interface CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Parameters:

escape - The scape char

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

date

public CSVDataSetDefBuilderImpl date(String columnId,
                                     String datePattern)

Description copied from interface: CSVDataSetDefBuilder

Set the pattern for the specified date column.

Specified by:

date in interface CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Parameters:

columnId - The id of the column

datePattern - The pattern of the column values. (See java.text.DateFormat)

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

See Also:

SimpleDateFormat

number

public CSVDataSetDefBuilderImpl number(String columnId,
                                       String numberPattern)

Description copied from interface: CSVDataSetDefBuilder

Set the pattern for the specified numeric column.

Specified by:

number in interface CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Parameters:

columnId - The id of the column

numberPattern - The pattern of the column values. (See java.text.DecimalFormat)

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

See Also:

DecimalFormat

datePattern

public CSVDataSetDefBuilderImpl datePattern(String datePattern)

Description copied from interface: CSVDataSetDefBuilder

Set the overall pattern used to read date columns.

Specified by:

datePattern in interface CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Parameters:

datePattern - The pattern of the column values. (See java.text.DateFormat)

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

See Also:

SimpleDateFormat

numberPattern

public CSVDataSetDefBuilderImpl numberPattern(String numberPattern)

Description copied from interface: CSVDataSetDefBuilder

Set the overall pattern used to read numeric columns.

Specified by:

numberPattern in interface CSVDataSetDefBuilder<CSVDataSetDefBuilderImpl>

Parameters:

numberPattern - The pattern of the column values. (See java.text.DecimalFormat)

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

See Also:

DecimalFormat