Package org.dashbuilder.dataset.def

Class ElasticSearchDataSetDef

java.lang.Object

org.dashbuilder.dataset.def.DataSetDef

org.dashbuilder.dataset.def.ElasticSearchDataSetDef

public class ElasticSearchDataSetDef
extends DataSetDef

DataSet definition class for ElasticSearch provider.

This dataset provides these configuration parameters:

• serverURL - The URL for the ElasticSearch server instance (MANDATORY)
• clusterName - The name of the cluster in the ElasticSearch server.
• index - The name of the index. It can be a concrete index name, a collection of index names, comma separated, or the keyword _all for working with all available indexes in the ElasticSearch server (OPTIONAL - Defaults to _all)
• type - The type name. Only applicable if index parameter is set. It can be a concrete type name, a collection of type names, comma separated, or the keyword _all for working with all available type in the ElasticSearch server (OPTIONAL - Defaults to _all)
• query - You can perform your custom ElasticSearch DSL query for this data provider. If this parameter exist, the parameters index, type and field are skipped. (OPTIONAL)
• relevance - The relevance value for search results (OPTIONAL)
• columns - If not specified, the column definitions for the ElasticSearch dataset are automatically given by querying the index mappings. Otherwise, you can bind a column to another datatype in dashbuilder application using this parameters (OPTIONAL)

Since:

0.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElasticSearchDataSetDef.ElasticSearchKeywords

Field Summary

Fields

Modifier and Type	Field	Description
protected String	clusterName
protected ColumnSort	columnSort
protected @NotNull(groups=ElasticSearchDataSetDefValidation.class) @Size(min=1,groups=ElasticSearchDataSetDefValidation.class) String	index	Index/es to query.
protected String	query
protected String	relevance
protected @NotNull(groups=ElasticSearchDataSetDefValidation.class) @Size(min=1,groups=ElasticSearchDataSetDefValidation.class) String	serverURL
protected String	type	Type/es to query.

Fields inherited from class org.dashbuilder.dataset.def.DataSetDef

allColumnsEnabled, cacheEnabled, cacheMaxRows, columns, dataSetFilter, isPublic, name, patternMap, propertyMap, provider, pushEnabled, pushMaxSize, refreshAlways, refreshTime, UUID

Constructor Summary

Constructors

Constructor	Description
ElasticSearchDataSetDef()

Method Summary

Modifier and Type	Method	Description
DataSetDef	clone()
boolean	equals(Object obj)
Integer	getCacheMaxRows()
String	getClusterName()
ColumnSort	getColumnSort()
String	getIndex()
String	getQuery()
String	getRelevance()
String	getServerURL()
String	getType()
int	hashCode()
boolean	isCacheEnabled()
void	setCacheEnabled(boolean cacheEnabled)
void	setCacheMaxRows(Integer cacheMaxRows)
void	setClusterName(String clusterName)
void	setColumnSort(ColumnSort columnSort)
void	setIndex(String index)
void	setQuery(String query)
void	setRelevance(String relevance)
void	setServerURL(String serverURL)
void	setType(String type)
String	toString()

Methods inherited from class org.dashbuilder.dataset.def.DataSetDef

addColumn, clone, getColumnById, getColumns, getDataSetFilter, getName, getPattern, getProperty, getPropertyNames, getProvider, getPushMaxSize, getRefreshTime, getRefreshTimeAmount, getUUID, isAllColumnsEnabled, isPublic, isPushEnabled, isRefreshAlways, setAllColumnsEnabled, setColumns, setDataSetFilter, setName, setPattern, setProperty, setProvider, setPublic, setPushEnabled, setPushMaxSize, setRefreshAlways, setRefreshTime, setUUID

Methods inherited from class java.lang.Object

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

Field Detail

serverURL

@NotNull(groups=ElasticSearchDataSetDefValidation.class)
@Size(min=1,
      groups=ElasticSearchDataSetDefValidation.class)
protected @NotNull(groups=ElasticSearchDataSetDefValidation.class) @Size(min=1,groups=ElasticSearchDataSetDefValidation.class) String serverURL

clusterName

protected String clusterName

index

@NotNull(groups=ElasticSearchDataSetDefValidation.class)
@Size(min=1,
      groups=ElasticSearchDataSetDefValidation.class)
protected @NotNull(groups=ElasticSearchDataSetDefValidation.class) @Size(min=1,groups=ElasticSearchDataSetDefValidation.class) String index

Index/es to query. Can handle multiple values, comma separated.

type

protected String type

Type/es to query. Can handle multiple values, comma separated. Not mandatory.

query

protected String query

relevance

protected String relevance

columnSort

protected ColumnSort columnSort

Constructor Detail

ElasticSearchDataSetDef

public ElasticSearchDataSetDef()

Method Detail

getServerURL

public String getServerURL()

setServerURL

public void setServerURL(String serverURL)

getClusterName

public String getClusterName()

setClusterName

public void setClusterName(String clusterName)

getIndex

public String getIndex()

setIndex

public void setIndex(String index)

getType

public String getType()

setType

public void setType(String type)

getQuery

public String getQuery()

setQuery

public void setQuery(String query)

getRelevance

public String getRelevance()

setRelevance

public void setRelevance(String relevance)

isCacheEnabled

public boolean isCacheEnabled()

Overrides:

isCacheEnabled in class DataSetDef

setCacheEnabled

public void setCacheEnabled(boolean cacheEnabled)

Overrides:

setCacheEnabled in class DataSetDef

getCacheMaxRows

public Integer getCacheMaxRows()

Overrides:

getCacheMaxRows in class DataSetDef

setCacheMaxRows

public void setCacheMaxRows(Integer cacheMaxRows)

Overrides:

setCacheMaxRows in class DataSetDef

getColumnSort

public ColumnSort getColumnSort()

setColumnSort

public void setColumnSort(ColumnSort columnSort)

equals

public boolean equals(Object obj)

Overrides:

equals in class DataSetDef

hashCode

public int hashCode()

Overrides:

hashCode in class DataSetDef

clone

public DataSetDef clone()

Overrides:

clone in class DataSetDef

toString

public String toString()

Overrides:

toString in class Object