Class DocumentSuggesterOptions
- All Implemented Interfaces:
Serializable
,Cloneable
Options for a search suggester.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
.An expression that computes a score for each suggestion to control how they are sorted.The name of the index field you want to use for suggestions.int
hashCode()
void
setFuzzyMatching
(SuggesterFuzzyMatching fuzzyMatching) The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
.void
setFuzzyMatching
(String fuzzyMatching) The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
.void
setSortExpression
(String sortExpression) An expression that computes a score for each suggestion to control how they are sorted.void
setSourceField
(String sourceField) The name of the index field you want to use for suggestions.toString()
Returns a string representation of this object; useful for testing and debugging.withFuzzyMatching
(SuggesterFuzzyMatching fuzzyMatching) The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
.withFuzzyMatching
(String fuzzyMatching) The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
.withSortExpression
(String sortExpression) An expression that computes a score for each suggestion to control how they are sorted.withSourceField
(String sourceField) The name of the index field you want to use for suggestions.
-
Constructor Details
-
DocumentSuggesterOptions
public DocumentSuggesterOptions()
-
-
Method Details
-
setSourceField
The name of the index field you want to use for suggestions.
- Parameters:
sourceField
- The name of the index field you want to use for suggestions.
-
getSourceField
The name of the index field you want to use for suggestions.
- Returns:
- The name of the index field you want to use for suggestions.
-
withSourceField
The name of the index field you want to use for suggestions.
- Parameters:
sourceField
- The name of the index field you want to use for suggestions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFuzzyMatching
The level of fuzziness allowed when suggesting matches for a string:
none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.- Parameters:
fuzzyMatching
- The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.- See Also:
-
getFuzzyMatching
The level of fuzziness allowed when suggesting matches for a string:
none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.- Returns:
- The level of fuzziness allowed when suggesting matches for a
string:
none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. - See Also:
-
withFuzzyMatching
The level of fuzziness allowed when suggesting matches for a string:
none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.- Parameters:
fuzzyMatching
- The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setFuzzyMatching
The level of fuzziness allowed when suggesting matches for a string:
none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.- Parameters:
fuzzyMatching
- The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.- See Also:
-
withFuzzyMatching
The level of fuzziness allowed when suggesting matches for a string:
none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.- Parameters:
fuzzyMatching
- The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setSortExpression
An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the
_score
value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.- Parameters:
sortExpression
- An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the_score
value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.
-
getSortExpression
An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the
_score
value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.- Returns:
- An expression that computes a score for each suggestion to
control how they are sorted. The scores are rounded to the
nearest integer, with a floor of 0 and a ceiling of 2^31-1. A
document's relevance score is not computed for suggestions, so
sort expressions cannot reference the
_score
value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.
-
withSortExpression
An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the
_score
value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.- Parameters:
sortExpression
- An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the_score
value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.- 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
-