Package org.elasticsearch.search

Class SearchHit

java.lang.Object

org.elasticsearch.search.SearchHit

All Implemented Interfaces:

java.lang.Iterable<DocumentField>, Streamable, ToXContent, ToXContentObject

public final class SearchHit
extends java.lang.Object
implements Streamable, ToXContentObject, java.lang.Iterable<DocumentField>

A single search hit.

See Also:

SearchHits

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchHit.Fields
static class	SearchHit.NestedIdentity	Encapsulates the nested identity of a hit.

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchHit(int docId)
SearchHit(int docId, java.lang.String id, Text type, java.util.Map<java.lang.String,DocumentField> fields)
SearchHit(int nestedTopDocId, java.lang.String id, Text type, SearchHit.NestedIdentity nestedIdentity, java.util.Map<java.lang.String,DocumentField> fields)

Method Summary

Modifier and Type	Method	Description
static SearchHit	createFromMap(java.util.Map<java.lang.String,java.lang.Object> values)
static void	declareInnerHitsParseFields(ObjectParser<java.util.Map<java.lang.String,java.lang.Object>,java.lang.Void> parser)
int	docId()
boolean	equals(java.lang.Object obj)
void	explanation(org.apache.lucene.search.Explanation explanation)
DocumentField	field(java.lang.String fieldName)	The hit field matching the given field name.
void	fields(java.util.Map<java.lang.String,DocumentField> fields)
java.util.Map<java.lang.String,DocumentField>	fieldsOrNull()
static SearchHit	fromXContent(XContentParser parser)
java.lang.String	getClusterAlias()	Returns the cluster alias this hit comes from or null if it comes from a local cluster
org.apache.lucene.search.Explanation	getExplanation()	If enabled, the explanation of the search hit.
java.util.Map<java.lang.String,DocumentField>	getFields()	A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
java.util.Map<java.lang.String,HighlightField>	getHighlightFields()	A map of highlighted fields.
java.lang.String	getId()	The id of the document.
java.lang.String	getIndex()	The index of the hit.
java.util.Map<java.lang.String,SearchHits>	getInnerHits()
java.lang.String[]	getMatchedQueries()	The set of query and filter names the query matched with.
SearchHit.NestedIdentity	getNestedIdentity()	If this is a nested hit then nested reference information is returned otherwise null is returned.
float	getScore()	The score.
SearchShardTarget	getShard()	The shard of the search hit.
java.lang.Object[]	getSortValues()	An array of the sort values used.
java.util.Map<java.lang.String,java.lang.Object>	getSourceAsMap()	The source of the document as a map (can be null).
java.lang.String	getSourceAsString()	The source of the document as string (can be null).
BytesReference	getSourceRef()	Returns bytes reference, also uncompress the source if needed.
java.lang.String	getType()	The type of the document.
long	getVersion()	The version of the hit.
int	hashCode()
boolean	hasSource()	Is the source available or not.
void	highlightFields(java.util.Map<java.lang.String,HighlightField> highlightFields)
java.util.Iterator<DocumentField>	iterator()
void	matchedQueries(java.lang.String[] matchedQueries)
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
static SearchHit	readSearchHit(StreamInput in)
void	score(float score)
void	setInnerHits(java.util.Map<java.lang.String,SearchHits> innerHits)
void	shard(SearchShardTarget target)
void	sortValues(java.lang.Object[] sortValues, DocValueFormat[] sortValueFormats)
void	sortValues(SearchSortValues sortValues)
SearchHit	sourceRef(BytesReference source)	Sets representation, might be compressed....
XContentBuilder	toInnerXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	version(long version)
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

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

isFragment

Constructor Detail

SearchHit

public SearchHit(int docId)

SearchHit

public SearchHit(int docId,
                 java.lang.String id,
                 Text type,
                 java.util.Map<java.lang.String,DocumentField> fields)

SearchHit

public SearchHit(int nestedTopDocId,
                 java.lang.String id,
                 Text type,
                 SearchHit.NestedIdentity nestedIdentity,
                 java.util.Map<java.lang.String,DocumentField> fields)

Method Detail

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.

getIndex

public java.lang.String getIndex()

The index of the hit.

getId

public java.lang.String getId()

The id of the document.

getType

public java.lang.String getType()

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 java.lang.String getSourceAsString()

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

getSourceAsMap

public java.util.Map<java.lang.String,java.lang.Object> getSourceAsMap()

The source of the document as a map (can be null).

iterator

public java.util.Iterator<DocumentField> iterator()

Specified by:

iterator in interface java.lang.Iterable<DocumentField>

field

public DocumentField field(java.lang.String fieldName)

The hit field matching the given field name.

getFields

public java.util.Map<java.lang.String,DocumentField> getFields()

A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.

fieldsOrNull

public java.util.Map<java.lang.String,DocumentField> fieldsOrNull()

fields

public void fields(java.util.Map<java.lang.String,DocumentField> fields)

getHighlightFields

public java.util.Map<java.lang.String,HighlightField> getHighlightFields()

A map of highlighted fields.

highlightFields

public void highlightFields(java.util.Map<java.lang.String,HighlightField> highlightFields)

sortValues

public void sortValues(java.lang.Object[] sortValues,
                       DocValueFormat[] sortValueFormats)

sortValues

public void sortValues(SearchSortValues sortValues)

getSortValues

public java.lang.Object[] getSortValues()

An array of the 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 java.lang.String getClusterAlias()

Returns the cluster alias this hit comes from or null if it comes from a local cluster

matchedQueries

public void matchedQueries(java.lang.String[] matchedQueries)

getMatchedQueries

public java.lang.String[] getMatchedQueries()

The set of query and filter names the query matched with. Mainly makes sense for compound filters and queries.

getInnerHits

public java.util.Map<java.lang.String,SearchHits> getInnerHits()

Returns:

Inner hits or null if there are none

setInnerHits

public void setInnerHits(java.util.Map<java.lang.String,SearchHits> innerHits)

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toInnerXContent

public XContentBuilder toInnerXContent(XContentBuilder builder,
                                       ToXContent.Params params)
                                throws java.io.IOException

Throws:

java.io.IOException

fromXContent

public static SearchHit fromXContent(XContentParser parser)

declareInnerHitsParseFields

public static void declareInnerHitsParseFields(ObjectParser<java.util.Map<java.lang.String,java.lang.Object>,java.lang.Void> parser)

createFromMap

public static SearchHit createFromMap(java.util.Map<java.lang.String,java.lang.Object> values)

readSearchHit

public static SearchHit readSearchHit(StreamInput in)
                               throws java.io.IOException

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object