org.elasticsearch.search
Interface SearchHit

All Superinterfaces:

Iterable<SearchHitField>, Streamable, ToXContent

All Known Implementing Classes:

InternalSearchHit

public interface SearchHit
extends Streamable, ToXContent, Iterable<SearchHitField>

A single search hit.

See Also:

SearchHits

Nested Class Summary

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

ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Method Summary

org.apache.lucene.search.Explanation	explanation() If enabled, the explanation of the search hit.
SearchHitField	field(String fieldName) The hit field matching the given field name.
Map<String,SearchHitField>	fields() A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
org.apache.lucene.search.Explanation	getExplanation() If enabled, the explanation of the search hit.
Map<String,SearchHitField>	getFields() A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
Map<String,HighlightField>	getHighlightFields() A map of highlighted fields.
String	getId() The id of the document.
String	getIndex() The index of the hit.
String[]	getMatchedFilters() The set of filter names the query matched.
float	getScore() The score.
SearchShardTarget	getShard() The shard of the search hit.
Object[]	getSortValues() An array of the sort values used.
Map<String,Object>	getSource() The source of the document as a map (can be null).
String	getSourceAsString() The source of the document as string (can be null).
BytesReference	getSourceRef() Returns bytes reference, also un compress the source if needed.
String	getType() The type of the document.
long	getVersion() The version of the hit.
Map<String,HighlightField>	highlightFields() A map of highlighted fields.
String	id() The id of the document.
String	index() The index of the hit.
boolean	isSourceEmpty() Is the source empty (not available) or not.
String[]	matchedFilters() The set of filter names the query matched.
float	score() The score.
SearchShardTarget	shard() The shard of the search hit.
Object[]	sortValues() An array of the sort values used.
byte[]	source() The source of the document (can be null).
Map<String,Object>	sourceAsMap() The source of the document as a map (can be null).
String	sourceAsString() The source of the document as string (can be null).
BytesReference	sourceRef() Returns bytes reference, also un compress the source if needed.
String	type() The type of the document.
long	version() The version of the hit.

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

readFrom, writeTo

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

toXContent

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

score

float score()

The score.

getScore

float getScore()

The score.

index

String index()

The index of the hit.

getIndex

String getIndex()

The index of the hit.

id

String id()

The id of the document.

getId

String getId()

The id of the document.

type

String type()

The type of the document.

getType

String getType()

The type of the document.

version

long version()

The version of the hit.

getVersion

long getVersion()

The version of the hit.

sourceRef

BytesReference sourceRef()

Returns bytes reference, also un compress the source if needed.

getSourceRef

BytesReference getSourceRef()

Returns bytes reference, also un compress the source if needed.

source

byte[] source()

The source of the document (can be null). Note, its a copy of the source into a byte array, consider using sourceRef() so there won't be a need to copy.

isSourceEmpty

boolean isSourceEmpty()

Is the source empty (not available) or not.

getSource

Map<String,Object> getSource()

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

sourceAsString

String sourceAsString()

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

getSourceAsString

String getSourceAsString()

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

sourceAsMap

Map<String,Object> sourceAsMap()
                               throws ElasticSearchParseException

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

Throws:

ElasticSearchParseException

explanation

org.apache.lucene.search.Explanation explanation()

If enabled, the explanation of the search hit.

getExplanation

org.apache.lucene.search.Explanation getExplanation()

If enabled, the explanation of the search hit.

field

SearchHitField field(String fieldName)

The hit field matching the given field name.

fields

Map<String,SearchHitField> fields()

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

getFields

Map<String,SearchHitField> getFields()

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

highlightFields

Map<String,HighlightField> highlightFields()

A map of highlighted fields.

getHighlightFields

Map<String,HighlightField> getHighlightFields()

A map of highlighted fields.

sortValues

Object[] sortValues()

An array of the sort values used.

getSortValues

Object[] getSortValues()

An array of the sort values used.

matchedFilters

String[] matchedFilters()

The set of filter names the query matched. Mainly makes sense for OR filters.

getMatchedFilters

String[] getMatchedFilters()

The set of filter names the query matched. Mainly makes sense for OR filters.

shard

SearchShardTarget shard()

The shard of the search hit.

getShard

SearchShardTarget getShard()

The shard of the search hit.