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

Class DocumentSearchByPropertySuggester

java.lang.Object

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

All Implemented Interfaces:

Suggester

@Deprecated
public class DocumentSearchByPropertySuggester
extends Object
implements Suggester

Deprecated.

since 6.0. This suggester is not used anymore with the new search tab.

Simple stateless document search suggester that propose to use the user input for searching a specific field.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description	Deprecated.
protected boolean	disabled	Deprecated.
protected String	iconURL	Deprecated.
protected String	label	Deprecated.
protected String	searchField	Deprecated.
protected String[]	searchFields	Deprecated.
protected String	suggesterId	Deprecated.

Constructor Summary

Constructors

Constructor	Description
DocumentSearchByPropertySuggester()	Deprecated.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

searchField

protected String searchField

Deprecated.

suggesterId

protected String suggesterId

Deprecated.

searchFields

protected String[] searchFields

Deprecated.

Since:

5.8

label

protected String label

Deprecated.

description

protected String description

Deprecated.

iconURL

protected String iconURL

Deprecated.

disabled

protected boolean disabled

Deprecated.

Constructor Detail

DocumentSearchByPropertySuggester

public DocumentSearchByPropertySuggester()

Deprecated.

Method Detail

suggest

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

Deprecated.

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

Deprecated.

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