Package de.cxp.ocs.smartsuggest.querysuggester

Class GroupingSuggester

java.lang.Object

de.cxp.ocs.smartsuggest.querysuggester.GroupingSuggester

All Implemented Interfaces:

QuerySuggester, AutoCloseable

public class GroupingSuggester
extends Object
implements QuerySuggester

Field Summary

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

DEFAULT_MAXIMUM_RESULTS

Constructor Summary

Constructors

Constructor	Description
GroupingSuggester()

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	isReady()
long	recordCount()	return amount of records indexed into this QuerySuggester.
List<Suggestion>	suggest(String term, int maxResults, Set<String> tags)

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.querysuggester.QuerySuggester

destroy, suggest

Constructor Details

GroupingSuggester

public GroupingSuggester()

Method Details

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

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

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