Package org.elasticsearch.search

Class SearchHit

org.elasticsearch.search.SearchHit
All Implemented Interfaces:
<DocumentField>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public final class SearchHit extends implements <DocumentField>
A single search hit.
See Also:
SearchHits

  • Field Details

    • unknownMetaFieldConsumer

      public static final org.elasticsearch.common.xcontent.ObjectParser.UnknownFieldConsumer<<,​>> unknownMetaFieldConsumer

  • Constructor Details

  • Method Details

    • writeTo

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

    • docId

      public int docId()

    • score

      public void score​(float score)

    • getScore

      public float getScore()
      The score.

    • version

      public void version​(long version)

    • getVersion

      public long getVersion()
      The version of the hit.

    • setSeqNo

      public void setSeqNo​(long seqNo)

    • setPrimaryTerm

      public void setPrimaryTerm​(long primaryTerm)

    • getSeqNo

      public long getSeqNo()
      returns the sequence number of the last modification to the document, or SequenceNumbers.UNASSIGNED_SEQ_NO if not requested.

    • getPrimaryTerm

      public long getPrimaryTerm()
      returns the primary term of the last modification to the document, or SequenceNumbers.UNASSIGNED_PRIMARY_TERM if not requested.

    • getIndex

      public  getIndex()
      The index of the hit.

    • getId

      public  getId()
      The id of the document.

    • getType

      public  getType()
      Deprecated.
      Types are in the process of being removed. Instead of using a type, prefer to filter on a field on the document.
      The type of the document.

    • getNestedIdentity

      public SearchHit.NestedIdentity getNestedIdentity()
      If this is a nested hit then nested reference information is returned otherwise null is returned.

    • getSourceRef

      public BytesReference getSourceRef()
      Returns bytes reference, also uncompress the source if needed.

    • sourceRef

      public SearchHit sourceRef​(BytesReference source)
      Sets representation, might be compressed....

    • hasSource

      public boolean hasSource()
      Is the source available or not. A source with no fields will return true. This will return false if fields doesn't contain _source or if source is disabled in the mapping.

    • getSourceAsString

      public  getSourceAsString()
      The source of the document as string (can be null).

    • getSourceAsMap

      public <,​> getSourceAsMap()
      The source of the document as a map (can be null).

    • iterator

      public <DocumentField> iterator()
      Specified by:
       in interface <DocumentField>

    • field

      public  fieldName)
      The hit field matching the given field name.

    • setDocumentField

      public void setDocumentField​( fieldName, DocumentField field)

    • getFields

      public <,​DocumentField> getFields()
      A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.

    • getHighlightFields

      public <,​HighlightField> getHighlightFields()
      A map of highlighted fields.

    • highlightFields

      public void highlightFields​(<,​HighlightField> highlightFields)

    • sortValues

      public void sortValues​([] sortValues, DocValueFormat[] sortValueFormats)

    • sortValues

      public void sortValues​(SearchSortValues sortValues)

    • getSortValues

      public [] getSortValues()
      An array of the (formatted) sort values used.

    • getRawSortValues

      public [] getRawSortValues()
      An array of the (raw) sort values used.

    • getExplanation

      public org.apache.lucene.search.Explanation getExplanation()
      If enabled, the explanation of the search hit.

    • explanation

      public void explanation​(org.apache.lucene.search.Explanation explanation)

    • getShard

      public SearchShardTarget getShard()
      The shard of the search hit.

    • shard

      public void shard​(SearchShardTarget target)

    • getClusterAlias

      public  getClusterAlias()
      Returns the cluster alias this hit comes from or null if it comes from a local cluster

    • matchedQueries

      public void matchedQueries​([] matchedQueries)

    • getMatchedQueries

      public [] getMatchedQueries()
      The set of query and filter names the query matched with. Mainly makes sense for compound filters and queries.

    • getInnerHits

      public <,​SearchHits> getInnerHits()
      Returns:
      Inner hits or null if there are none

    • setInnerHits

      public void setInnerHits​(<,​SearchHits> innerHits)

    • toXContent

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

    • toInnerXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toInnerXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws
      Throws:

    • fromXContent

      public static SearchHit fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)

    • declareInnerHitsParseFields

      public static void declareInnerHitsParseFields​(org.elasticsearch.common.xcontent.ObjectParser<<,​>,​> parser)

    • createFromMap

      public static <,​> values)

    • equals

      public boolean equals​( obj)
      Overrides:
       in class 

    • hashCode

      public int hashCode()
      Overrides:
       in class 

    • toString

      public  toString()
      Overrides:
       in class