Package de.cxp.ocs.elasticsearch

Class ElasticsearchSuggestDataProvider

java.lang.Object

de.cxp.ocs.elasticsearch.ElasticsearchSuggestDataProvider

All Implemented Interfaces:

SuggestDataProvider

public class ElasticsearchSuggestDataProvider
extends Object
implements SuggestDataProvider

Constructor Summary

Constructors

Constructor	Description
ElasticsearchSuggestDataProvider()

Method Summary

Modifier and Type	Method	Description
long	getLastDataModTime(String indexName)	Get the timestamp from when the data was modified the last time.
boolean	hasData(String indexName)	Respond with 'true' if this provider is generally able to provide data for the requested index.
SuggestData	loadData(String indexName)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cxp.ocs.smartsuggest.spi.SuggestDataProvider

configure

Constructor Detail

ElasticsearchSuggestDataProvider

public ElasticsearchSuggestDataProvider()

Method Detail

hasData

public boolean hasData(String indexName)

Description copied from interface: SuggestDataProvider

Respond with 'true' if this provider is generally able to provide data for the requested index. This is a quick check when initializing the suggesters, so it should not take too long.

It's also possible to return a static "true" here and do the expensive availability check at the getLastDataModTime method, which is called async. If getLastDataModTime returns a value < 0, data update are canceled as well.

Specified by:

hasData in interface SuggestDataProvider

Parameters:

indexName - identifier for the requested data

Returns:

getLastDataModTime

public long getLastDataModTime(String indexName)
                        throws IOException

Description copied from interface: SuggestDataProvider

Get the timestamp from when the data was modified the last time. For every change of that timestamp, the data will be pulled and indexed into suggest index.

Setting the timestamp at the data is optional, but if it is set there, it MUST be the same timestamp, otherwise the data is rejected. This feature is used to avoid potential concurrency issues.

If data is not available at all, a value < 0 should be returned.

Specified by:

getLastDataModTime in interface SuggestDataProvider

Parameters:

indexName - identifier for the requested data

Returns:

unix timestamp in millis

Throws:

IOException

loadData

public SuggestData loadData(String indexName)
                     throws IOException

Specified by:

loadData in interface SuggestDataProvider

Parameters:

indexName - identifier for the requested data

Returns:

suggest data

Throws:

IOException