org.dashbuilder.dataset.def

Class DataSetDef

java.lang.Object

org.dashbuilder.dataset.def.DataSetDef

Direct Known Subclasses:

BeanDataSetDef, CSVDataSetDef, ElasticSearchDataSetDef, SQLDataSetDef, StaticDataSetDef

public class DataSetDef
extends Object

This class is used to define the origin, structure and runtime behaviour of a data set instance.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allColumnsEnabled
protected boolean	cacheEnabled
protected Integer	cacheMaxRows
protected List<DataColumnDef>	columns
protected DataSetFilter	dataSetFilter
protected boolean	isPublic
protected String	name
protected Map<String,String>	patternMap
protected Map<String,String>	propertyMap
protected DataSetProviderType	provider
protected boolean	pushEnabled
protected Integer	pushMaxSize
protected boolean	refreshAlways
protected String	refreshTime
protected String	UUID

Constructor Summary

Constructors

Constructor and Description
DataSetDef()

Method Summary

Modifier and Type	Method and Description
boolean	addColumn(String id, ColumnType type)
DataSetDef	clone()
protected void	clone(DataSetDef def)
boolean	equals(Object obj)
Integer	getCacheMaxRows()
DataColumnDef	getColumnById(String id)
List<DataColumnDef>	getColumns()
DataSetFilter	getDataSetFilter()
String	getName()
String	getPattern(String columnId)
String	getProperty(String key)
Set<String>	getPropertyNames()
DataSetProviderType	getProvider()
Integer	getPushMaxSize()
String	getRefreshTime()
TimeAmount	getRefreshTimeAmount()
String	getUUID()
int	hashCode()
boolean	isAllColumnsEnabled()
boolean	isCacheEnabled()
boolean	isPublic()
boolean	isPushEnabled()
boolean	isRefreshAlways()
void	setAllColumnsEnabled(boolean allColumnsEnabled)
void	setCacheEnabled(boolean cacheEnabled)
void	setCacheMaxRows(Integer cacheMaxRows)
void	setColumns(List<DataColumnDef> columns)
void	setDataSetFilter(DataSetFilter dataSetFilter)
void	setName(String name)
void	setPattern(String columnId, String pattern)
void	setProperty(String key, String value)
void	setProvider(DataSetProviderType provider)
void	setPublic(boolean isPublic)
void	setPushEnabled(boolean pushEnabled)
void	setPushMaxSize(Integer pushMaxSize)
void	setRefreshAlways(boolean refreshAlways)
void	setRefreshTime(String refreshTime)
void	setUUID(String UUID)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

UUID

@NotNull(groups=DataSetDefBasicAttributesGroup.class)
 @Size(min=1,
      groups=DataSetDefBasicAttributesGroup.class)
protected String UUID

name

@NotNull(groups=DataSetDefBasicAttributesGroup.class)
 @Size(min=1,
      groups=DataSetDefBasicAttributesGroup.class)
protected String name

provider

@NotNull(groups=DataSetDefProviderTypeGroup.class)
protected DataSetProviderType provider

columns

protected List<DataColumnDef> columns

dataSetFilter

protected DataSetFilter dataSetFilter

isPublic

protected boolean isPublic

pushEnabled

protected boolean pushEnabled

pushMaxSize

@NotNull(groups=DataSetDefPushSizeValidation.class)
 @Max(value=4096L)
protected Integer pushMaxSize

cacheEnabled

protected boolean cacheEnabled

cacheMaxRows

@NotNull(groups=DataSetDefCacheRowsValidation.class)
 @Max(value=10000L)
protected Integer cacheMaxRows

refreshTime

@NotNull(groups=DataSetDefRefreshIntervalValidation.class)
 @Size(min=1,
      groups=DataSetDefRefreshIntervalValidation.class)
 @IsTimeInterval(groups=DataSetDefRefreshIntervalValidation.class)
protected String refreshTime

refreshAlways

protected boolean refreshAlways

allColumnsEnabled

protected boolean allColumnsEnabled

patternMap

protected Map<String,String> patternMap

propertyMap

protected Map<String,String> propertyMap

Constructor Detail

DataSetDef

public DataSetDef()

Method Detail

getUUID

public String getUUID()

setUUID

public void setUUID(String UUID)

getName

public String getName()

setName

public void setName(String name)

getDataSetFilter

public DataSetFilter getDataSetFilter()

setDataSetFilter

public void setDataSetFilter(DataSetFilter dataSetFilter)

getProvider

public DataSetProviderType getProvider()

setProvider

public void setProvider(DataSetProviderType provider)

isPublic

public boolean isPublic()

setPublic

public void setPublic(boolean isPublic)

isPushEnabled

public boolean isPushEnabled()

setPushEnabled

public void setPushEnabled(boolean pushEnabled)

getPushMaxSize

public Integer getPushMaxSize()

setPushMaxSize

public void setPushMaxSize(Integer pushMaxSize)

isCacheEnabled

public boolean isCacheEnabled()

setCacheEnabled

public void setCacheEnabled(boolean cacheEnabled)

getCacheMaxRows

public Integer getCacheMaxRows()

setCacheMaxRows

public void setCacheMaxRows(Integer cacheMaxRows)

getRefreshTime

public String getRefreshTime()

setRefreshTime

public void setRefreshTime(String refreshTime)

getRefreshTimeAmount

public TimeAmount getRefreshTimeAmount()

isRefreshAlways

public boolean isRefreshAlways()

setRefreshAlways

public void setRefreshAlways(boolean refreshAlways)

getPattern

public String getPattern(String columnId)

setPattern

public void setPattern(String columnId,
                       String pattern)

isAllColumnsEnabled

public boolean isAllColumnsEnabled()

setAllColumnsEnabled

public void setAllColumnsEnabled(boolean allColumnsEnabled)

getColumns

public List<DataColumnDef> getColumns()

setColumns

public void setColumns(List<DataColumnDef> columns)

getColumnById

public DataColumnDef getColumnById(String id)

addColumn

public boolean addColumn(String id,
                         ColumnType type)

getPropertyNames

public Set<String> getPropertyNames()

getProperty

public String getProperty(String key)

setProperty

public void setProperty(String key,
                        String value)

clone

public DataSetDef clone()

Overrides:

clone in class Object

clone

protected void clone(DataSetDef def)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object