SpellCheckerConfig (EXALEAD CloudView Custom code SDK)

java.lang.Object
- com.exalead.search.v30.SpellCheckerConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class SpellCheckerConfig
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`	`autoCorrect`
`java.lang.String`	`blacklistedPrefixHandlers`
`boolean`	`cancelBadCorrections`
`boolean`	`computeCorrectedNHits`
`static boolean`	`DEFAULT_AUTO_CORRECT`
`static java.lang.String`	`DEFAULT_BLACKLISTED_PREFIX_HANDLERS`
`static boolean`	`DEFAULT_CANCEL_BAD_CORRECTIONS`
`static boolean`	`DEFAULT_COMPUTE_CORRECTED_N_HITS`
`static boolean`	`DEFAULT_ENABLED`
`static boolean`	`DEFAULT_ENABLED_REFINE`
`static int`	`DEFAULT_GRACE_DELAY_M_S`
`static int`	`DEFAULT_HIT_THRESHOLD`
`static int`	`DEFAULT_QUERY_SIZE_LIMIT`
`java.lang.String`	`dictionaryName`
`boolean`	`enabled`
`boolean`	`enabledRefine`
`int`	`graceDelayMS`
`int`	`hitThreshold`
`int`	`querySizeLimit`
`SpellCheckParameters`	`spellCheckParameters`

Constructor Summary

Constructors
Constructor and Description

SpellCheckerConfig()

SpellCheckerConfig(SpellCheckerConfig o)
Copy constructor

Constructors
Constructor and Description
`SpellCheckerConfig()`
`SpellCheckerConfig(SpellCheckerConfig 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 SpellCheckerConfig.
`static SpellCheckerConfig`	`fromString(java.lang.String s)` String representation of this SpellCheckerConfig.
`java.lang.String`	`getBlacklistedPrefixHandlers()` A list of comma-separated prefix handler names defining which parts of the query will NOT be spell checked .
`java.lang.String`	`getDictionaryName()` Dictionary used for spell checking and allow/block lists
`int`	`getGraceDelayMS()` Maximum time to wait for spell checking after query processing has finished.
`int`	`getHitThreshold()` Only performs spell check if the query returns less than N hits. However, if N=0, spell check is always performed. For example, if N=4, spell check is only activated for queries that return 3 or less hits.
`int`	`getQuerySizeLimit()` Queries with more than this count of chunks are considered computer-generated queries for which the spellchecking is disabled.
`SpellCheckParameters`	`getSpellCheckParameters()` Low-level parameters.
`boolean`	`isAutoCorrect()` Automatically performs (uncorrected query) OR (corrected query 1) OR (corrected query 2) ...
`boolean`	`isCancelBadCorrections()` Leaves out alternate expressions that would return less hits than the original query. This requires computeCorrectedNHits to be true.
`boolean`	`isComputeCorrectedNHits()` Calculates and displays the number of hits that will be returned for each suggested expression. This can impact performance as CloudView must perform the query for each suggestion. Warning: This option is not compatible with disjunctive facets.
`boolean`	`isEnabled()` Enables spellcheck on queries.
`boolean`	`isEnabledRefine()` Suggests alternate expressions even if facets have been used to filter hits.
`SpellCheckerConfig`	`makeCopy()` Creates and returns a deep copy of this SpellCheckerConfig.
`static SpellCheckerConfig`	`readFrom(java.io.InputStream is)` Read this SpellCheckerConfig from an XML fragment.
`void`	`setAutoCorrect(boolean autoCorrect)` Automatically performs (uncorrected query) OR (corrected query 1) OR (corrected query 2) ...
`void`	`setBlacklistedPrefixHandlers(java.lang.String blacklistedPrefixHandlers)` A list of comma-separated prefix handler names defining which parts of the query will NOT be spell checked .
`void`	`setCancelBadCorrections(boolean cancelBadCorrections)` Leaves out alternate expressions that would return less hits than the original query. This requires computeCorrectedNHits to be true.
`void`	`setComputeCorrectedNHits(boolean computeCorrectedNHits)` Calculates and displays the number of hits that will be returned for each suggested expression. This can impact performance as CloudView must perform the query for each suggestion. Warning: This option is not compatible with disjunctive facets.
`void`	`setDictionaryName(java.lang.String dictionaryName)` Dictionary used for spell checking and allow/block lists
`void`	`setEnabled(boolean enabled)` Enables spellcheck on queries.
`void`	`setEnabledRefine(boolean enabledRefine)` Suggests alternate expressions even if facets have been used to filter hits.
`void`	`setGraceDelayMS(int graceDelayMS)` Maximum time to wait for spell checking after query processing has finished.
`void`	`setHitThreshold(int hitThreshold)` Only performs spell check if the query returns less than N hits. However, if N=0, spell check is always performed. For example, if N=4, spell check is only activated for queries that return 3 or less hits.
`void`	`setQuerySizeLimit(int querySizeLimit)` Queries with more than this count of chunks are considered computer-generated queries for which the spellchecking is disabled.
`void`	`setSpellCheckParameters(SpellCheckParameters spellCheckParameters)` Low-level parameters.
`java.lang.String`	`toString()` String representation of this SpellCheckerConfig.
`SpellCheckerConfig`	`withAutoCorrect(boolean autoCorrect)`
`SpellCheckerConfig`	`withAutoCorrect(java.lang.Boolean autoCorrect)`
`SpellCheckerConfig`	`withBlacklistedPrefixHandlers(java.lang.String blacklistedPrefixHandlers)`
`SpellCheckerConfig`	`withCancelBadCorrections(boolean cancelBadCorrections)`
`SpellCheckerConfig`	`withCancelBadCorrections(java.lang.Boolean cancelBadCorrections)`
`SpellCheckerConfig`	`withComputeCorrectedNHits(boolean computeCorrectedNHits)`
`SpellCheckerConfig`	`withComputeCorrectedNHits(java.lang.Boolean computeCorrectedNHits)`
`SpellCheckerConfig`	`withDictionaryName(java.lang.String dictionaryName)`
`SpellCheckerConfig`	`withEnabled(boolean enabled)`
`SpellCheckerConfig`	`withEnabled(java.lang.Boolean enabled)`
`SpellCheckerConfig`	`withEnabledRefine(boolean enabledRefine)`
`SpellCheckerConfig`	`withEnabledRefine(java.lang.Boolean enabledRefine)`
`SpellCheckerConfig`	`withGraceDelayMS(int graceDelayMS)`
`SpellCheckerConfig`	`withGraceDelayMS(java.lang.Integer graceDelayMS)`
`SpellCheckerConfig`	`withHitThreshold(int hitThreshold)`
`SpellCheckerConfig`	`withHitThreshold(java.lang.Integer hitThreshold)`
`SpellCheckerConfig`	`withQuerySizeLimit(int querySizeLimit)`
`SpellCheckerConfig`	`withQuerySizeLimit(java.lang.Integer querySizeLimit)`
`SpellCheckerConfig`	`withSpellCheckParameters(SpellCheckParameters spellCheckParameters)`
`void`	`writeTo(java.io.OutputStream os)` Write this SpellCheckerConfig as an XML fragment

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

- Field Detail
  - enabled
```
public boolean enabled
```
  - DEFAULT_ENABLED
```
public static final boolean DEFAULT_ENABLED
```
    See Also:
    
    Constant Field Values
  - blacklistedPrefixHandlers
```
public java.lang.String blacklistedPrefixHandlers
```
  - DEFAULT_BLACKLISTED_PREFIX_HANDLERS
```
public static final java.lang.String DEFAULT_BLACKLISTED_PREFIX_HANDLERS
```
    See Also:
    
    Constant Field Values
  - enabledRefine
```
public boolean enabledRefine
```
  - DEFAULT_ENABLED_REFINE
```
public static final boolean DEFAULT_ENABLED_REFINE
```
    See Also:
    
    Constant Field Values
  - computeCorrectedNHits
```
public boolean computeCorrectedNHits
```
  - DEFAULT_COMPUTE_CORRECTED_N_HITS
```
public static final boolean DEFAULT_COMPUTE_CORRECTED_N_HITS
```
    See Also:
    
    Constant Field Values
  - hitThreshold
```
public int hitThreshold
```
  - DEFAULT_HIT_THRESHOLD
```
public static final int DEFAULT_HIT_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - cancelBadCorrections
```
public boolean cancelBadCorrections
```
  - DEFAULT_CANCEL_BAD_CORRECTIONS
```
public static final boolean DEFAULT_CANCEL_BAD_CORRECTIONS
```
    See Also:
    
    Constant Field Values
  - autoCorrect
```
public boolean autoCorrect
```
  - DEFAULT_AUTO_CORRECT
```
public static final boolean DEFAULT_AUTO_CORRECT
```
    See Also:
    
    Constant Field Values
  - graceDelayMS
```
public int graceDelayMS
```
  - DEFAULT_GRACE_DELAY_M_S
```
public static final int DEFAULT_GRACE_DELAY_M_S
```
    See Also:
    
    Constant Field Values
  - querySizeLimit
```
public int querySizeLimit
```
  - DEFAULT_QUERY_SIZE_LIMIT
```
public static final int DEFAULT_QUERY_SIZE_LIMIT
```
    See Also:
    
    Constant Field Values
  - dictionaryName
```
public java.lang.String dictionaryName
```
  - spellCheckParameters
```
public SpellCheckParameters spellCheckParameters
```
- Constructor Detail
  - SpellCheckerConfig
```
public SpellCheckerConfig()
```
  - SpellCheckerConfig
```
public SpellCheckerConfig(SpellCheckerConfig o)
```
    Copy constructor
- Method Detail
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Enables spellcheck on queries.
  - isEnabled
```
public boolean isEnabled()
```
    Enables spellcheck on queries.
  - withEnabled
```
public SpellCheckerConfig withEnabled(boolean enabled)
```
  - withEnabled
```
public SpellCheckerConfig withEnabled(java.lang.Boolean enabled)
```
  - setBlacklistedPrefixHandlers
```
public void setBlacklistedPrefixHandlers(java.lang.String blacklistedPrefixHandlers)
```
    A list of comma-separated prefix handler names defining which parts of the query will NOT be spell checked .
  - getBlacklistedPrefixHandlers
```
public java.lang.String getBlacklistedPrefixHandlers()
```
    A list of comma-separated prefix handler names defining which parts of the query will NOT be spell checked .
  - withBlacklistedPrefixHandlers
```
public SpellCheckerConfig withBlacklistedPrefixHandlers(java.lang.String blacklistedPrefixHandlers)
```
  - setEnabledRefine
```
public void setEnabledRefine(boolean enabledRefine)
```
    Suggests alternate expressions even if facets have been used to filter hits.
  - isEnabledRefine
```
public boolean isEnabledRefine()
```
    Suggests alternate expressions even if facets have been used to filter hits.
  - withEnabledRefine
```
public SpellCheckerConfig withEnabledRefine(boolean enabledRefine)
```
  - withEnabledRefine
```
public SpellCheckerConfig withEnabledRefine(java.lang.Boolean enabledRefine)
```
  - setComputeCorrectedNHits
```
public void setComputeCorrectedNHits(boolean computeCorrectedNHits)
```
    Calculates and displays the number of hits that will be returned for each suggested expression.
    This can impact performance as CloudView must perform the query for each suggestion.
    Warning: This option is not compatible with disjunctive facets. The count will not report any values.
  - isComputeCorrectedNHits
```
public boolean isComputeCorrectedNHits()
```
    Calculates and displays the number of hits that will be returned for each suggested expression.
    This can impact performance as CloudView must perform the query for each suggestion.
    Warning: This option is not compatible with disjunctive facets. The count will not report any values.
  - withComputeCorrectedNHits
```
public SpellCheckerConfig withComputeCorrectedNHits(boolean computeCorrectedNHits)
```
  - withComputeCorrectedNHits
```
public SpellCheckerConfig withComputeCorrectedNHits(java.lang.Boolean computeCorrectedNHits)
```
  - setHitThreshold
```
public void setHitThreshold(int hitThreshold)
```
    Only performs spell check if the query returns less than N hits.
    However, if N=0, spell check is always performed.
    For example, if N=4, spell check is only activated for queries that return 3 or less hits.
  - getHitThreshold
```
public int getHitThreshold()
```
    Only performs spell check if the query returns less than N hits.
    However, if N=0, spell check is always performed.
    For example, if N=4, spell check is only activated for queries that return 3 or less hits.
  - withHitThreshold
```
public SpellCheckerConfig withHitThreshold(int hitThreshold)
```
  - withHitThreshold
```
public SpellCheckerConfig withHitThreshold(java.lang.Integer hitThreshold)
```
  - setCancelBadCorrections
```
public void setCancelBadCorrections(boolean cancelBadCorrections)
```
    Leaves out alternate expressions that would return less hits than the original query.
    This requires computeCorrectedNHits to be true.
  - isCancelBadCorrections
```
public boolean isCancelBadCorrections()
```
    Leaves out alternate expressions that would return less hits than the original query.
    This requires computeCorrectedNHits to be true.
  - withCancelBadCorrections
```
public SpellCheckerConfig withCancelBadCorrections(boolean cancelBadCorrections)
```
  - withCancelBadCorrections
```
public SpellCheckerConfig withCancelBadCorrections(java.lang.Boolean cancelBadCorrections)
```
  - setAutoCorrect
```
public void setAutoCorrect(boolean autoCorrect)
```
    Automatically performs (uncorrected query) OR (corrected query 1) OR (corrected query 2) ... If cancelBadCorrections and autoCorrect are both true, the query is performed three times:
    - The uncorrected query is performed to calculate the number of hits.
    - The corrected queries are performed to calculate the number of hits.
    - The corrected queries that yield more hits than the uncorrected query are added to the uncorrected query, and the resulting query is performed and returned to the user.
  - isAutoCorrect
```
public boolean isAutoCorrect()
```
    Automatically performs (uncorrected query) OR (corrected query 1) OR (corrected query 2) ... If cancelBadCorrections and autoCorrect are both true, the query is performed three times:
    - The uncorrected query is performed to calculate the number of hits.
    - The corrected queries are performed to calculate the number of hits.
    - The corrected queries that yield more hits than the uncorrected query are added to the uncorrected query, and the resulting query is performed and returned to the user.
  - withAutoCorrect
```
public SpellCheckerConfig withAutoCorrect(boolean autoCorrect)
```
  - withAutoCorrect
```
public SpellCheckerConfig withAutoCorrect(java.lang.Boolean autoCorrect)
```
  - setGraceDelayMS
```
public void setGraceDelayMS(int graceDelayMS)
```
    Maximum time to wait for spell checking after query processing has finished.
    If the spell check exceeds this time, it is cancelled and a warning displays.
    After this time expires, spellcheck is cancelled.
    If computeCorrectedNHits is enabled, the additional time this takes will leave less time for spell check to finish.
    If 'Automatically correct' is selected, this timeout is ignored.
  - getGraceDelayMS
```
public int getGraceDelayMS()
```
    Maximum time to wait for spell checking after query processing has finished.
    If the spell check exceeds this time, it is cancelled and a warning displays.
    After this time expires, spellcheck is cancelled.
    If computeCorrectedNHits is enabled, the additional time this takes will leave less time for spell check to finish.
    If 'Automatically correct' is selected, this timeout is ignored.
  - withGraceDelayMS
```
public SpellCheckerConfig withGraceDelayMS(int graceDelayMS)
```
  - withGraceDelayMS
```
public SpellCheckerConfig withGraceDelayMS(java.lang.Integer graceDelayMS)
```
  - setQuerySizeLimit
```
public void setQuerySizeLimit(int querySizeLimit)
```
    Queries with more than this count of chunks are considered computer-generated queries for which the spellchecking is disabled.
  - getQuerySizeLimit
```
public int getQuerySizeLimit()
```
    Queries with more than this count of chunks are considered computer-generated queries for which the spellchecking is disabled.
  - withQuerySizeLimit
```
public SpellCheckerConfig withQuerySizeLimit(int querySizeLimit)
```
  - withQuerySizeLimit
```
public SpellCheckerConfig withQuerySizeLimit(java.lang.Integer querySizeLimit)
```
  - setDictionaryName
```
public void setDictionaryName(java.lang.String dictionaryName)
```
    Dictionary used for spell checking and allow/block lists
  - getDictionaryName
```
public java.lang.String getDictionaryName()
```
    Dictionary used for spell checking and allow/block lists
  - withDictionaryName
```
public SpellCheckerConfig withDictionaryName(java.lang.String dictionaryName)
```
  - setSpellCheckParameters
```
public void setSpellCheckParameters(SpellCheckParameters spellCheckParameters)
```
    Low-level parameters.
  - getSpellCheckParameters
```
public SpellCheckParameters getSpellCheckParameters()
```
    Low-level parameters.
  - withSpellCheckParameters
```
public SpellCheckerConfig withSpellCheckParameters(SpellCheckParameters spellCheckParameters)
```
  - makeCopy
```
public SpellCheckerConfig makeCopy()
```
    Creates and returns a deep copy of this SpellCheckerConfig.
  - readFrom
```
public static SpellCheckerConfig readFrom(java.io.InputStream is)
                                   throws javax.xml.bind.JAXBException
```
    Read this SpellCheckerConfig 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 SpellCheckerConfig as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static SpellCheckerConfig fromString(java.lang.String s)
                                     throws javax.xml.bind.JAXBException,
                                            java.io.UnsupportedEncodingException
```
    String representation of this SpellCheckerConfig.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this SpellCheckerConfig.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this SpellCheckerConfig.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class SpellCheckerConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

enabled

DEFAULT_ENABLED

blacklistedPrefixHandlers

DEFAULT_BLACKLISTED_PREFIX_HANDLERS

enabledRefine

DEFAULT_ENABLED_REFINE

computeCorrectedNHits

DEFAULT_COMPUTE_CORRECTED_N_HITS

hitThreshold

DEFAULT_HIT_THRESHOLD

cancelBadCorrections

DEFAULT_CANCEL_BAD_CORRECTIONS

autoCorrect

DEFAULT_AUTO_CORRECT

graceDelayMS

DEFAULT_GRACE_DELAY_M_S

querySizeLimit

DEFAULT_QUERY_SIZE_LIMIT

dictionaryName

spellCheckParameters

Constructor Detail

SpellCheckerConfig

SpellCheckerConfig

Method Detail

setEnabled

isEnabled

withEnabled

withEnabled

setBlacklistedPrefixHandlers

getBlacklistedPrefixHandlers

withBlacklistedPrefixHandlers

setEnabledRefine

isEnabledRefine

withEnabledRefine

withEnabledRefine

setComputeCorrectedNHits

isComputeCorrectedNHits

withComputeCorrectedNHits

withComputeCorrectedNHits

setHitThreshold

getHitThreshold

withHitThreshold

withHitThreshold

setCancelBadCorrections

isCancelBadCorrections

withCancelBadCorrections

withCancelBadCorrections

setAutoCorrect

isAutoCorrect

withAutoCorrect

withAutoCorrect

setGraceDelayMS

getGraceDelayMS

withGraceDelayMS

withGraceDelayMS

setQuerySizeLimit

getQuerySizeLimit

withQuerySizeLimit

withQuerySizeLimit

setDictionaryName

getDictionaryName

withDictionaryName

setSpellCheckParameters

getSpellCheckParameters

withSpellCheckParameters

makeCopy

readFrom

writeTo

fromString

toString

check