Enum SortElement.Type
- java.lang.Object
-
- java.lang.Enum<SortElement.Type>
-
- com.lucidworks.search.dsl.request.SortElement.Type
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<SortElement.Type>
- Enclosing class:
- SortElement
public static enum SortElement.Type extends java.lang.Enum<SortElement.Type>
Sort element typeRELEVANCY
sorts by relevancy descending. The rest of parameters are ignored.FIELD
sorts by a field specified inSortElement.getValue()
inSortElement.getOrder()
EXPRESSION
sorts by an expression specified inSortElement.getValue()
inSortElement.getOrder()
QUERY
sorts by a query specified inSortElement.getQuery()
()} inSortElement.getOrder()
-
-
Enum Constant Summary
Enum Constants Enum Constant Description EXPRESSION
Sorts by an expression specified inSortElement.getValue()
inSortElement.getOrder()
FIELD
Sorts by a field specified inSortElement.getValue()
inSortElement.getOrder()
QUERY
Sorts by a query specified inSortElement.getQuery()
()} inSortElement.getOrder()
RELEVANCY
Sorts by relevancy descending
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toString()
static SortElement.Type
valueOf(java.lang.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.
-
-
-
Enum Constant Detail
-
FIELD
public static final SortElement.Type FIELD
Sorts by a field specified inSortElement.getValue()
inSortElement.getOrder()
-
EXPRESSION
public static final SortElement.Type EXPRESSION
Sorts by an expression specified inSortElement.getValue()
inSortElement.getOrder()
-
RELEVANCY
public static final SortElement.Type RELEVANCY
Sorts by relevancy descending
-
QUERY
public static final SortElement.Type QUERY
Sorts by a query specified inSortElement.getQuery()
()} inSortElement.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(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<SortElement.Type>
-
-