Package org.nuxeo.ecm.platform.suggestbox.service

Class SuggestionServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.suggestbox.service.SuggestionServiceImpl

All Implemented Interfaces:

SuggestionService, Adaptable, Component, Extensible, TimestampedService

public class SuggestionServiceImpl
extends DefaultComponent
implements SuggestionService

The Class SuggestionServiceImpl.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,SuggesterGroupDescriptor>	suggesterGroups
protected Map<String,Suggester>	suggesters
protected static final String	XP_SUGGESTER_GROUPS
protected static final String	XP_SUGGESTERS

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
SuggestionServiceImpl()

Method Summary

Modifier and Type	Method	Description
Map<String,SuggesterGroupDescriptor>	getSuggesterGroups()	Gets the suggester groups registry.
void	start(ComponentContext context)	Start the component.
void	stop(ComponentContext context)	Stop the component.
List<Suggestion>	suggest(String userInput, SuggestionContext context)	Call the suggesters registered for the given suggestion point mentioned in the context and aggregate the results.
List<Suggestion>	suggest(String input, SuggestionContext context, String suggesterName)	Call a single suggester registered under the provided name.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, registerExtension, setLastModified, setModifiedNow, setName, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

XP_SUGGESTERS

protected static final String XP_SUGGESTERS

See Also:

• Constant Field Values

XP_SUGGESTER_GROUPS

protected static final String XP_SUGGESTER_GROUPS

See Also:

• Constant Field Values

suggesters

protected Map<String,Suggester> suggesters

suggesterGroups

protected Map<String,SuggesterGroupDescriptor> suggesterGroups

Constructor Details

SuggestionServiceImpl

public SuggestionServiceImpl()

Method Details

suggest

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

Description copied from interface: SuggestionService

Call the suggesters registered for the given suggestion point mentioned in the context and aggregate the results.

Specified by:

suggest in interface SuggestionService

Parameters:

userInput - text typed by the user

context - user context (with suggestPoint name and more)

Returns:

generated suggestion for the given input and context

Throws:

SuggestionException

suggest

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

Description copied from interface: SuggestionService

Call a single suggester registered under the provided name.

Specified by:

suggest in interface SuggestionService

Parameters:

input - text typed by the user

context - user context (with suggestPoint name and more)

suggesterName - the registration name of the suggester to use

Returns:

generated suggestion for the given input and context

Throws:

SuggestionException

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

stop

public void stop(ComponentContext context)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

getSuggesterGroups

public Map<String,SuggesterGroupDescriptor> getSuggesterGroups()

Gets the suggester groups registry. Only for test purpose.

Returns:

the suggester groups