de.julielab.elastic.query.components.data.aggregation

Class AggregationCommand.OrderCommand

java.lang.Object

de.julielab.elastic.query.components.data.aggregation.AggregationCommand.OrderCommand

Enclosing class:

AggregationCommand

public static class AggregationCommand.OrderCommand
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregationCommand.OrderCommand.Metric
static class	AggregationCommand.OrderCommand.ReferenceType
static class	AggregationCommand.OrderCommand.SortOrder Enumeration constants to determine whether to sort ascending or descending by reference.

Field Summary

Fields

Modifier and Type	Field and Description
AggregationCommand.OrderCommand.Metric	metric Only used for order type AggregationCommand.OrderCommand.ReferenceType.AGGREGATION_MULTIVALUE.
String	referenceName A reference to another aggregation to use its values to sort this aggregation by.
AggregationCommand.OrderCommand.ReferenceType	referenceType The way of ordering.
AggregationCommand.OrderCommand.SortOrder	sortOrder Whether to sort descending or ascending by the value of referenceName.

Constructor Summary

Constructors

Constructor and Description
OrderCommand()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

referenceType

public AggregationCommand.OrderCommand.ReferenceType referenceType

The way of ordering. May just be the count of each term, its name or even another value given by a subaggregation.

See Also:

AggregationCommand.OrderCommand.ReferenceType

referenceName

public String referenceName

A reference to another aggregation to use its values to sort this aggregation by. The reference is identified by this subaggregation's name.

sortOrder

public AggregationCommand.OrderCommand.SortOrder sortOrder

Whether to sort descending or ascending by the value of referenceName.

metric

public AggregationCommand.OrderCommand.Metric metric

Only used for order type AggregationCommand.OrderCommand.ReferenceType.AGGREGATION_MULTIVALUE. This metric is used to receive one single value from a multi-valued aggregation referenced by referenceName.

Constructor Detail

OrderCommand

public OrderCommand()