com.attivio.sdk.search.facet

Enum FacetRequest.SortBy

java.lang.Object

java.lang.Enum<FacetRequest.SortBy>

com.attivio.sdk.search.facet.FacetRequest.SortBy

All Implemented Interfaces:

Serializable, Comparable<FacetRequest.SortBy>

Enclosing class:

FacetRequest

public static enum FacetRequest.SortBy
extends Enum<FacetRequest.SortBy>

Enumeration listing types of sorts for a facet request

Enum Constant Summary

Enum Constants

Enum Constant and Description
COUNT Indicates sorting a facet by count
VALUE Indicates sorting a facet by value

Method Summary

Modifier and Type	Method and Description
static FacetRequest.SortBy	fromExternal(String value) Parse a string value into a SortBy.
static FacetRequest.SortBy	valueOf(String name) Returns the enum constant of this type with the specified name.
static FacetRequest.SortBy[]	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

COUNT

public static final FacetRequest.SortBy COUNT

Indicates sorting a facet by count

VALUE

public static final FacetRequest.SortBy VALUE

Indicates sorting a facet by value

Method Detail

values

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

Returns:

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

valueOf

public static FacetRequest.SortBy 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 FacetRequest.SortBy fromExternal(String value)

Parse a string value into a SortBy.