Package org.opensearch.search

Class SearchSortValues

java.lang.Object
org.opensearch.search.SearchSortValues
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
@PublicApi(since="1.0.0") public class SearchSortValues extends Object implements org.opensearch.core.xcontent.ToXContentFragment, org.opensearch.core.common.io.stream.Writeable
Values to sort during search
Opensearch.api:

  • Nested Class Summary

    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
    SearchSortValues(Object[] rawSortValues, DocValueFormat[] sortValueFormats)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    static SearchSortValues
    fromXContent(org.opensearch.core.xcontent.XContentParser parser)
     
    Object[]
    getFormattedSortValues()
    Returns the formatted version of the values that sorting was performed against
    Object[]
    getRawSortValues()
    Returns the raw version of the values that sorting was performed against
    int
    hashCode()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class java.lang.Object

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

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

    isFragment

  • Constructor Details

    • SearchSortValues

      public SearchSortValues(Object[] rawSortValues, DocValueFormat[] sortValueFormats)

  • Method Details

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Throws:
      IOException

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • fromXContent

      public static SearchSortValues fromXContent(org.opensearch.core.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException

    • getFormattedSortValues

      public Object[] getFormattedSortValues()
      Returns the formatted version of the values that sorting was performed against

    • getRawSortValues

      public Object[] getRawSortValues()
      Returns the raw version of the values that sorting was performed against

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object