org.jahia.services.search

Class Suggestion

java.lang.Object

org.jahia.services.search.Suggestion

public class Suggestion
extends Object

Represents a spell checker corrected query (suggestion) that can be used to implement "Did you mean" kind of searches.

Since:

6.5

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
Suggestion(String originalQuery, String suggestedQuery) Initializes an instance of this class.
Suggestion(String originalQuery, String suggestedQuery, List<String> allSuggestions) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
List<String>	getAllSuggestions() Returns a list of suggested query terms.
String	getOriginalQuery() Returns the original query string.
String	getSuggestedQuery() Returns the suggested query string.
void	setSuggestedQuery(String suggestedQuery)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Suggestion

public Suggestion(String originalQuery,
                  String suggestedQuery)

Initializes an instance of this class.

Parameters:

originalQuery -

suggestedQuery -

Suggestion

public Suggestion(String originalQuery,
                  String suggestedQuery,
                  List<String> allSuggestions)

Initializes an instance of this class.

Parameters:

originalQuery -

suggestedQuery -

allSuggestions -

Method Detail

getOriginalQuery

public String getOriginalQuery()

Returns the original query string.

Returns:

the original query string

getSuggestedQuery

public String getSuggestedQuery()

Returns the suggested query string.

Returns:

the suggested query string

getAllSuggestions

public List<String> getAllSuggestions()

Returns a list of suggested query terms.

Returns:

a list of suggested query terms

toString

public String toString()

Overrides:

toString in class Object

setSuggestedQuery

public void setSuggestedQuery(String suggestedQuery)