Class SortValue

All Implemented Interfaces:
Comparable<SortValue>, NamedWriteable, Writeable

public abstract class SortValue extends Object implements NamedWriteable, Comparable<SortValue>
A Comparable, DocValueFormat aware wrapper around a sort value.
  • Method Details

    • from

      public static SortValue from(double d)
      Get a SortValue for a double.
    • from

      public static SortValue from(long l)
      Get a SortValue for a long.
    • from

      public static SortValue from(org.apache.lucene.util.BytesRef bytes)
      Get a SortValue for bytes. Callers should be sure that they have a BytesRef.deepCopyOf(org.apache.lucene.util.BytesRef) of any mutable references.
    • namedWriteables

      public static List<NamedWriteableRegistry.Entry> namedWriteables()
      Get the list of NamedWriteables that this class needs.
    • compareTo

      public final int compareTo(SortValue other)
      Specified by:
      compareTo in interface Comparable<SortValue>
    • toXContent

      public final org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, DocValueFormat format) throws IOException
      Write the key as xcontent.
    • getKey

      public abstract Object getKey()
      The java object representing the sort value.
    • format

      public abstract String format(DocValueFormat format)
      Format this value using the provided format.
    • rawToXContent

      protected abstract org.elasticsearch.common.xcontent.XContentBuilder rawToXContent(org.elasticsearch.common.xcontent.XContentBuilder builder) throws IOException
      Write the key as xcontent using the most native type possible.
    • compareToSameType

      protected abstract int compareToSameType(SortValue obj)
      Compare this sort value to another sort value of the same type.
    • equals

      public abstract boolean equals(Object obj)
      equals in class Object
    • hashCode

      public abstract int hashCode()
      hashCode in class Object
    • toString

      public abstract String toString()
      toString in class Object
    • numberValue

      public abstract Number numberValue()
      Return this SortValue as a boxed Number or Double.NaN if it isn't a number. Or if it is actually Double.NaN.