com.attivio.sdk.dictionary

Enum DictionaryMode

java.lang.Object

java.lang.Enum<DictionaryMode>

com.attivio.sdk.dictionary.DictionaryMode

All Implemented Interfaces:

Serializable, Comparable<DictionaryMode>

public enum DictionaryMode
extends Enum<DictionaryMode>

The mode used for dictionary compilation.

NOTE: currently, this only applies to spellcheck and entity dictionaries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM Configured dictionary entries are used.
DERIVED Dictionary terms are derived from the index.

Method Summary

Modifier and Type	Method and Description
static DictionaryMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DictionaryMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CUSTOM

public static final DictionaryMode CUSTOM

Configured dictionary entries are used.

In the case of spellcheck dictionaries, the configured terms are used for spellcheck terms, with frequencies extracted from the index during dictionary publication.

DERIVED

public static final DictionaryMode DERIVED

Dictionary terms are derived from the index.

In the case of spellcheck dictionaries, any configured terms are used as a blacklist, filtering out undesirable terms.

Method Detail

values

public static DictionaryMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DictionaryMode c : DictionaryMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DictionaryMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null