org.dashbuilder.dataset.impl

Class AbstractDataSetDefBuilder<T>

java.lang.Object

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

All Implemented Interfaces:

DataSetDefBuilder<T>

Direct Known Subclasses:

BeanDataSetDefBuilderImpl, CSVDataSetDefBuilderImpl, SQLDataSetDefBuilderImpl, StaticDataSetDefBuilderImpl

public abstract class AbstractDataSetDefBuilder<T>
extends Object
implements DataSetDefBuilder<T>

Base class for DataSetDefBuilder implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSetDef	def

Constructor Summary

Constructors

Constructor and Description
AbstractDataSetDefBuilder()

Method Summary

Modifier and Type	Method and Description
DataSetDef	buildDef()
T	cacheOff() Disables the cache
T	cacheOn(int maxRowsInCache) Enables the cache for this data set
T	column(String columnId, ColumnType type) Add an empty column of the specified type.
protected abstract DataSetDef	createDataSetDef()
T	date(String columnId) Add an empty column of type date.
T	label(String columnId) Add an empty column of type label.
T	name(String name) Set the DataSetDef name.
T	number(String columnId) Add an empty column of numeric type.
T	pushOff() Disable the ability to push remote data sets from server.
T	pushOn(int pushMaxSize) Enable the ability to push remote data sets from server.
T	refreshOff() Turns of the data set refresh mechanism.
T	refreshOn(String refreshTime, boolean refreshAlways) Turns on the data set refresh mechanism.
T	text(String columnId) Add an empty column of type text.
T	uuid(String uuid) Set the DataSetDef UUID.

Methods inherited from class java.lang.Object

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

Field Detail

def

protected DataSetDef def

Constructor Detail

AbstractDataSetDefBuilder

public AbstractDataSetDefBuilder()

Method Detail

createDataSetDef

protected abstract DataSetDef createDataSetDef()

uuid

public T uuid(String uuid)

Description copied from interface: DataSetDefBuilder

Set the DataSetDef UUID.

Specified by:

uuid in interface DataSetDefBuilder<T>

Parameters:

uuid - The UUID of the DataSetDef that is being assembled.

Returns:

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

name

public T name(String name)

Description copied from interface: DataSetDefBuilder

Set the DataSetDef name.

Specified by:

name in interface DataSetDefBuilder<T>

Parameters:

name - The name of the DataSetDef that is being assembled.

Returns:

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

pushOn

public T pushOn(int pushMaxSize)

Description copied from interface: DataSetDefBuilder

Enable the ability to push remote data sets from server.

Specified by:

pushOn in interface DataSetDefBuilder<T>

Parameters:

pushMaxSize - The maximum size (in kbytes) a data set may have in order to be pushed to clients.

Returns:

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

pushOff

public T pushOff()

Description copied from interface: DataSetDefBuilder

Disable the ability to push remote data sets from server.

Specified by:

pushOff in interface DataSetDefBuilder<T>

Returns:

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

cacheOn

public T cacheOn(int maxRowsInCache)

Description copied from interface: DataSetDefBuilder

Enables the cache for this data set

Specified by:

cacheOn in interface DataSetDefBuilder<T>

Parameters:

maxRowsInCache - Max. rows the cache is able to handle. For higher values the cache is automatically disabled.

Returns:

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

cacheOff

public T cacheOff()

Description copied from interface: DataSetDefBuilder

Disables the cache

Specified by:

cacheOff in interface DataSetDefBuilder<T>

Returns:

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

refreshOn

public T refreshOn(String refreshTime,
                   boolean refreshAlways)

Description copied from interface: DataSetDefBuilder

Turns on the data set refresh mechanism. Every time the refresh time is met the data set will be forced to refresh. Any cache on the data set will be considered stale from that time on.

Specified by:

refreshOn in interface DataSetDefBuilder<T>

Parameters:

refreshTime - The amount of time between refresh intervals TimeAmount

refreshAlways - If false then the refresh will be only performed when the underlying data provider determines that the data set has become stale. Otherwise the data set is always refreshed. data set is outdated. This can be very useful to avoid refreshing unnecessarily.

Returns:

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

refreshOff

public T refreshOff()

Description copied from interface: DataSetDefBuilder

Turns of the data set refresh mechanism.

Specified by:

refreshOff in interface DataSetDefBuilder<T>

Returns:

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

label

public T label(String columnId)

Description copied from interface: DataSetDefBuilder

Add an empty column of type label.

Specified by:

label in interface DataSetDefBuilder<T>

text

public T text(String columnId)

Description copied from interface: DataSetDefBuilder

Add an empty column of type text.

Specified by:

text in interface DataSetDefBuilder<T>

number

public T number(String columnId)

Description copied from interface: DataSetDefBuilder

Add an empty column of numeric type.

Specified by:

number in interface DataSetDefBuilder<T>

Returns:

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

date

public T date(String columnId)

Description copied from interface: DataSetDefBuilder

Add an empty column of type date.

Specified by:

date in interface DataSetDefBuilder<T>

Returns:

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

column

public T column(String columnId,
                ColumnType type)

Description copied from interface: DataSetDefBuilder

Add an empty column of the specified type.

Specified by:

column in interface DataSetDefBuilder<T>

Returns:

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

buildDef

public DataSetDef buildDef()

Specified by:

buildDef in interface DataSetDefBuilder<T>

Returns:

The DataSetDef instance that has been configured.

See Also:

DataSetDef