com.groupdocs.search.options

Class SpellingCorrectorOptions

java.lang.Object

com.groupdocs.search.options.SpellingCorrectorOptions

public abstract class SpellingCorrectorOptions
extends Object

Provides options for the spelling corrector.

Learn more

• Spell checking
• Search options

Constructor Summary

Constructors

Constructor and Description
SpellingCorrectorOptions()

Method Summary

Modifier and Type	Method and Description
abstract boolean	getConsiderTranspositions() Gets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake.
abstract boolean	getEnabled() Gets a value indicating whether the spelling corrector is enabled.
abstract int	getMaxMistakeCount() Gets the maximum number of mistakes.
abstract boolean	getOnlyBestResults() Gets a value indicating whether only the best results will be returned.
abstract byte	getOnlyBestResultsRange() Gets the maximum exceeding of the minimum number of mistakes that are found.
abstract void	setConsiderTranspositions(boolean value) Sets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake.
abstract void	setEnabled(boolean value) Sets a value indicating whether the spelling corrector is enabled.
abstract void	setMaxMistakeCount(int value) Sets the maximum number of mistakes.
abstract void	setOnlyBestResults(boolean value) Sets a value indicating whether only the best results will be returned.
abstract void	setOnlyBestResultsRange(byte value) Sets the maximum exceeding of the minimum number of mistakes that are found.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpellingCorrectorOptions

public SpellingCorrectorOptions()

Method Detail

getConsiderTranspositions

public abstract boolean getConsiderTranspositions()

Gets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake. The default value is true.

Returns:

true if the spelling corrector algorithm considers transpositions; otherwise false.

getEnabled

public abstract boolean getEnabled()

Gets a value indicating whether the spelling corrector is enabled. The default value is false.

Returns:

A value indicating whether the spelling corrector is enabled.

getMaxMistakeCount

public abstract int getMaxMistakeCount()

Gets the maximum number of mistakes. The default value is 2.

Returns:

The maximum number of mistakes.

getOnlyBestResults

public abstract boolean getOnlyBestResults()

Gets a value indicating whether only the best results will be returned. The default value is false.

Returns:

true if only the best results will be returned; otherwise false.

getOnlyBestResultsRange

public abstract byte getOnlyBestResultsRange()

Gets the maximum exceeding of the minimum number of mistakes that are found. The default value is 0.

Returns:

The maximum exceeding of the minimum number of mistakes found.

setConsiderTranspositions

public abstract void setConsiderTranspositions(boolean value)

Sets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake. The default value is true.

Parameters:

value - true if the spelling corrector algorithm considers transpositions; otherwise false.

setEnabled

public abstract void setEnabled(boolean value)

Sets a value indicating whether the spelling corrector is enabled. The default value is false.

Parameters:

value - A value indicating whether the spelling corrector is enabled.

setMaxMistakeCount

public abstract void setMaxMistakeCount(int value)

Sets the maximum number of mistakes. The default value is 2.

Parameters:

value - The maximum number of mistakes.

setOnlyBestResults

public abstract void setOnlyBestResults(boolean value)

Sets a value indicating whether only the best results will be returned. The default value is false.

Parameters:

value - true if only the best results will be returned; otherwise false.

setOnlyBestResultsRange

public abstract void setOnlyBestResultsRange(byte value)

Sets the maximum exceeding of the minimum number of mistakes that are found. The default value is 0.

Parameters:

value - The maximum exceeding of the minimum number of mistakes found.