org.elasticsearch.search.aggregations.bucket.terms

Class Terms.Order

java.lang.Object

org.elasticsearch.search.aggregations.bucket.terms.Terms.Order

All Implemented Interfaces:

ToXContent

Enclosing interface:

Terms

public abstract static class Terms.Order
extends java.lang.Object
implements ToXContent

Determines the order by which the term buckets will be sorted

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Order()

Method Summary

Modifier and Type	Method and Description
static Terms.Order	aggregation(java.lang.String path, boolean asc) Creates a bucket ordering strategy which sorts buckets based on a single-valued calc get
static Terms.Order	aggregation(java.lang.String aggregationName, java.lang.String metricName, boolean asc) Creates a bucket ordering strategy which sorts buckets based on a multi-valued calc get
protected abstract java.util.Comparator<Terms.Bucket>	comparator(Aggregator aggregator)
static Terms.Order	compound(java.util.List<Terms.Order> orders) Creates a bucket ordering strategy which sorts buckets based multiple criteria
static Terms.Order	compound(Terms.Order... orders) Creates a bucket ordering strategy which sorts buckets based multiple criteria
static Terms.Order	count(boolean asc)
abstract boolean	equals(java.lang.Object obj)
abstract int	hashCode()
static Terms.Order	term(boolean asc)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

isFragment, toXContent

Constructor Detail

Order

public Order()

Method Detail

count

public static Terms.Order count(boolean asc)

Returns:

a bucket ordering strategy that sorts buckets by their document counts (ascending or descending)

term

public static Terms.Order term(boolean asc)

Returns:

a bucket ordering strategy that sorts buckets by their terms (ascending or descending)

aggregation

public static Terms.Order aggregation(java.lang.String path,
                                      boolean asc)

Creates a bucket ordering strategy which sorts buckets based on a single-valued calc get

Parameters:

path - the name of the get

asc - The direction of the order (ascending or descending)

aggregation

public static Terms.Order aggregation(java.lang.String aggregationName,
                                      java.lang.String metricName,
                                      boolean asc)

Creates a bucket ordering strategy which sorts buckets based on a multi-valued calc get

Parameters:

aggregationName - the name of the get

metricName - The name of the value of the multi-value get by which the sorting will be applied

asc - The direction of the order (ascending or descending)

compound

public static Terms.Order compound(java.util.List<Terms.Order> orders)

Creates a bucket ordering strategy which sorts buckets based multiple criteria

Parameters:

orders - a list of Terms.Order objects to sort on, in order of priority

compound

public static Terms.Order compound(Terms.Order... orders)

Creates a bucket ordering strategy which sorts buckets based multiple criteria

Parameters:

orders - a list of Terms.Order parameters to sort on, in order of priority

comparator

protected abstract java.util.Comparator<Terms.Bucket> comparator(Aggregator aggregator)

Returns:

A comparator for the bucket based on the given terms aggregator. The comparator is used in two phases: - aggregation phase, where each shard builds a list of term buckets to be sent to the coordinating node. In this phase, the passed in aggregator will be the terms aggregator that aggregates the buckets on the shard level. - reduce phase, where the coordinating node gathers all the buckets from all the shards and reduces them to a final bucket list. In this case, the passed in aggregator will be null

hashCode

public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public abstract boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object