Package org.elasticsearch.search

Class SearchHits

java.lang.Object
org.elasticsearch.search.SearchHits
All Implemented Interfaces:
java.lang.Iterable<SearchHit>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public final class SearchHits
extends java.lang.Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment, java.lang.Iterable<SearchHit>

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  SearchHits.Fields  

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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

    Writeable.Reader<V>, Writeable.Writer<V>

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static SearchHit[] EMPTY  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    SearchHits​(StreamInput in)  
    SearchHits​(SearchHit[] hits, org.apache.lucene.search.TotalHits totalHits, float maxScore)  
    SearchHits​(SearchHit[] hits, org.apache.lucene.search.TotalHits totalHits, float maxScore, org.apache.lucene.search.SortField[] sortFields, java.lang.String collapseField, java.lang.Object[] collapseValues)  

  • Method Summary

    Modifier and Type Method Description
    static SearchHits empty()  
    static SearchHits empty​(boolean withTotalHits)  
    boolean equals​(java.lang.Object obj)  
    static SearchHits fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    SearchHit getAt​(int position)
    Return the hit as the provided position.
    java.lang.String getCollapseField()
    In case field collapsing was performed, returns the field used for field collapsing, null otherwise
    java.lang.Object[] getCollapseValues()
    In case field collapsing was performed, returns the values of the field that field collapsing was performed on, null otherwise
    SearchHit[] getHits()
    The hits of the search request (based on the search type, and from / size provided).
    float getMaxScore()
    The maximum score of this query.
    org.apache.lucene.search.SortField[] getSortFields()
    In case documents were sorted by field(s), returns information about such field(s), null otherwise
    org.apache.lucene.search.TotalHits getTotalHits()
    The total number of hits for the query or null if the tracking of total hits is disabled in the request.
    int hashCode()  
    java.util.Iterator<SearchHit> iterator()  
    static org.apache.lucene.search.TotalHits parseTotalHitsFragment​(org.elasticsearch.common.xcontent.XContentParser parser)  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

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

    isFragment

  • Field Details

  • Constructor Details

    • SearchHits

      public SearchHits​(SearchHit[] hits, @Nullable org.apache.lucene.search.TotalHits totalHits, float maxScore)

    • SearchHits

      public SearchHits​(SearchHit[] hits, @Nullable org.apache.lucene.search.TotalHits totalHits, float maxScore, @Nullable org.apache.lucene.search.SortField[] sortFields, @Nullable java.lang.String collapseField, @Nullable java.lang.Object[] collapseValues)

    • SearchHits

      public SearchHits​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • empty

      public static SearchHits empty()

    • empty

      public static SearchHits empty​(boolean withTotalHits)

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • getTotalHits

      @Nullable public org.apache.lucene.search.TotalHits getTotalHits()
      The total number of hits for the query or null if the tracking of total hits is disabled in the request.

    • getMaxScore

      public float getMaxScore()
      The maximum score of this query.

    • getHits

      public SearchHit[] getHits()
      The hits of the search request (based on the search type, and from / size provided).

    • getAt

      public SearchHit getAt​(int position)
      Return the hit as the provided position.

    • getSortFields

      @Nullable public org.apache.lucene.search.SortField[] getSortFields()
      In case documents were sorted by field(s), returns information about such field(s), null otherwise
      See Also:
      SortField

    • getCollapseField

      @Nullable public java.lang.String getCollapseField()
      In case field collapsing was performed, returns the field used for field collapsing, null otherwise

    • getCollapseValues

      @Nullable public java.lang.Object[] getCollapseValues()
      In case field collapsing was performed, returns the values of the field that field collapsing was performed on, null otherwise

    • iterator

      public java.util.Iterator<SearchHit> iterator()
      Specified by:
      iterator in interface java.lang.Iterable<SearchHit>

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • fromXContent

      public static SearchHits fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • parseTotalHitsFragment

      public static org.apache.lucene.search.TotalHits parseTotalHitsFragment​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException