org.elasticsearch.search

Class SearchHit

java.lang.Object

org.elasticsearch.search.SearchHit

All Implemented Interfaces:

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

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

A single search hit.

See Also:

SearchHits

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 and Description
SearchHit(int docId)
SearchHit(int docId, java.lang.String id, Text type, java.util.Map<java.lang.String,SearchHitField> fields)
SearchHit(int nestedTopDocId, java.lang.String id, Text type, SearchHit.NestedIdentity nestedIdentity, java.util.Map<java.lang.String,SearchHitField> fields)

Method Summary

Modifier and Type	Method and 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()
org.apache.lucene.search.Explanation	explanation() Deprecated. use getExplanation() instead
void	explanation(org.apache.lucene.search.Explanation explanation)
SearchHitField	field(java.lang.String fieldName) Deprecated. use getField(String) instead
java.util.Map<java.lang.String,SearchHitField>	fields() Deprecated. use getFields() instead
void	fields(java.util.Map<java.lang.String,SearchHitField> fields)
java.util.Map<java.lang.String,SearchHitField>	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.
SearchHitField	getField(java.lang.String fieldName) The hit field matching the given field name.
java.util.Map<java.lang.String,SearchHitField>	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>	getSource() The source of the document as a map (can be null).
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.
boolean	hasSource() Is the source available or not.
java.util.Map<java.lang.String,HighlightField>	highlightFields() Deprecated. use getHighlightFields() instead
void	highlightFields(java.util.Map<java.lang.String,HighlightField> highlightFields)
java.lang.String	id() Deprecated. use getId() instead
java.lang.String	index() Deprecated. use getIndex() instead
java.util.Iterator<SearchHitField>	iterator()
java.lang.String[]	matchedQueries() Deprecated.
void	matchedQueries(java.lang.String[] matchedQueries)
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
static SearchHit	readSearchHit(StreamInput in)
float	score() Deprecated. use getScore() instead
void	score(float score)
void	setInnerHits(java.util.Map<java.lang.String,SearchHits> innerHits)
SearchShardTarget	shard() Deprecated. use getShard() instead
void	shard(SearchShardTarget target)
java.lang.Object[]	sortValues() Deprecated. use getSortValues() instead
void	sortValues(java.lang.Object[] sortValues, DocValueFormat[] sortValueFormats)
void	sortValues(SearchSortValues sortValues)
byte[]	source() Deprecated.
java.util.Map<java.lang.String,java.lang.Object>	sourceAsMap() Deprecated. use getSourceAsMap() instgead
java.lang.String	sourceAsString() Deprecated. use getSourceAsString() instead
BytesReference	sourceRef() Deprecated. use getSourceRef() instead
SearchHit	sourceRef(BytesReference source) Sets representation, might be compressed....
XContentBuilder	toInnerXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	type() Deprecated. use getType() instead
long	version() Deprecated. use getVersion() instead
void	version(long version)
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

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

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

isFragment

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SearchHit

public SearchHit(int docId)

SearchHit

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

SearchHit

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

Method Detail

docId

public int docId()

score

public void score(float score)

score

@Deprecated
public float score()

Deprecated. use getScore() instead

The score.

getScore

public float getScore()

The score.

version

public void version(long version)

version

@Deprecated
public long version()

Deprecated. use getVersion() instead

The version of the hit.

getVersion

public long getVersion()

The version of the hit.

index

@Deprecated
public java.lang.String index()

Deprecated. use getIndex() instead

The index of the hit.

getIndex

public java.lang.String getIndex()

The index of the hit.

id

@Deprecated
public java.lang.String id()

Deprecated. use getId() instead

The id of the document.

getId

public java.lang.String getId()

The id of the document.

type

@Deprecated
public java.lang.String type()

Deprecated. use getType() instead

The type 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.

sourceRef

@Deprecated
public BytesReference sourceRef()

Deprecated. use getSourceRef() instead

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

sourceRef

public SearchHit sourceRef(BytesReference source)

Sets representation, might be compressed....

getSourceRef

public BytesReference getSourceRef()

Returns bytes reference, also uncompress the source if needed.

source

@Deprecated
public byte[] source()

Deprecated.

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.

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.

getSource

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

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

sourceAsString

@Deprecated
public java.lang.String sourceAsString()

Deprecated. use getSourceAsString() instead

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

getSourceAsString

public java.lang.String getSourceAsString()

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

sourceAsMap

@Deprecated
public java.util.Map<java.lang.String,java.lang.Object> sourceAsMap()
                                                                         throws ElasticsearchParseException

Deprecated. use getSourceAsMap() instgead

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

Throws:

ElasticsearchParseException

getSourceAsMap

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

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

Throws:

ElasticsearchParseException

iterator

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

Specified by:

iterator in interface java.lang.Iterable<SearchHitField>

field

@Deprecated
public SearchHitField field(java.lang.String fieldName)

Deprecated. use getField(String) instead

The hit field matching the given field name.

getField

public SearchHitField getField(java.lang.String fieldName)

The hit field matching the given field name.

fields

@Deprecated
public java.util.Map<java.lang.String,SearchHitField> fields()

Deprecated. use getFields() instead

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,SearchHitField> fieldsOrNull()

getFields

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

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

fields

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

highlightFields

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

Deprecated. use getHighlightFields() instead

A map of highlighted 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)

sortValues

@Deprecated
public java.lang.Object[] sortValues()

Deprecated. use getSortValues() instead

An array of the sort values used.

getSortValues

public java.lang.Object[] getSortValues()

An array of the sort values used.

explanation

@Deprecated
public org.apache.lucene.search.Explanation explanation()

Deprecated. use getExplanation() instead

If enabled, the explanation of the search hit.

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)

shard

@Deprecated
public SearchShardTarget shard()

Deprecated. use getShard() instead

The shard of the search hit.

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)

matchedQueries

@Deprecated
public java.lang.String[] matchedQueries()

Deprecated.

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

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