Class SuggestModel
- All Implemented Interfaces:
Serializable
,Cloneable
Container for the suggestion information returned in a
SuggestResponse
.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
getFound()
The number of documents that were found to match the query string.getQuery()
The query string specified in the suggest request.The documents that match the query string.int
hashCode()
void
The number of documents that were found to match the query string.void
The query string specified in the suggest request.void
setSuggestions
(Collection<SuggestionMatch> suggestions) The documents that match the query string.toString()
Returns a string representation of this object; useful for testing and debugging.The number of documents that were found to match the query string.The query string specified in the suggest request.withSuggestions
(SuggestionMatch... suggestions) The documents that match the query string.withSuggestions
(Collection<SuggestionMatch> suggestions) The documents that match the query string.
-
Constructor Details
-
SuggestModel
public SuggestModel()
-
-
Method Details
-
setQuery
The query string specified in the suggest request.
- Parameters:
query
- The query string specified in the suggest request.
-
getQuery
The query string specified in the suggest request.
- Returns:
- The query string specified in the suggest request.
-
withQuery
The query string specified in the suggest request.
- Parameters:
query
- The query string specified in the suggest request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFound
The number of documents that were found to match the query string.
- Parameters:
found
- The number of documents that were found to match the query string.
-
getFound
The number of documents that were found to match the query string.
- Returns:
- The number of documents that were found to match the query string.
-
withFound
The number of documents that were found to match the query string.
- Parameters:
found
- The number of documents that were found to match the query string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getSuggestions
The documents that match the query string.
- Returns:
- The documents that match the query string.
-
setSuggestions
The documents that match the query string.
- Parameters:
suggestions
- The documents that match the query string.
-
withSuggestions
The documents that match the query string.
NOTE: This method appends the values to the existing list (if any). Use
setSuggestions(java.util.Collection)
orwithSuggestions(java.util.Collection)
if you want to override the existing values.- Parameters:
suggestions
- The documents that match the query string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withSuggestions
The documents that match the query string.
- Parameters:
suggestions
- The documents that match the query string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-