org.nuxeo.ecm.platform.suggestbox.service.suggesters

Class DocumentSearchByDateSuggester

java.lang.Object

org.nuxeo.ecm.platform.suggestbox.service.suggesters.DocumentSearchByDateSuggester

All Implemented Interfaces:

Suggester

public class DocumentSearchByDateSuggester
extends Object
implements Suggester

Simple stateless suggester that parses the input and suggest to search document by date if the input can be interpreted as a date in the user locale.

Constructor Summary

Constructors

Constructor and Description
DocumentSearchByDateSuggester()

Method Summary

Methods

Modifier and Type	Method and Description
void	initWithParameters(SuggesterDescriptor descriptor) Configure the Suggester instance with the parameters from the XML descriptor.
List<Suggestion>	suggest(String userInput, SuggestionContext context) Compute a list of possible user actions or intents given their input and context.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentSearchByDateSuggester

public DocumentSearchByDateSuggester()

Method Detail

suggest

public List<Suggestion> suggest(String userInput,
                       SuggestionContext context)
                         throws SuggestionException

Description copied from interface: Suggester

Compute a list of possible user actions or intents given their input and context.

Specified by:

suggest in interface Suggester

Parameters:

userInput - text typed by the user

context - user context

Returns:

generated suggestion for the given input and context

Throws:

SuggestionException - if the configuration or context are inconsistent, or a backing service is failing.

initWithParameters

public void initWithParameters(SuggesterDescriptor descriptor)
                        throws ComponentInitializationException

Description copied from interface: Suggester

Configure the Suggester instance with the parameters from the XML descriptor.

Specified by:

initWithParameters in interface Suggester

Parameters:

descriptor - XMap descriptor with the aggregate configuration information of the component.

Throws:

ComponentInitializationException