Package de.cxp.ocs.smartsuggest

Class QuerySuggestManager

java.lang.Object

de.cxp.ocs.smartsuggest.QuerySuggestManager

All Implemented Interfaces:

AutoCloseable

public class QuerySuggestManager
extends Object
implements AutoCloseable

The QuerySuggestManager cares about the creation of QuerySuggester objects and also makes sure they are coupled to an internal asynchronous update process which is scheduled according a configurable update rate.

Since the QuerySuggestManager internally holds an executor service, it must be closed when it and the created QuerySuggester instances are no longer in use.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuerySuggestManager.QuerySuggestManagerBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEBUG_PROPERTY
Limiter	limiter

Method Summary

Modifier and Type	Method	Description
static QuerySuggestManager.QuerySuggestManagerBuilder	builder()
void	close()
void	destroyQuerySuggester(String indexName)
QuerySuggester	getQuerySuggester(@NonNull String indexName)	Retrieves the query suggester for the given indexName.
QuerySuggester	getQuerySuggester(@NonNull String indexName, boolean synchronous)
void	setUpdateRate(int seconds)	Deprecated. use builder instead!

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG_PROPERTY

public static final String DEBUG_PROPERTY

See Also:

Constant Field Values

limiter

public Limiter limiter

Method Detail

builder

public static QuerySuggestManager.QuerySuggestManagerBuilder builder()

setUpdateRate

@Deprecated
public void setUpdateRate(int seconds)

Deprecated.

use builder instead!

Set the rate (in seconds) at which the update should run. The value must be 5 <= x <= 3600. That rate is only applied to QuerySuggesters that will be fetched from the time after this value is set.

Parameters:

seconds -

getQuerySuggester

public QuerySuggester getQuerySuggester(@NonNull
                                        @NonNull String indexName)

Retrieves the query suggester for the given indexName. Initializes a new query suggester if non exists yet, for that client. A background job ensures the data of that query suggester get's updated regularly.

Parameters:

indexName - index name of the wanted suggester

Returns:

initialized query suggester

getQuerySuggester

public QuerySuggester getQuerySuggester(@NonNull
                                        @NonNull String indexName,
                                        boolean synchronous)

destroyQuerySuggester

public void destroyQuerySuggester(String indexName)

close

public void close()

Specified by:

close in interface AutoCloseable