Package org.opensearch.search.aggregations

Class InternalOrder

java.lang.Object
org.opensearch.search.aggregations.BucketOrder
org.opensearch.search.aggregations.InternalOrder
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
Direct Known Subclasses:
InternalOrder.Aggregation
public abstract class InternalOrder extends BucketOrder
Implementations for MultiBucketsAggregation.Bucket ordering strategies.
Opensearch.internal:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    InternalOrder.Aggregation
    MultiBucketsAggregation.Bucket ordering strategy to sort by a sub-aggregation.
    static class 
    InternalOrder.CompoundOrder
    MultiBucketsAggregation.Bucket ordering strategy to sort by multiple criteria.
    static class 
    InternalOrder.Parser
    Contains logic for parsing a BucketOrder from a XContentParser.
    static class 
    InternalOrder.Streams
    Contains logic for reading/writing BucketOrder from/to streams.

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    InternalOrder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    isCountDesc(BucketOrder order)
    Determine if the ordering strategy is sorting on bucket count descending.
    static boolean
    isKeyAsc(BucketOrder order)
    Determine if the ordering strategy is sorting on bucket key ascending.
    static boolean
    isKeyDesc(BucketOrder order)
    Determine if the ordering strategy is sorting on bucket key descending.
    static boolean
    isKeyOrder(BucketOrder order)
    Determine if the ordering strategy is sorting on bucket key (ascending or descending).

    Methods inherited from class org.opensearch.search.aggregations.BucketOrder

    aggregation, aggregation, comparator, compound, compound, count, equals, hashCode, key, partiallyBuiltBucketComparator, toString, validate, writeTo

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.core.xcontent.ToXContent

    toXContent

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

    isFragment

  • Constructor Details

    • InternalOrder

      public InternalOrder()

  • Method Details

    • isCountDesc

      public static boolean isCountDesc(BucketOrder order)
      Determine if the ordering strategy is sorting on bucket count descending.
      Parameters:
      order - bucket ordering strategy to check.
      Returns:
      true if the ordering strategy is sorting on bucket count descending, false otherwise.

    • isKeyOrder

      public static boolean isKeyOrder(BucketOrder order)
      Determine if the ordering strategy is sorting on bucket key (ascending or descending).
      Parameters:
      order - bucket ordering strategy to check.
      Returns:
      true if the ordering strategy is sorting on bucket key, false otherwise.

    • isKeyAsc

      public static boolean isKeyAsc(BucketOrder order)
      Determine if the ordering strategy is sorting on bucket key ascending.
      Parameters:
      order - bucket ordering strategy to check.
      Returns:
      true if the ordering strategy is sorting on bucket key ascending, false otherwise.

    • isKeyDesc

      public static boolean isKeyDesc(BucketOrder order)
      Determine if the ordering strategy is sorting on bucket key descending.
      Parameters:
      order - bucket ordering strategy to check.
      Returns:
      true if the ordering strategy is sorting on bucket key descending, false otherwise.