org.elasticsearch.search.aggregations.bucket.histogram

Class Histogram.Order

java.lang.Object

org.elasticsearch.search.aggregations.bucket.histogram.Histogram.Order

All Implemented Interfaces:

ToXContent

Enclosing interface:

Histogram

public abstract static class Histogram.Order
extends Object
implements ToXContent

A strategy defining the order in which the buckets in this histogram are ordered.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static Histogram.Order	COUNT_ASC
static Histogram.Order	COUNT_DESC
static Histogram.Order	KEY_ASC
static Histogram.Order	KEY_DESC

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Histogram.Order()

Method Summary

Methods

Modifier and Type	Method and Description
static Histogram.Order	aggregation(String path, boolean asc) Creates a bucket ordering strategy that sorts buckets based on a single-valued calc sug-aggregation
static Histogram.Order	aggregation(String aggregationName, String valueName, boolean asc) Creates a bucket ordering strategy that sorts buckets based on a multi-valued calc sug-aggregation

Methods inherited from class java.lang.Object

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

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

toXContent

Field Detail

KEY_ASC

public static final Histogram.Order KEY_ASC

KEY_DESC

public static final Histogram.Order KEY_DESC

COUNT_ASC

public static final Histogram.Order COUNT_ASC

COUNT_DESC

public static final Histogram.Order COUNT_DESC

Constructor Detail

Histogram.Order

public Histogram.Order()

Method Detail

aggregation

public static Histogram.Order aggregation(String path,
                          boolean asc)

Creates a bucket ordering strategy that sorts buckets based on a single-valued calc sug-aggregation

Parameters:

path - the name of the aggregation

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

aggregation

public static Histogram.Order aggregation(String aggregationName,
                          String valueName,
                          boolean asc)

Creates a bucket ordering strategy that sorts buckets based on a multi-valued calc sug-aggregation

Parameters:

aggregationName - the name of the aggregation

valueName - 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)