Package de.cxp.ocs.smartsuggest.querysuggester

Class QuerySuggesterProxy

java.lang.Object

de.cxp.ocs.smartsuggest.querysuggester.QuerySuggesterProxy

All Implemented Interfaces:

Instrumentable, QuerySuggester, AutoCloseable, org.apache.lucene.util.Accountable

public class QuerySuggesterProxy
extends Object
implements QuerySuggester, Instrumentable, org.apache.lucene.util.Accountable

Field Summary

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Fields inherited from interface de.cxp.ocs.smartsuggest.querysuggester.QuerySuggester

DEFAULT_MAXIMUM_RESULTS

Constructor Summary

Constructors

Constructor	Description
QuerySuggesterProxy(String indexName, String dataProviderName)	names for logging and metrics
QuerySuggesterProxy(String indexName, String dataType, int maxSuggestionsPerCacheEntry)

Method Summary

Modifier and Type	Method	Description
void	close()
void	instrument(Optional<MeterRegistryAdapter> metricsRegistryAdapter, Iterable<io.micrometer.core.instrument.Tag> tags)	Optional meter registry (adapter that gives access to the actual meter-registry).
boolean	isReady()
long	ramBytesUsed()
long	recordCount()	return amount of records indexed into this QuerySuggester.
List<Suggestion>	suggest(String term, int maxResults, Set<String> tags)
void	updateQueryMapper(@NonNull QuerySuggester newSuggester)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Methods inherited from interface de.cxp.ocs.smartsuggest.querysuggester.QuerySuggester

destroy, suggest

Constructor Detail

QuerySuggesterProxy

public QuerySuggesterProxy(String indexName,
                           String dataProviderName)

names for logging and metrics

Parameters:

indexName -

dataProviderName -

QuerySuggesterProxy

public QuerySuggesterProxy(String indexName,
                           String dataType,
                           int maxSuggestionsPerCacheEntry)

Method Detail

updateQueryMapper

public void updateQueryMapper(@NonNull
                              @NonNull QuerySuggester newSuggester)
                       throws org.apache.lucene.store.AlreadyClosedException

Throws:

org.apache.lucene.store.AlreadyClosedException

isReady

public boolean isReady()

Specified by:

isReady in interface QuerySuggester

Returns:

true if ready to serve suggestions

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

suggest

public List<Suggestion> suggest(String term,
                                int maxResults,
                                Set<String> tags)
                         throws SuggestException

Specified by:

suggest in interface QuerySuggester

Parameters:

term - the term for which to get suggestions

maxResults - the maximum number of suggestions to return

tags - the group names used for filtering

Returns:

A list of suggestions for the given term

Throws:

SuggestException

instrument

public void instrument(Optional<MeterRegistryAdapter> metricsRegistryAdapter,
                       Iterable<io.micrometer.core.instrument.Tag> tags)

Description copied from interface: Instrumentable

Optional meter registry (adapter that gives access to the actual meter-registry). If not available, no metrics should be measured.

Specified by:

instrument in interface Instrumentable

tags - these "standard" tags should be used for all added sensors. More tags can be added.

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable

recordCount

public long recordCount()

Description copied from interface: QuerySuggester

return amount of records indexed into this QuerySuggester.

Specified by:

recordCount in interface QuerySuggester

Returns:

amount of indexed records