com.attivio.sdk.client.dictionary

Class SpellDictionaryInfo

java.lang.Object

com.attivio.sdk.client.dictionary.DictionaryInfo

com.attivio.sdk.client.dictionary.DerivedDictionaryInfo

com.attivio.sdk.client.dictionary.SpellDictionaryInfo

All Implemented Interfaces:

Cloneable

public class SpellDictionaryInfo
extends DerivedDictionaryInfo

Dictionary type used for spellcheck dictionaries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpellDictionaryInfo.SpellDictionaryMode

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_TERM_LENGTH
static int	DEFAULT_MIN_TERM_FREQUENCY
static int	DEFAULT_MIN_TERM_LENGTH
static SpellDictionaryInfo.SpellDictionaryMode	DEFAULT_MODE

Constructor Summary

Constructors

Constructor and Description
SpellDictionaryInfo()
SpellDictionaryInfo(String name)

Method Summary

Modifier and Type	Method and Description
protected void	addParameters(StringBuilder buffer) Add any parameters to string representation.
SpellDictionaryInfo	clone()
boolean	equals(Object other)
int	getMaxTermLength() Get maximum term length for terms extracted from the index.
int	getMinTermFrequency() Get the minimum term frequency for terms extracted from the index.
int	getMinTermLength() Get minimum term length for terms extracted from the index.
SpellDictionaryInfo.SpellDictionaryMode	getMode() Get the mode used to extract a spellcheck dictionary from the index.
int	hashCode()
boolean	isAllowNumericTerms() Get if numeric terms will be extracted from the index.
void	setAllowNumericTerms(boolean value) Set if numeric terms will be extracted from the index.
void	setMaxTermLength(int value) Get maximum term length for terms extracted from the index.
void	setMinTermFrequency(int value) Get the minimum term frequency for terms extracted from the index.
void	setMinTermLength(int value) Set minimum term length for terms extracted from the index.
void	setMode(SpellDictionaryInfo.SpellDictionaryMode value) Set the mode used to extract a spellcheck dictionary from the index.

Methods inherited from class com.attivio.sdk.client.dictionary.DerivedDictionaryInfo

getDefaultLocale, getDerivedFields, getLanguageField, getQuery, setDefaultLocale, setDerivedFields, setLanguageField, setQuery

Methods inherited from class com.attivio.sdk.client.dictionary.DictionaryInfo

getName, isCaseSensitive, isCompiled, isPublished, isPunctuationSensitive, setCaseSensitive, setCompiled, setName, setPublished, setPunctuationSensitive, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_MODE

public static final SpellDictionaryInfo.SpellDictionaryMode DEFAULT_MODE

DEFAULT_MAX_TERM_LENGTH

public static final int DEFAULT_MAX_TERM_LENGTH

See Also:

Constant Field Values

DEFAULT_MIN_TERM_LENGTH

public static final int DEFAULT_MIN_TERM_LENGTH

See Also:

Constant Field Values

DEFAULT_MIN_TERM_FREQUENCY

public static final int DEFAULT_MIN_TERM_FREQUENCY

See Also:

Constant Field Values

Constructor Detail

SpellDictionaryInfo

public SpellDictionaryInfo()

SpellDictionaryInfo

public SpellDictionaryInfo(String name)

Method Detail

getMode

public SpellDictionaryInfo.SpellDictionaryMode getMode()

Get the mode used to extract a spellcheck dictionary from the index.

setMode

public void setMode(SpellDictionaryInfo.SpellDictionaryMode value)

Set the mode used to extract a spellcheck dictionary from the index.

getMinTermLength

public int getMinTermLength()

Get minimum term length for terms extracted from the index.

Terms that are shorter than this length will be ignored.

Only used for SpellDictionaryInfo.SpellDictionaryMode.DERIVED dictionaries.

setMinTermLength

public void setMinTermLength(int value)

Set minimum term length for terms extracted from the index.

getMaxTermLength

public int getMaxTermLength()

Get maximum term length for terms extracted from the index.

Terms that are longer than this length will be ignored.

Only used for SpellDictionaryInfo.SpellDictionaryMode.DERIVED dictionaries.

setMaxTermLength

public void setMaxTermLength(int value)

Get maximum term length for terms extracted from the index.

isAllowNumericTerms

public boolean isAllowNumericTerms()

Get if numeric terms will be extracted from the index.

If false terms with numbers in them will be ignored.

Only used for SpellDictionaryInfo.SpellDictionaryMode.DERIVED dictionaries.

setAllowNumericTerms

public void setAllowNumericTerms(boolean value)

Set if numeric terms will be extracted from the index.

getMinTermFrequency

public int getMinTermFrequency()

Get the minimum term frequency for terms extracted from the index.

Terms with a term frequency less than this value will be ignored.

Only used for SpellDictionaryInfo.SpellDictionaryMode.DERIVED dictionaries.

setMinTermFrequency

public void setMinTermFrequency(int value)

Get the minimum term frequency for terms extracted from the index.

addParameters

protected void addParameters(StringBuilder buffer)

Description copied from class: DictionaryInfo

Add any parameters to string representation.

Overrides:

addParameters in class DerivedDictionaryInfo

hashCode

public int hashCode()

Overrides:

hashCode in class DerivedDictionaryInfo

equals

public boolean equals(Object other)

Overrides:

equals in class DerivedDictionaryInfo

clone

public SpellDictionaryInfo clone()

Overrides:

clone in class DerivedDictionaryInfo