org.dashbuilder.dataprovider.backend.elasticsearch

Class ElasticSearchDataSetProvider

java.lang.Object

org.dashbuilder.dataprovider.backend.elasticsearch.ElasticSearchDataSetProvider

All Implemented Interfaces:

DataSetProvider, DataSetDefRegistryListener

public class ElasticSearchDataSetProvider
extends Object
implements DataSetProvider, DataSetDefRegistryListener

Data provider for an ElasticSearch server.

It's basically implemented as a REST client for querying an ElasticSearch server instance.

If a given type field is not explicitly mapped as a concrete dashbuilder datatype using the columns parameter, the implicit data type bindings are:

ElasticSearch type	Dashbuilder type
string	TEXT ( if index value is analyzed ) or LABEL ( if index value is not_analyzed )
float	NUMBER
double	NUMBER
byte	NUMBER
short	NUMBER
integer	NUMBER
long	NUMBER
token_count	LABEL
date	DATE
boolean	LABEL
binary	LABEL

Since:

0.3.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,ElasticSearchClient>	_clientsMap Singleton clients for each data set definition..
protected Map<String,DataSetMetadata>	_metadataMap Backend cache map.
protected ElasticSearchClientFactory	clientFactory
protected IntervalBuilderDynamicDate	intervalBuilderDynamicDate
protected IntervalBuilderLocator	intervalBuilderLocator
protected org.slf4j.Logger	log
protected ElasticSearchQueryBuilderFactory	queryBuilderFactory
static int	RESPONSE_CODE_OK
protected StaticDataSetProvider	staticDataSetProvider
protected ElasticSearchValueTypeMapper	typeMapper

Constructor Summary

Constructors

Constructor and Description
ElasticSearchDataSetProvider()
ElasticSearchDataSetProvider(StaticDataSetProvider staticDataSetProvider, IntervalBuilderLocator intervalBuilderLocator, IntervalBuilderDynamicDate intervalBuilderDynamicDate)

Method Summary

Modifier and Type	Method and Description
protected ColumnFilter	_getIntervalSelectionFilter(DataSetGroup intervalSel)
protected DataSet	_lookupDataSet(ElasticSearchDataSetDef elDef, DataSetLookup lookup)
void	destroy()
protected boolean	existColumn(DataSetMetadata metadata, String columnId)
protected void	fillDataSetValues(ElasticSearchDataSetDef elDef, DataSet dataSet, SearchHitResponse[] hits) Fills the dataset values.
static String[]	fromString(String str)
static ElasticSearchDataSetProvider	get()
protected List<DataColumn>	getAllColumns(DataSetMetadata metadata)
protected DataColumn	getColumnById(DataSetMetadata metadata, String columnId)
protected String	getColumnId(String index, String type, String field)
DataSetMetadata	getDataSetMetadata(DataSetDef def)
protected ColumnType	getDataType(FieldMappingResponse.FieldType fieldType, FieldMappingResponse.IndexType indexType) Return the dashbuilder data type for a given ElasticSearch field type.
protected long	getRowCount(ElasticSearchDataSetDef elasticSearchDataSetDef)
DataSetProviderType	getType()
boolean	isDataSetOutdated(DataSetDef def)
DataSet	lookupDataSet(DataSetDef def, DataSetLookup lookup)
void	onDataSetDefModified(DataSetDef oldDef, DataSetDef newDef)
void	onDataSetDefRegistered(DataSetDef newDef)
void	onDataSetDefRemoved(DataSetDef oldDef)
void	onDataSetDefStale(DataSetDef def)
protected DataColumn	parseColumnFromIndexMappings(ElasticSearchDataSetDef def, String indexName, String typeName, String fieldName, String format, FieldMappingResponse.FieldType fieldType, FieldMappingResponse.IndexType indexType)
protected Map<String,DataColumn>	parseColumnsFromIndexMappings(IndexMappingResponse[] indexMappings, ElasticSearchDataSetDef def) Parse a given index' field definitions from EL index mappings response.
protected void	remove(String uuid)
static String	toString(String[] array)

Methods inherited from class java.lang.Object

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

Field Detail

RESPONSE_CODE_OK

public static final int RESPONSE_CODE_OK

See Also:

Constant Field Values

log

protected org.slf4j.Logger log

staticDataSetProvider

protected StaticDataSetProvider staticDataSetProvider

intervalBuilderLocator

protected IntervalBuilderLocator intervalBuilderLocator

intervalBuilderDynamicDate

protected IntervalBuilderDynamicDate intervalBuilderDynamicDate

clientFactory

protected ElasticSearchClientFactory clientFactory

typeMapper

protected ElasticSearchValueTypeMapper typeMapper

queryBuilderFactory

protected ElasticSearchQueryBuilderFactory queryBuilderFactory

_metadataMap

protected final Map<String,DataSetMetadata> _metadataMap

Backend cache map.

_clientsMap

protected final Map<String,ElasticSearchClient> _clientsMap

Singleton clients for each data set definition..

Constructor Detail

ElasticSearchDataSetProvider

public ElasticSearchDataSetProvider()

ElasticSearchDataSetProvider

public ElasticSearchDataSetProvider(StaticDataSetProvider staticDataSetProvider,
                                    IntervalBuilderLocator intervalBuilderLocator,
                                    IntervalBuilderDynamicDate intervalBuilderDynamicDate)

Method Detail

get

public static ElasticSearchDataSetProvider get()

destroy

public void destroy()

getType

public DataSetProviderType getType()

Specified by:

getType in interface DataSetProvider

lookupDataSet

public DataSet lookupDataSet(DataSetDef def,
                             DataSetLookup lookup)
                      throws Exception

Specified by:

lookupDataSet in interface DataSetProvider

Throws:

Exception

_lookupDataSet

protected DataSet _lookupDataSet(ElasticSearchDataSetDef elDef,
                                 DataSetLookup lookup)
                          throws Exception

Throws:

Exception

_getIntervalSelectionFilter

protected ColumnFilter _getIntervalSelectionFilter(DataSetGroup intervalSel)

getAllColumns

protected List<DataColumn> getAllColumns(DataSetMetadata metadata)

getColumnById

protected DataColumn getColumnById(DataSetMetadata metadata,
                                   String columnId)

existColumn

protected boolean existColumn(DataSetMetadata metadata,
                              String columnId)

fillDataSetValues

protected void fillDataSetValues(ElasticSearchDataSetDef elDef,
                                 DataSet dataSet,
                                 SearchHitResponse[] hits)
                          throws Exception

Fills the dataset values.

Parameters:

dataSet - The dataset instance to fill. Note that dataset columns must be added before calling this method.

hits - The search result hits.

Throws:

Exception

isDataSetOutdated

public boolean isDataSetOutdated(DataSetDef def)

Specified by:

isDataSetOutdated in interface DataSetProvider

getDataSetMetadata

public DataSetMetadata getDataSetMetadata(DataSetDef def)
                                   throws Exception

Specified by:

getDataSetMetadata in interface DataSetProvider

Throws:

Exception

parseColumnsFromIndexMappings

protected Map<String,DataColumn> parseColumnsFromIndexMappings(IndexMappingResponse[] indexMappings,
                                                               ElasticSearchDataSetDef def)

Parse a given index' field definitions from EL index mappings response.

Parameters:

indexMappings - The mappings response from EL server.

def - The data set definition.

Returns:

The Data columns from index mappings.

parseColumnFromIndexMappings

protected DataColumn parseColumnFromIndexMappings(ElasticSearchDataSetDef def,
                                                  String indexName,
                                                  String typeName,
                                                  String fieldName,
                                                  String format,
                                                  FieldMappingResponse.FieldType fieldType,
                                                  FieldMappingResponse.IndexType indexType)

getColumnId

protected String getColumnId(String index,
                             String type,
                             String field)
                      throws IllegalArgumentException

Throws:

IllegalArgumentException

getDataType

protected ColumnType getDataType(FieldMappingResponse.FieldType fieldType,
                                 FieldMappingResponse.IndexType indexType)
                          throws IllegalArgumentException

Return the dashbuilder data type for a given ElasticSearch field type.

Parameters:

fieldType - The ElasticSearch field type..

indexType - The index type for the field.

Returns:

The dashbuilder data type.

Throws:

IllegalArgumentException - If ElasticSearch core data type is not supported.

getRowCount

protected long getRowCount(ElasticSearchDataSetDef elasticSearchDataSetDef)
                    throws Exception

Throws:

Exception

onDataSetDefStale

public void onDataSetDefStale(DataSetDef def)

Specified by:

onDataSetDefStale in interface DataSetDefRegistryListener

onDataSetDefModified

public void onDataSetDefModified(DataSetDef oldDef,
                                 DataSetDef newDef)

Specified by:

onDataSetDefModified in interface DataSetDefRegistryListener

onDataSetDefRemoved

public void onDataSetDefRemoved(DataSetDef oldDef)

Specified by:

onDataSetDefRemoved in interface DataSetDefRegistryListener

onDataSetDefRegistered

public void onDataSetDefRegistered(DataSetDef newDef)

Specified by:

onDataSetDefRegistered in interface DataSetDefRegistryListener

remove

protected void remove(String uuid)

fromString

public static String[] fromString(String str)

toString

public static String toString(String[] array)