SpellCheckParameters (EXALEAD CloudView Custom code SDK)

java.lang.Object
- com.exalead.linguistic.v10.SpellCheckParameters

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class SpellCheckParameters
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`allSuggestionsMustAlwaysBeRetrieved`
`java.lang.String`	`blacklist`
`double`	`blank`
`static boolean`	`DEFAULT_ALL_SUGGESTIONS_MUST_ALWAYS_BE_RETRIEVED`
`static double`	`DEFAULT_BLANK`
`static double`	`DEFAULT_DELETION`
`static boolean`	`DEFAULT_FILTER_PHONETIC`
`static boolean`	`DEFAULT_FILTER_WHITE_LIST`
`static double`	`DEFAULT_FIRST`
`static double`	`DEFAULT_INSERTION`
`static int`	`DEFAULT_MAX_APPROX`
`static int`	`DEFAULT_MAX_SUGGESTIONS`
`static int`	`DEFAULT_MIN_LENGTH_CANDIDATE`
`static int`	`DEFAULT_MIN_LENGTH_CANDIDATE2`
`static int`	`DEFAULT_MIN_LENGTH_INSIDE_MULTI_WORD_CANDIDATE`
`static int`	`DEFAULT_MIN_LENGTH_INSIDE_MULTI_WORD_CANDIDATE2`
`static int`	`DEFAULT_MIN_LENGTH_MULTI_WORD_CANDIDATE`
`static int`	`DEFAULT_MIN_LENGTH_MULTI_WORD_CANDIDATE2`
`static int`	`DEFAULT_MIN_N_GRAM_LENGTH_FOR_DIST2`
`static double`	`DEFAULT_PHONETIC_DIST`
`static double`	`DEFAULT_PRECISION`
`static double`	`DEFAULT_SUBSTITUTION`
`static int`	`DEFAULT_TIMEOUT_M_S`
`static boolean`	`DEFAULT_TOKENIZE_RESULTS`
`static double`	`DEFAULT_TRANSPOSITION`
`double`	`deletion`
`boolean`	`filterPhonetic`
`boolean`	`filterWhiteList`
`double`	`first`
`double`	`insertion`
`int`	`maxApprox`
`int`	`maxSuggestions`
`int`	`minLengthCandidate`
`int`	`minLengthCandidate2`
`int`	`minLengthInsideMultiWordCandidate`
`int`	`minLengthInsideMultiWordCandidate2`
`int`	`minLengthMultiWordCandidate`
`int`	`minLengthMultiWordCandidate2`
`int`	`minNGramLengthForDist2`
`double`	`phoneticDist`
`double`	`precision`
`SpellCheckBlackList`	`spellCheckBlackList`
`SpellCheckWhiteList`	`spellCheckWhiteList`
`double`	`substitution`
`int`	`timeoutMS`
`boolean`	`tokenizeResults`
`double`	`transposition`
`java.lang.String`	`whitelist`

Constructor Summary

Constructors
Constructor and Description

SpellCheckParameters()

SpellCheckParameters(SpellCheckParameters o)
Copy constructor

Constructors
Constructor and Description
`SpellCheckParameters()`
`SpellCheckParameters(SpellCheckParameters o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this SpellCheckParameters.
`static SpellCheckParameters`	`fromString(java.lang.String s)` String representation of this SpellCheckParameters.
`java.lang.String`	`getBlacklist()` Reference a dictionary's spellcheck block list resource. Used to never suggest expressions for the listed words.
`double`	`getBlank()` Damerau-Levenshtein distance incurred for inserting or deleting a space.
`double`	`getDeletion()` Damerau-Levenshtein distance incurred for deleting a letter.
`double`	`getFirst()` Additional Damerau-Levenshtein distance incurred for any operation on the first letter of a word.
`double`	`getInsertion()` Damerau-Levenshtein distance incurred for inserting a letter.
`int`	`getMaxApprox()` Maximum number of alternate spellings to retrieve for each word.
`int`	`getMaxSuggestions()` Suggests no more than N alternate expressions
`int`	`getMinLengthCandidate()` Minimum length for a word to trigger a distance 1 spell check.
`int`	`getMinLengthCandidate2()` Minimum length for a word to trigger a distance 2 spell check.
`int`	`getMinLengthInsideMultiWordCandidate()` Minimum length for a word in the middle of a multi-word expression to trigger a distance 1 spell check.
`int`	`getMinLengthInsideMultiWordCandidate2()` Minimum length for a word in the middle of a multi-word expression to trigger a distance 2 spell check.
`int`	`getMinLengthMultiWordCandidate()` Minimum length for a word anywhere in a multi-word expression to trigger a distance 1 spell check.
`int`	`getMinLengthMultiWordCandidate2()` Minimum length for a word anywhere in a multi-word expression to trigger a distance 2 spell check.
`int`	`getMinNGramLengthForDist2()` Minimum length for a multi-word expression to trigger a distance 2 spell check.
`double`	`getPhoneticDist()` Damerau-Levenshtein distance incurred for phonetic matches.
`double`	`getPrecision()` The higher the precision, the less often alternatives are proposed; the lower, the more recall.
`SpellCheckBlackList`	`getSpellCheckBlackList()` Never suggest expressions for these words.
`SpellCheckWhiteList`	`getSpellCheckWhiteList()` Always suggest expressions for these words.
`double`	`getSubstitution()` Damerau-Levenshtein distance incurred for substituting a letter.
`int`	`getTimeoutMS()` Time allotted to the computing of spell suggestions.
`double`	`getTransposition()` Damerau-Levenshtein distance incurred for transposing letters.
`java.lang.String`	`getWhitelist()` Reference a dictionary's spellcheck allow list resource. Used to always suggest expressions for the listed words.
`boolean`	`isAllSuggestionsMustAlwaysBeRetrieved()` Suggests alternate expressions even when they have a lower score than the corresponding expression from the original query.
`boolean`	`isFilterPhonetic()` Applies the minimum length criteria on phonetic matches.
`boolean`	`isFilterWhiteList()` Applies minimum length criteria on allow list entries.
`boolean`	`isTokenizeResults()` Tokenizes the suggested expression, and annotates each token with the corresponding word from the original query.
`SpellCheckParameters`	`makeCopy()` Creates and returns a deep copy of this SpellCheckParameters.
`static SpellCheckParameters`	`readFrom(java.io.InputStream is)` Read this SpellCheckParameters from an XML fragment.
`void`	`setAllSuggestionsMustAlwaysBeRetrieved(boolean allSuggestionsMustAlwaysBeRetrieved)` Suggests alternate expressions even when they have a lower score than the corresponding expression from the original query.
`void`	`setBlacklist(java.lang.String blacklist)` Reference a dictionary's spellcheck block list resource. Used to never suggest expressions for the listed words.
`void`	`setBlank(double blank)` Damerau-Levenshtein distance incurred for inserting or deleting a space.
`void`	`setDeletion(double deletion)` Damerau-Levenshtein distance incurred for deleting a letter.
`void`	`setFilterPhonetic(boolean filterPhonetic)` Applies the minimum length criteria on phonetic matches.
`void`	`setFilterWhiteList(boolean filterWhiteList)` Applies minimum length criteria on allow list entries.
`void`	`setFirst(double first)` Additional Damerau-Levenshtein distance incurred for any operation on the first letter of a word.
`void`	`setInsertion(double insertion)` Damerau-Levenshtein distance incurred for inserting a letter.
`void`	`setMaxApprox(int maxApprox)` Maximum number of alternate spellings to retrieve for each word.
`void`	`setMaxSuggestions(int maxSuggestions)` Suggests no more than N alternate expressions
`void`	`setMinLengthCandidate(int minLengthCandidate)` Minimum length for a word to trigger a distance 1 spell check.
`void`	`setMinLengthCandidate2(int minLengthCandidate2)` Minimum length for a word to trigger a distance 2 spell check.
`void`	`setMinLengthInsideMultiWordCandidate(int minLengthInsideMultiWordCandidate)` Minimum length for a word in the middle of a multi-word expression to trigger a distance 1 spell check.
`void`	`setMinLengthInsideMultiWordCandidate2(int minLengthInsideMultiWordCandidate2)` Minimum length for a word in the middle of a multi-word expression to trigger a distance 2 spell check.
`void`	`setMinLengthMultiWordCandidate(int minLengthMultiWordCandidate)` Minimum length for a word anywhere in a multi-word expression to trigger a distance 1 spell check.
`void`	`setMinLengthMultiWordCandidate2(int minLengthMultiWordCandidate2)` Minimum length for a word anywhere in a multi-word expression to trigger a distance 2 spell check.
`void`	`setMinNGramLengthForDist2(int minNGramLengthForDist2)` Minimum length for a multi-word expression to trigger a distance 2 spell check.
`void`	`setPhoneticDist(double phoneticDist)` Damerau-Levenshtein distance incurred for phonetic matches.
`void`	`setPrecision(double precision)` The higher the precision, the less often alternatives are proposed; the lower, the more recall.
`void`	`setSpellCheckBlackList(SpellCheckBlackList spellCheckBlackList)` Never suggest expressions for these words.
`void`	`setSpellCheckWhiteList(SpellCheckWhiteList spellCheckWhiteList)` Always suggest expressions for these words.
`void`	`setSubstitution(double substitution)` Damerau-Levenshtein distance incurred for substituting a letter.
`void`	`setTimeoutMS(int timeoutMS)` Time allotted to the computing of spell suggestions.
`void`	`setTokenizeResults(boolean tokenizeResults)` Tokenizes the suggested expression, and annotates each token with the corresponding word from the original query.
`void`	`setTransposition(double transposition)` Damerau-Levenshtein distance incurred for transposing letters.
`void`	`setWhitelist(java.lang.String whitelist)` Reference a dictionary's spellcheck allow list resource. Used to always suggest expressions for the listed words.
`java.lang.String`	`toString()` String representation of this SpellCheckParameters.
`SpellCheckParameters`	`withAllSuggestionsMustAlwaysBeRetrieved(boolean allSuggestionsMustAlwaysBeRetrieved)`
`SpellCheckParameters`	`withAllSuggestionsMustAlwaysBeRetrieved(java.lang.Boolean allSuggestionsMustAlwaysBeRetrieved)`
`SpellCheckParameters`	`withBlacklist(java.lang.String blacklist)`
`SpellCheckParameters`	`withBlank(double blank)`
`SpellCheckParameters`	`withDeletion(double deletion)`
`SpellCheckParameters`	`withFilterPhonetic(boolean filterPhonetic)`
`SpellCheckParameters`	`withFilterPhonetic(java.lang.Boolean filterPhonetic)`
`SpellCheckParameters`	`withFilterWhiteList(boolean filterWhiteList)`
`SpellCheckParameters`	`withFilterWhiteList(java.lang.Boolean filterWhiteList)`
`SpellCheckParameters`	`withFirst(double first)`
`SpellCheckParameters`	`withInsertion(double insertion)`
`SpellCheckParameters`	`withMaxApprox(int maxApprox)`
`SpellCheckParameters`	`withMaxApprox(java.lang.Integer maxApprox)`
`SpellCheckParameters`	`withMaxSuggestions(int maxSuggestions)`
`SpellCheckParameters`	`withMaxSuggestions(java.lang.Integer maxSuggestions)`
`SpellCheckParameters`	`withMinLengthCandidate(int minLengthCandidate)`
`SpellCheckParameters`	`withMinLengthCandidate(java.lang.Integer minLengthCandidate)`
`SpellCheckParameters`	`withMinLengthCandidate2(int minLengthCandidate2)`
`SpellCheckParameters`	`withMinLengthCandidate2(java.lang.Integer minLengthCandidate2)`
`SpellCheckParameters`	`withMinLengthInsideMultiWordCandidate(int minLengthInsideMultiWordCandidate)`
`SpellCheckParameters`	`withMinLengthInsideMultiWordCandidate(java.lang.Integer minLengthInsideMultiWordCandidate)`
`SpellCheckParameters`	`withMinLengthInsideMultiWordCandidate2(int minLengthInsideMultiWordCandidate2)`
`SpellCheckParameters`	`withMinLengthInsideMultiWordCandidate2(java.lang.Integer minLengthInsideMultiWordCandidate2)`
`SpellCheckParameters`	`withMinLengthMultiWordCandidate(int minLengthMultiWordCandidate)`
`SpellCheckParameters`	`withMinLengthMultiWordCandidate(java.lang.Integer minLengthMultiWordCandidate)`
`SpellCheckParameters`	`withMinLengthMultiWordCandidate2(int minLengthMultiWordCandidate2)`
`SpellCheckParameters`	`withMinLengthMultiWordCandidate2(java.lang.Integer minLengthMultiWordCandidate2)`
`SpellCheckParameters`	`withMinNGramLengthForDist2(int minNGramLengthForDist2)`
`SpellCheckParameters`	`withMinNGramLengthForDist2(java.lang.Integer minNGramLengthForDist2)`
`SpellCheckParameters`	`withPhoneticDist(double phoneticDist)`
`SpellCheckParameters`	`withPrecision(double precision)`
`SpellCheckParameters`	`withSpellCheckBlackList(SpellCheckBlackList spellCheckBlackList)`
`SpellCheckParameters`	`withSpellCheckWhiteList(SpellCheckWhiteList spellCheckWhiteList)`
`SpellCheckParameters`	`withSubstitution(double substitution)`
`SpellCheckParameters`	`withTimeoutMS(int timeoutMS)`
`SpellCheckParameters`	`withTimeoutMS(java.lang.Integer timeoutMS)`
`SpellCheckParameters`	`withTokenizeResults(boolean tokenizeResults)`
`SpellCheckParameters`	`withTokenizeResults(java.lang.Boolean tokenizeResults)`
`SpellCheckParameters`	`withTransposition(double transposition)`
`SpellCheckParameters`	`withWhitelist(java.lang.String whitelist)`
`void`	`writeTo(java.io.OutputStream os)` Write this SpellCheckParameters as an XML fragment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - maxApprox
```
public int maxApprox
```
  - DEFAULT_MAX_APPROX
```
public static final int DEFAULT_MAX_APPROX
```
    See Also:
    
    Constant Field Values
  - insertion
```
public double insertion
```
  - DEFAULT_INSERTION
```
public static final double DEFAULT_INSERTION
```
    See Also:
    
    Constant Field Values
  - deletion
```
public double deletion
```
  - DEFAULT_DELETION
```
public static final double DEFAULT_DELETION
```
    See Also:
    
    Constant Field Values
  - substitution
```
public double substitution
```
  - DEFAULT_SUBSTITUTION
```
public static final double DEFAULT_SUBSTITUTION
```
    See Also:
    
    Constant Field Values
  - transposition
```
public double transposition
```
  - DEFAULT_TRANSPOSITION
```
public static final double DEFAULT_TRANSPOSITION
```
    See Also:
    
    Constant Field Values
  - first
```
public double first
```
  - DEFAULT_FIRST
```
public static final double DEFAULT_FIRST
```
    See Also:
    
    Constant Field Values
  - blank
```
public double blank
```
  - DEFAULT_BLANK
```
public static final double DEFAULT_BLANK
```
    See Also:
    
    Constant Field Values
  - phoneticDist
```
public double phoneticDist
```
  - DEFAULT_PHONETIC_DIST
```
public static final double DEFAULT_PHONETIC_DIST
```
    See Also:
    
    Constant Field Values
  - precision
```
public double precision
```
  - DEFAULT_PRECISION
```
public static final double DEFAULT_PRECISION
```
    See Also:
    
    Constant Field Values
  - minLengthCandidate
```
public int minLengthCandidate
```
  - DEFAULT_MIN_LENGTH_CANDIDATE
```
public static final int DEFAULT_MIN_LENGTH_CANDIDATE
```
    See Also:
    
    Constant Field Values
  - minLengthCandidate2
```
public int minLengthCandidate2
```
  - DEFAULT_MIN_LENGTH_CANDIDATE2
```
public static final int DEFAULT_MIN_LENGTH_CANDIDATE2
```
    See Also:
    
    Constant Field Values
  - minLengthMultiWordCandidate
```
public int minLengthMultiWordCandidate
```
  - DEFAULT_MIN_LENGTH_MULTI_WORD_CANDIDATE
```
public static final int DEFAULT_MIN_LENGTH_MULTI_WORD_CANDIDATE
```
    See Also:
    
    Constant Field Values
  - minLengthMultiWordCandidate2
```
public int minLengthMultiWordCandidate2
```
  - DEFAULT_MIN_LENGTH_MULTI_WORD_CANDIDATE2
```
public static final int DEFAULT_MIN_LENGTH_MULTI_WORD_CANDIDATE2
```
    See Also:
    
    Constant Field Values
  - minLengthInsideMultiWordCandidate
```
public int minLengthInsideMultiWordCandidate
```
  - DEFAULT_MIN_LENGTH_INSIDE_MULTI_WORD_CANDIDATE
```
public static final int DEFAULT_MIN_LENGTH_INSIDE_MULTI_WORD_CANDIDATE
```
    See Also:
    
    Constant Field Values
  - minLengthInsideMultiWordCandidate2
```
public int minLengthInsideMultiWordCandidate2
```
  - DEFAULT_MIN_LENGTH_INSIDE_MULTI_WORD_CANDIDATE2
```
public static final int DEFAULT_MIN_LENGTH_INSIDE_MULTI_WORD_CANDIDATE2
```
    See Also:
    
    Constant Field Values
  - minNGramLengthForDist2
```
public int minNGramLengthForDist2
```
  - DEFAULT_MIN_N_GRAM_LENGTH_FOR_DIST2
```
public static final int DEFAULT_MIN_N_GRAM_LENGTH_FOR_DIST2
```
    See Also:
    
    Constant Field Values
  - filterWhiteList
```
public boolean filterWhiteList
```
  - DEFAULT_FILTER_WHITE_LIST
```
public static final boolean DEFAULT_FILTER_WHITE_LIST
```
    See Also:
    
    Constant Field Values
  - filterPhonetic
```
public boolean filterPhonetic
```
  - DEFAULT_FILTER_PHONETIC
```
public static final boolean DEFAULT_FILTER_PHONETIC
```
    See Also:
    
    Constant Field Values
  - tokenizeResults
```
public boolean tokenizeResults
```
  - DEFAULT_TOKENIZE_RESULTS
```
public static final boolean DEFAULT_TOKENIZE_RESULTS
```
    See Also:
    
    Constant Field Values
  - maxSuggestions
```
public int maxSuggestions
```
  - DEFAULT_MAX_SUGGESTIONS
```
public static final int DEFAULT_MAX_SUGGESTIONS
```
    See Also:
    
    Constant Field Values
  - allSuggestionsMustAlwaysBeRetrieved
```
public boolean allSuggestionsMustAlwaysBeRetrieved
```
  - DEFAULT_ALL_SUGGESTIONS_MUST_ALWAYS_BE_RETRIEVED
```
public static final boolean DEFAULT_ALL_SUGGESTIONS_MUST_ALWAYS_BE_RETRIEVED
```
    See Also:
    
    Constant Field Values
  - spellCheckWhiteList
```
public SpellCheckWhiteList spellCheckWhiteList
```
  - spellCheckBlackList
```
public SpellCheckBlackList spellCheckBlackList
```
  - whitelist
```
public java.lang.String whitelist
```
  - blacklist
```
public java.lang.String blacklist
```
  - timeoutMS
```
public int timeoutMS
```
  - DEFAULT_TIMEOUT_M_S
```
public static final int DEFAULT_TIMEOUT_M_S
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SpellCheckParameters
```
public SpellCheckParameters()
```
  - SpellCheckParameters
```
public SpellCheckParameters(SpellCheckParameters o)
```
    Copy constructor
- Method Detail
  - setMaxApprox
```
public void setMaxApprox(int maxApprox)
```
    Maximum number of alternate spellings to retrieve for each word.
  - getMaxApprox
```
public int getMaxApprox()
```
    Maximum number of alternate spellings to retrieve for each word.
  - withMaxApprox
```
public SpellCheckParameters withMaxApprox(int maxApprox)
```
  - withMaxApprox
```
public SpellCheckParameters withMaxApprox(java.lang.Integer maxApprox)
```
  - setInsertion
```
public void setInsertion(double insertion)
```
    Damerau-Levenshtein distance incurred for inserting a letter.
  - getInsertion
```
public double getInsertion()
```
    Damerau-Levenshtein distance incurred for inserting a letter.
  - withInsertion
```
public SpellCheckParameters withInsertion(double insertion)
```
  - setDeletion
```
public void setDeletion(double deletion)
```
    Damerau-Levenshtein distance incurred for deleting a letter.
  - getDeletion
```
public double getDeletion()
```
    Damerau-Levenshtein distance incurred for deleting a letter.
  - withDeletion
```
public SpellCheckParameters withDeletion(double deletion)
```
  - setSubstitution
```
public void setSubstitution(double substitution)
```
    Damerau-Levenshtein distance incurred for substituting a letter.
  - getSubstitution
```
public double getSubstitution()
```
    Damerau-Levenshtein distance incurred for substituting a letter.
  - withSubstitution
```
public SpellCheckParameters withSubstitution(double substitution)
```
  - setTransposition
```
public void setTransposition(double transposition)
```
    Damerau-Levenshtein distance incurred for transposing letters.
  - getTransposition
```
public double getTransposition()
```
    Damerau-Levenshtein distance incurred for transposing letters.
  - withTransposition
```
public SpellCheckParameters withTransposition(double transposition)
```
  - setFirst
```
public void setFirst(double first)
```
    Additional Damerau-Levenshtein distance incurred for any operation on the first letter of a word.
  - getFirst
```
public double getFirst()
```
    Additional Damerau-Levenshtein distance incurred for any operation on the first letter of a word.
  - withFirst
```
public SpellCheckParameters withFirst(double first)
```
  - setBlank
```
public void setBlank(double blank)
```
    Damerau-Levenshtein distance incurred for inserting or deleting a space.
  - getBlank
```
public double getBlank()
```
    Damerau-Levenshtein distance incurred for inserting or deleting a space.
  - withBlank
```
public SpellCheckParameters withBlank(double blank)
```
  - setPhoneticDist
```
public void setPhoneticDist(double phoneticDist)
```
    Damerau-Levenshtein distance incurred for phonetic matches.
  - getPhoneticDist
```
public double getPhoneticDist()
```
    Damerau-Levenshtein distance incurred for phonetic matches.
  - withPhoneticDist
```
public SpellCheckParameters withPhoneticDist(double phoneticDist)
```
  - setPrecision
```
public void setPrecision(double precision)
```
    The higher the precision, the less often alternatives are proposed; the lower, the more recall.
  - getPrecision
```
public double getPrecision()
```
    The higher the precision, the less often alternatives are proposed; the lower, the more recall.
  - withPrecision
```
public SpellCheckParameters withPrecision(double precision)
```
  - setMinLengthCandidate
```
public void setMinLengthCandidate(int minLengthCandidate)
```
    Minimum length for a word to trigger a distance 1 spell check.
  - getMinLengthCandidate
```
public int getMinLengthCandidate()
```
    Minimum length for a word to trigger a distance 1 spell check.
  - withMinLengthCandidate
```
public SpellCheckParameters withMinLengthCandidate(int minLengthCandidate)
```
  - withMinLengthCandidate
```
public SpellCheckParameters withMinLengthCandidate(java.lang.Integer minLengthCandidate)
```
  - setMinLengthCandidate2
```
public void setMinLengthCandidate2(int minLengthCandidate2)
```
    Minimum length for a word to trigger a distance 2 spell check.
  - getMinLengthCandidate2
```
public int getMinLengthCandidate2()
```
    Minimum length for a word to trigger a distance 2 spell check.
  - withMinLengthCandidate2
```
public SpellCheckParameters withMinLengthCandidate2(int minLengthCandidate2)
```
  - withMinLengthCandidate2
```
public SpellCheckParameters withMinLengthCandidate2(java.lang.Integer minLengthCandidate2)
```
  - setMinLengthMultiWordCandidate
```
public void setMinLengthMultiWordCandidate(int minLengthMultiWordCandidate)
```
    Minimum length for a word anywhere in a multi-word expression to trigger a distance 1 spell check.
  - getMinLengthMultiWordCandidate
```
public int getMinLengthMultiWordCandidate()
```
    Minimum length for a word anywhere in a multi-word expression to trigger a distance 1 spell check.
  - withMinLengthMultiWordCandidate
```
public SpellCheckParameters withMinLengthMultiWordCandidate(int minLengthMultiWordCandidate)
```
  - withMinLengthMultiWordCandidate
```
public SpellCheckParameters withMinLengthMultiWordCandidate(java.lang.Integer minLengthMultiWordCandidate)
```
  - setMinLengthMultiWordCandidate2
```
public void setMinLengthMultiWordCandidate2(int minLengthMultiWordCandidate2)
```
    Minimum length for a word anywhere in a multi-word expression to trigger a distance 2 spell check.
  - getMinLengthMultiWordCandidate2
```
public int getMinLengthMultiWordCandidate2()
```
    Minimum length for a word anywhere in a multi-word expression to trigger a distance 2 spell check.
  - withMinLengthMultiWordCandidate2
```
public SpellCheckParameters withMinLengthMultiWordCandidate2(int minLengthMultiWordCandidate2)
```
  - withMinLengthMultiWordCandidate2
```
public SpellCheckParameters withMinLengthMultiWordCandidate2(java.lang.Integer minLengthMultiWordCandidate2)
```
  - setMinLengthInsideMultiWordCandidate
```
public void setMinLengthInsideMultiWordCandidate(int minLengthInsideMultiWordCandidate)
```
    Minimum length for a word in the middle of a multi-word expression to trigger a distance 1 spell check.
  - getMinLengthInsideMultiWordCandidate
```
public int getMinLengthInsideMultiWordCandidate()
```
    Minimum length for a word in the middle of a multi-word expression to trigger a distance 1 spell check.
  - withMinLengthInsideMultiWordCandidate
```
public SpellCheckParameters withMinLengthInsideMultiWordCandidate(int minLengthInsideMultiWordCandidate)
```
  - withMinLengthInsideMultiWordCandidate
```
public SpellCheckParameters withMinLengthInsideMultiWordCandidate(java.lang.Integer minLengthInsideMultiWordCandidate)
```
  - setMinLengthInsideMultiWordCandidate2
```
public void setMinLengthInsideMultiWordCandidate2(int minLengthInsideMultiWordCandidate2)
```
    Minimum length for a word in the middle of a multi-word expression to trigger a distance 2 spell check.
  - getMinLengthInsideMultiWordCandidate2
```
public int getMinLengthInsideMultiWordCandidate2()
```
    Minimum length for a word in the middle of a multi-word expression to trigger a distance 2 spell check.
  - withMinLengthInsideMultiWordCandidate2
```
public SpellCheckParameters withMinLengthInsideMultiWordCandidate2(int minLengthInsideMultiWordCandidate2)
```
  - withMinLengthInsideMultiWordCandidate2
```
public SpellCheckParameters withMinLengthInsideMultiWordCandidate2(java.lang.Integer minLengthInsideMultiWordCandidate2)
```
  - setMinNGramLengthForDist2
```
public void setMinNGramLengthForDist2(int minNGramLengthForDist2)
```
    Minimum length for a multi-word expression to trigger a distance 2 spell check.
  - getMinNGramLengthForDist2
```
public int getMinNGramLengthForDist2()
```
    Minimum length for a multi-word expression to trigger a distance 2 spell check.
  - withMinNGramLengthForDist2
```
public SpellCheckParameters withMinNGramLengthForDist2(int minNGramLengthForDist2)
```
  - withMinNGramLengthForDist2
```
public SpellCheckParameters withMinNGramLengthForDist2(java.lang.Integer minNGramLengthForDist2)
```
  - setFilterWhiteList
```
public void setFilterWhiteList(boolean filterWhiteList)
```
    Applies minimum length criteria on allow list entries.
  - isFilterWhiteList
```
public boolean isFilterWhiteList()
```
    Applies minimum length criteria on allow list entries.
  - withFilterWhiteList
```
public SpellCheckParameters withFilterWhiteList(boolean filterWhiteList)
```
  - withFilterWhiteList
```
public SpellCheckParameters withFilterWhiteList(java.lang.Boolean filterWhiteList)
```
  - setFilterPhonetic
```
public void setFilterPhonetic(boolean filterPhonetic)
```
    Applies the minimum length criteria on phonetic matches.
  - isFilterPhonetic
```
public boolean isFilterPhonetic()
```
    Applies the minimum length criteria on phonetic matches.
  - withFilterPhonetic
```
public SpellCheckParameters withFilterPhonetic(boolean filterPhonetic)
```
  - withFilterPhonetic
```
public SpellCheckParameters withFilterPhonetic(java.lang.Boolean filterPhonetic)
```
  - setTokenizeResults
```
public void setTokenizeResults(boolean tokenizeResults)
```
    Tokenizes the suggested expression, and annotates each token with the corresponding word from the original query. This allows for additional processing after spellchecking, such as lemmatization, and normalization.
    For example, for a suggested expression of 3 tokens:
    - If true: each token has an annotation representing the associated word from the original user query.
    - If false: The first token is annotated with 3 tokens and a length of 3.
  - isTokenizeResults
```
public boolean isTokenizeResults()
```
    Tokenizes the suggested expression, and annotates each token with the corresponding word from the original query. This allows for additional processing after spellchecking, such as lemmatization, and normalization.
    For example, for a suggested expression of 3 tokens:
    - If true: each token has an annotation representing the associated word from the original user query.
    - If false: The first token is annotated with 3 tokens and a length of 3.
  - withTokenizeResults
```
public SpellCheckParameters withTokenizeResults(boolean tokenizeResults)
```
  - withTokenizeResults
```
public SpellCheckParameters withTokenizeResults(java.lang.Boolean tokenizeResults)
```
  - setMaxSuggestions
```
public void setMaxSuggestions(int maxSuggestions)
```
    Suggests no more than N alternate expressions
  - getMaxSuggestions
```
public int getMaxSuggestions()
```
    Suggests no more than N alternate expressions
  - withMaxSuggestions
```
public SpellCheckParameters withMaxSuggestions(int maxSuggestions)
```
  - withMaxSuggestions
```
public SpellCheckParameters withMaxSuggestions(java.lang.Integer maxSuggestions)
```
  - setAllSuggestionsMustAlwaysBeRetrieved
```
public void setAllSuggestionsMustAlwaysBeRetrieved(boolean allSuggestionsMustAlwaysBeRetrieved)
```
    Suggests alternate expressions even when they have a lower score than the corresponding expression from the original query. The score is determined by an algorithm that considers both the Damerau-Levenshtein distance and frequency in the corpus.
  - isAllSuggestionsMustAlwaysBeRetrieved
```
public boolean isAllSuggestionsMustAlwaysBeRetrieved()
```
    Suggests alternate expressions even when they have a lower score than the corresponding expression from the original query. The score is determined by an algorithm that considers both the Damerau-Levenshtein distance and frequency in the corpus.
  - withAllSuggestionsMustAlwaysBeRetrieved
```
public SpellCheckParameters withAllSuggestionsMustAlwaysBeRetrieved(boolean allSuggestionsMustAlwaysBeRetrieved)
```
  - withAllSuggestionsMustAlwaysBeRetrieved
```
public SpellCheckParameters withAllSuggestionsMustAlwaysBeRetrieved(java.lang.Boolean allSuggestionsMustAlwaysBeRetrieved)
```
  - setSpellCheckWhiteList
```
public void setSpellCheckWhiteList(SpellCheckWhiteList spellCheckWhiteList)
```
    Always suggest expressions for these words.
  - getSpellCheckWhiteList
```
public SpellCheckWhiteList getSpellCheckWhiteList()
```
    Always suggest expressions for these words.
  - withSpellCheckWhiteList
```
public SpellCheckParameters withSpellCheckWhiteList(SpellCheckWhiteList spellCheckWhiteList)
```
  - setSpellCheckBlackList
```
public void setSpellCheckBlackList(SpellCheckBlackList spellCheckBlackList)
```
    Never suggest expressions for these words.
  - getSpellCheckBlackList
```
public SpellCheckBlackList getSpellCheckBlackList()
```
    Never suggest expressions for these words.
  - withSpellCheckBlackList
```
public SpellCheckParameters withSpellCheckBlackList(SpellCheckBlackList spellCheckBlackList)
```
  - setWhitelist
```
public void setWhitelist(java.lang.String whitelist)
```
    Reference a dictionary's spellcheck allow list resource.
    Used to always suggest expressions for the listed words.
  - getWhitelist
```
public java.lang.String getWhitelist()
```
    Reference a dictionary's spellcheck allow list resource.
    Used to always suggest expressions for the listed words.
  - withWhitelist
```
public SpellCheckParameters withWhitelist(java.lang.String whitelist)
```
  - setBlacklist
```
public void setBlacklist(java.lang.String blacklist)
```
    Reference a dictionary's spellcheck block list resource.
    Used to never suggest expressions for the listed words.
  - getBlacklist
```
public java.lang.String getBlacklist()
```
    Reference a dictionary's spellcheck block list resource.
    Used to never suggest expressions for the listed words.
  - withBlacklist
```
public SpellCheckParameters withBlacklist(java.lang.String blacklist)
```
  - setTimeoutMS
```
public void setTimeoutMS(int timeoutMS)
```
    Time allotted to the computing of spell suggestions.
  - getTimeoutMS
```
public int getTimeoutMS()
```
    Time allotted to the computing of spell suggestions.
  - withTimeoutMS
```
public SpellCheckParameters withTimeoutMS(int timeoutMS)
```
  - withTimeoutMS
```
public SpellCheckParameters withTimeoutMS(java.lang.Integer timeoutMS)
```
  - makeCopy
```
public SpellCheckParameters makeCopy()
```
    Creates and returns a deep copy of this SpellCheckParameters.
  - readFrom
```
public static SpellCheckParameters readFrom(java.io.InputStream is)
                                     throws javax.xml.bind.JAXBException
```
    Read this SpellCheckParameters from an XML fragment.
    
    Throws:
    
    javax.xml.bind.JAXBException
  - writeTo
```
public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException
```
    Write this SpellCheckParameters as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static SpellCheckParameters fromString(java.lang.String s)
                                       throws javax.xml.bind.JAXBException,
                                              java.io.UnsupportedEncodingException
```
    String representation of this SpellCheckParameters.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this SpellCheckParameters.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this SpellCheckParameters.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class SpellCheckParameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

maxApprox

DEFAULT_MAX_APPROX

insertion

DEFAULT_INSERTION

deletion

DEFAULT_DELETION

substitution

DEFAULT_SUBSTITUTION

transposition

DEFAULT_TRANSPOSITION

first

DEFAULT_FIRST

blank

DEFAULT_BLANK

phoneticDist

DEFAULT_PHONETIC_DIST

precision

DEFAULT_PRECISION

minLengthCandidate

DEFAULT_MIN_LENGTH_CANDIDATE

minLengthCandidate2

DEFAULT_MIN_LENGTH_CANDIDATE2

minLengthMultiWordCandidate

DEFAULT_MIN_LENGTH_MULTI_WORD_CANDIDATE

minLengthMultiWordCandidate2

DEFAULT_MIN_LENGTH_MULTI_WORD_CANDIDATE2

minLengthInsideMultiWordCandidate

DEFAULT_MIN_LENGTH_INSIDE_MULTI_WORD_CANDIDATE

minLengthInsideMultiWordCandidate2

DEFAULT_MIN_LENGTH_INSIDE_MULTI_WORD_CANDIDATE2

minNGramLengthForDist2

DEFAULT_MIN_N_GRAM_LENGTH_FOR_DIST2

filterWhiteList

DEFAULT_FILTER_WHITE_LIST

filterPhonetic

DEFAULT_FILTER_PHONETIC

tokenizeResults

DEFAULT_TOKENIZE_RESULTS

maxSuggestions

DEFAULT_MAX_SUGGESTIONS

allSuggestionsMustAlwaysBeRetrieved

DEFAULT_ALL_SUGGESTIONS_MUST_ALWAYS_BE_RETRIEVED

spellCheckWhiteList

spellCheckBlackList

whitelist

blacklist

timeoutMS

DEFAULT_TIMEOUT_M_S

Constructor Detail

SpellCheckParameters

SpellCheckParameters

Method Detail

setMaxApprox

getMaxApprox

withMaxApprox

withMaxApprox

setInsertion

getInsertion

withInsertion

setDeletion

getDeletion

withDeletion

setSubstitution

getSubstitution

withSubstitution

setTransposition

getTransposition

withTransposition

setFirst

getFirst

withFirst

setBlank

getBlank

withBlank