org.elasticsearch.search.facet.terms
Enum TermsFacet.ComparatorType

java.lang.Object
  java.lang.Enum<TermsFacet.ComparatorType>
      org.elasticsearch.search.facet.terms.TermsFacet.ComparatorType

All Implemented Interfaces:

Serializable, Comparable<TermsFacet.ComparatorType>

Enclosing interface:

TermsFacet

public static enum TermsFacet.ComparatorType
extends Enum<TermsFacet.ComparatorType>

Controls how the terms facets are ordered.

Enum Constant Summary

COUNT
Order by the (higher) count of each term.

REVERSE_COUNT
Order by the (lower) count of each term.

REVERSE_TERM
Order by the terms.

TERM
Order by the terms.

Method Summary

Comparator<TermsFacet.Entry>	comparator()
static TermsFacet.ComparatorType	fromId(byte id)
static TermsFacet.ComparatorType	fromString(String type)
byte	id()
static TermsFacet.ComparatorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TermsFacet.ComparatorType[]	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 TermsFacet.ComparatorType COUNT

Order by the (higher) count of each term.

REVERSE_COUNT

public static final TermsFacet.ComparatorType REVERSE_COUNT

Order by the (lower) count of each term.

TERM

public static final TermsFacet.ComparatorType TERM

Order by the terms.

REVERSE_TERM

public static final TermsFacet.ComparatorType REVERSE_TERM

Order by the terms.

Method Detail

values

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

Returns:

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

valueOf

public static TermsFacet.ComparatorType 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

id

public byte id()

comparator

public Comparator<TermsFacet.Entry> comparator()

fromId

public static TermsFacet.ComparatorType fromId(byte id)

fromString

public static TermsFacet.ComparatorType fromString(String type)