Package org.apache.lucene.search.spell
Enum SuggestMode
- All Implemented Interfaces:
Serializable
,Comparable<SuggestMode>
Set of strategies for suggesting related terms
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Enum Constant Summary
Enum ConstantDescriptionAlways attempt to offer suggestions (however, other parameters may limit suggestions.Return only suggested words that are as frequent or more frequent than the searched wordGenerate suggestions only for terms not in the index (default) -
Method Summary
Modifier and TypeMethodDescriptionstatic SuggestMode
Returns the enum constant of this type with the specified name.static SuggestMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
SUGGEST_WHEN_NOT_IN_INDEX
Generate suggestions only for terms not in the index (default) -
SUGGEST_MORE_POPULAR
Return only suggested words that are as frequent or more frequent than the searched word -
SUGGEST_ALWAYS
Always attempt to offer suggestions (however, other parameters may limit suggestions. For example, seeDirectSpellChecker.setMaxQueryFrequency(float)
).
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-