org.elasticsearch.search.facet
Enum Facet.Type

java.lang.Object
  java.lang.Enum<Facet.Type>
      org.elasticsearch.search.facet.Facet.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Facet.Type>

Enclosing interface:

Facet

public static enum Facet.Type
extends java.lang.Enum<Facet.Type>

The type of the facet.

Enum Constant Summary

FILTER
Filter facet type, matching FilterFacet.

GEO_DISTANCE
Geo Distance facet type, matching GeoDistanceFacet.

HISTOGRAM
Histogram facet type, matching HistogramFacet.

QUERY
Query facet type, matching QueryFacet.

RANGE
Geo Distance facet type, matching RangeFacet.

STATISTICAL
Statistical facet type, matching StatisticalFacet.

TERMS
Terms facet type, matching TermsFacet.

Method Summary

static Facet.Type	fromId(int id)
java.lang.Class<? extends Facet>	getType() The facet class type.
int	id()
java.lang.Class<? extends Facet>	type() The facet class type.
static Facet.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Facet.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

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

TERMS

public static final Facet.Type TERMS

Terms facet type, matching TermsFacet.

QUERY

public static final Facet.Type QUERY

Query facet type, matching QueryFacet.

STATISTICAL

public static final Facet.Type STATISTICAL

Statistical facet type, matching StatisticalFacet.

HISTOGRAM

public static final Facet.Type HISTOGRAM

Histogram facet type, matching HistogramFacet.

GEO_DISTANCE

public static final Facet.Type GEO_DISTANCE

Geo Distance facet type, matching GeoDistanceFacet.

RANGE

public static final Facet.Type RANGE

Geo Distance facet type, matching RangeFacet.

FILTER

public static final Facet.Type FILTER

Filter facet type, matching FilterFacet.

Method Detail

values

public static Facet.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 (Facet.Type c : Facet.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 Facet.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 name

java.lang.NullPointerException - if the argument is null

id

public int id()

type

public java.lang.Class<? extends Facet> type()

The facet class type.

getType

public java.lang.Class<? extends Facet> getType()

The facet class type.

fromId

public static Facet.Type fromId(int id)