Package com.mongodb.client.model.search
Interface FuzzySearchOptions
- All Superinterfaces:
Bson
Fuzzy search options that may be used with some
SearchOperator
s.- Since:
- 4.7
- MongoDB Atlas documentation
- autocomplete operator
- text operator
-
Field Summary
Fields inherited from interface org.bson.conversions.Bson
DEFAULT_CODEC_REGISTRY
-
Method Summary
Modifier and TypeMethodDescriptionstatic FuzzySearchOptions
ReturnsFuzzySearchOptions
that represents server defaults.maxEdits
(int maxEdits) Creates a newFuzzySearchOptions
with the maximum number of single-character edits required to match a search term.maxExpansions
(int maxExpansions) Creates a newFuzzySearchOptions
with the maximum number of variations to generate and consider to match a search term.Creates a newFuzzySearchOptions
with the specified option in situations when there is no builder method that better satisfies your needs.prefixLength
(int prefixLength) Creates a newFuzzySearchOptions
with the number of characters at the beginning of a search term that must exactly match.Methods inherited from interface org.bson.conversions.Bson
toBsonDocument, toBsonDocument
-
Method Details
-
maxEdits
Creates a newFuzzySearchOptions
with the maximum number of single-character edits required to match a search term.- Parameters:
maxEdits
- The maximum number of single-character edits required to match a search term.- Returns:
- A new
FuzzySearchOptions
.
-
prefixLength
Creates a newFuzzySearchOptions
with the number of characters at the beginning of a search term that must exactly match.- Parameters:
prefixLength
- The number of characters at the beginning of a search term that must exactly match.- Returns:
- A new
FuzzySearchOptions
.
-
maxExpansions
Creates a newFuzzySearchOptions
with the maximum number of variations to generate and consider to match a search term.- Parameters:
maxExpansions
- The maximum number of variations to generate and consider to match a search term.- Returns:
- A new
FuzzySearchOptions
.
-
option
Creates a newFuzzySearchOptions
with the specified option in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.Example
The following code creates two functionally equivalentFuzzySearchOptions
objects, though they may not be equal.FuzzySearchOptions options1 = FuzzySearchOptions.fuzzySearchOptions().maxEdits(1); FuzzySearchOptions options2 = FuzzySearchOptions.fuzzySearchOptions().option("maxEdits", 1);
- Parameters:
name
- The option name.value
- The option value.- Returns:
- A new
FuzzySearchOptions
.
-
fuzzySearchOptions
ReturnsFuzzySearchOptions
that represents server defaults.- Returns:
FuzzySearchOptions
that represents server defaults.
-