com.attivio.sdk.search

Enum QueryRequest.StopwordsMode

java.lang.Object

java.lang.Enum<QueryRequest.StopwordsMode>

com.attivio.sdk.search.QueryRequest.StopwordsMode

All Implemented Interfaces:

Serializable, Comparable<QueryRequest.StopwordsMode>

Enclosing class:

QueryRequest

public static enum QueryRequest.StopwordsMode
extends Enum<QueryRequest.StopwordsMode>

Modes for Stopword removal

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCK De prioritize the relevancy value of stopwords in the query
OFF The 'off' mode
REMOVE Remove stopwords from query

Method Summary

Modifier and Type	Method and Description
static QueryRequest.StopwordsMode	fromExternal(String value) Converts an external value to a type value
static QueryRequest.StopwordsMode	fromExternal(String value, QueryRequest.StopwordsMode defaultMode) Converts an external value to a type value using a default on parse failure.
static QueryRequest.StopwordsMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueryRequest.StopwordsMode[]	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

OFF

public static final QueryRequest.StopwordsMode OFF

The 'off' mode

REMOVE

public static final QueryRequest.StopwordsMode REMOVE

Remove stopwords from query

BLOCK

public static final QueryRequest.StopwordsMode BLOCK

De prioritize the relevancy value of stopwords in the query

Method Detail

values

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

Returns:

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

valueOf

public static QueryRequest.StopwordsMode 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

fromExternal

public static QueryRequest.StopwordsMode fromExternal(String value)

Converts an external value to a type value

fromExternal

public static QueryRequest.StopwordsMode fromExternal(String value,
                                                      QueryRequest.StopwordsMode defaultMode)

Converts an external value to a type value using a default on parse failure.