com.attivio.sdk.search

Enum QueryRequest.FacetFinderMode

java.lang.Object

java.lang.Enum<QueryRequest.FacetFinderMode>

com.attivio.sdk.search.QueryRequest.FacetFinderMode

All Implemented Interfaces:

Serializable, Comparable<QueryRequest.FacetFinderMode>

Enclosing class:

QueryRequest

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

Modes for FacetFinder.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OFF 'OFF' mode (disabled)
RESULTS The 'results' mode: recommendations are based on the result set.

Method Summary

Modifier and Type	Method and Description
static QueryRequest.FacetFinderMode	fromExternal(String value) Converts an external value to a type value
static QueryRequest.FacetFinderMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueryRequest.FacetFinderMode[]	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.FacetFinderMode OFF

'OFF' mode (disabled)

RESULTS

public static final QueryRequest.FacetFinderMode RESULTS

The 'results' mode: recommendations are based on the result set.

Method Detail

values

public static QueryRequest.FacetFinderMode[] 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.FacetFinderMode c : QueryRequest.FacetFinderMode.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.FacetFinderMode 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.FacetFinderMode fromExternal(String value)

Converts an external value to a type value

Parameters:

value - the external value

Returns:

the type