org.elasticsearch.search.facet.termsstats
Enum TermsStatsFacet.ComparatorType

java.lang.Object
  java.lang.Enum<TermsStatsFacet.ComparatorType>
      org.elasticsearch.search.facet.termsstats.TermsStatsFacet.ComparatorType

All Implemented Interfaces:

Serializable, Comparable<TermsStatsFacet.ComparatorType>

Enclosing interface:

TermsStatsFacet

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

Controls how the terms facets are ordered.

Enum Constant Summary

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

MAX
Order by the (higher) max of each term.

MEAN
Order by the (higher) mean of each term.

MIN
Order by the (lower) min of each term.

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

REVERSE_MAX
Order by the (lower) max of each term.

REVERSE_MEAN
Order by the (lower) mean of each term.

REVERSE_MIN
Order by the (higher) min of each term.

REVERSE_TERM
Order by the terms.

REVERSE_TOTAL
Order by the (lower) total of each term.

TERM
Order by the terms.

TOTAL
Order by the (higher) total of each term.

Method Summary

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

Order by the (higher) count of each term.

REVERSE_COUNT

public static final TermsStatsFacet.ComparatorType REVERSE_COUNT

Order by the (lower) count of each term.

TERM

public static final TermsStatsFacet.ComparatorType TERM

Order by the terms.

REVERSE_TERM

public static final TermsStatsFacet.ComparatorType REVERSE_TERM

Order by the terms.

TOTAL

public static final TermsStatsFacet.ComparatorType TOTAL

Order by the (higher) total of each term.

REVERSE_TOTAL

public static final TermsStatsFacet.ComparatorType REVERSE_TOTAL

Order by the (lower) total of each term.

MIN

public static final TermsStatsFacet.ComparatorType MIN

Order by the (lower) min of each term.

REVERSE_MIN

public static final TermsStatsFacet.ComparatorType REVERSE_MIN

Order by the (higher) min of each term.

MAX

public static final TermsStatsFacet.ComparatorType MAX

Order by the (higher) max of each term.

REVERSE_MAX

public static final TermsStatsFacet.ComparatorType REVERSE_MAX

Order by the (lower) max of each term.

MEAN

public static final TermsStatsFacet.ComparatorType MEAN

Order by the (higher) mean of each term.

REVERSE_MEAN

public static final TermsStatsFacet.ComparatorType REVERSE_MEAN

Order by the (lower) mean of each term.

Method Detail

values

public static TermsStatsFacet.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 (TermsStatsFacet.ComparatorType c : TermsStatsFacet.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 TermsStatsFacet.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<TermsStatsFacet.Entry> comparator()

fromId

public static TermsStatsFacet.ComparatorType fromId(byte id)

fromString

public static TermsStatsFacet.ComparatorType fromString(String type)