com.textkernel.tx.models.api.matchV2.querying

Enum SynonymExpansionMode

java.lang.Object

java.lang.Enum<SynonymExpansionMode>

com.textkernel.tx.models.api.matchV2.querying.SynonymExpansionMode

All Implemented Interfaces:

Serializable, Comparable<SynonymExpansionMode>

public enum SynonymExpansionMode
extends Enum<SynonymExpansionMode>

Options for synonym expansion in queries

Enum Constant Summary

Enum Constants

Enum Constant and Description
QUERY build the synonym map from the query only, expand the query.
QUERY_AND_QUERYPARTS build synonym map from both query and query parts, expand the query, prune and expand the query parts.
QUERY_AND_SYNONYMMAP build synonym map from both query and query parts, expand the query, only prune the query parts.

Method Summary

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

QUERY

public static final SynonymExpansionMode QUERY

build the synonym map from the query only, expand the query. This is the default option.

QUERY_AND_QUERYPARTS

public static final SynonymExpansionMode QUERY_AND_QUERYPARTS

build synonym map from both query and query parts, expand the query, prune and expand the query parts.

QUERY_AND_SYNONYMMAP

public static final SynonymExpansionMode QUERY_AND_SYNONYMMAP

build synonym map from both query and query parts, expand the query, only prune the query parts.

Method Detail

values

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

Returns:

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

valueOf

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