com.lucidworks.search.dsl.request

Enum SortElement.Type

java.lang.Object

java.lang.Enum<SortElement.Type>

com.lucidworks.search.dsl.request.SortElement.Type

All Implemented Interfaces:

Serializable, Comparable<SortElement.Type>

Enclosing class:

SortElement

public static enum SortElement.Type
extends Enum<SortElement.Type>

Sort element type

RELEVANCY sorts by relevancy descending. The rest of parameters are ignored.

FIELD sorts by a field specified in SortElement.getValue() in SortElement.getOrder()

EXPRESSION sorts by an expression specified in SortElement.getValue() in SortElement.getOrder()

QUERY sorts by a query specified in SortElement.getQuery() ()} in SortElement.getOrder()

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPRESSION Sorts by an expression specified in SortElement.getValue() in SortElement.getOrder()
FIELD Sorts by a field specified in SortElement.getValue() in SortElement.getOrder()
QUERY Sorts by a query specified in SortElement.getQuery() ()} in SortElement.getOrder()
RELEVANCY Sorts by relevancy descending

Method Summary

Modifier and Type	Method and Description
String	toString()
static SortElement.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static SortElement.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIELD

public static final SortElement.Type FIELD

Sorts by a field specified in SortElement.getValue() in SortElement.getOrder()

EXPRESSION

public static final SortElement.Type EXPRESSION

Sorts by an expression specified in SortElement.getValue() in SortElement.getOrder()

RELEVANCY

public static final SortElement.Type RELEVANCY

Sorts by relevancy descending

QUERY

public static final SortElement.Type QUERY

Sorts by a query specified in SortElement.getQuery() ()} in SortElement.getOrder()

Method Detail

values

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

Returns:

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

valueOf

public static SortElement.Type 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

toString

public String toString()

Overrides:

toString in class Enum<SortElement.Type>