com.attivio.sdk.client.dictionary

Enum SynonymMode

java.lang.Object

java.lang.Enum<SynonymMode>

com.attivio.sdk.client.dictionary.SynonymMode

All Implemented Interfaces:

Serializable, Comparable<SynonymMode>

public enum SynonymMode
extends Enum<SynonymMode>

Expansion mode for terms in a synonym dictionary.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BIDIRECTIONAL Bi-directional expansion.
DEFAULT Use default expansion mode specified on dictionary.
EXPAND One-way expansion.
REWRITE Term is rewritten to synonym(s)
SUGGEST Outputs are used to generate suggestions.

Method Summary

Modifier and Type	Method and Description
static SynonymMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SynonymMode[]	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

DEFAULT

public static final SynonymMode DEFAULT

Use default expansion mode specified on dictionary.

NOTE: if a SynonymDefinition uses DEFAULT, and the SynonymDictionaryInfo also specified DEFAULT, then EXPAND will be used.

EXPAND

public static final SynonymMode EXPAND

One-way expansion.

BIDIRECTIONAL

public static final SynonymMode BIDIRECTIONAL

Bi-directional expansion.

REWRITE

public static final SynonymMode REWRITE

Term is rewritten to synonym(s)

SUGGEST

public static final SynonymMode SUGGEST

Outputs are used to generate suggestions.

Method Detail

values

public static SynonymMode[] 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 (SynonymMode c : SynonymMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static SynonymMode 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