org.elasticsearch.search.internal

Class InternalSearchHit

java.lang.Object

org.elasticsearch.search.internal.InternalSearchHit

All Implemented Interfaces:

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

public class InternalSearchHit
extends java.lang.Object
implements SearchHit

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalSearchHit.Fields
static class	InternalSearchHit.InternalNestedIdentity

Nested classes/interfaces inherited from interface org.elasticsearch.search.SearchHit

SearchHit.NestedIdentity

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
InternalSearchHit(int nestedTopDocId, java.lang.String id, Text type, InternalSearchHit.InternalNestedIdentity nestedIdentity, java.util.Map<java.lang.String,SearchHitField> fields)
InternalSearchHit(int docId, java.lang.String id, Text type, java.util.Map<java.lang.String,SearchHitField> fields)

Method Summary

Modifier and Type	Method and Description
int	docId()
org.apache.lucene.search.Explanation	explanation() If enabled, the explanation of the search hit.
void	explanation(org.apache.lucene.search.Explanation explanation)
SearchHitField	field(java.lang.String fieldName) The hit field matching the given field name.
java.util.Map<java.lang.String,SearchHitField>	fields() A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
void	fields(java.util.Map<java.lang.String,SearchHitField> fields)
java.util.Map<java.lang.String,SearchHitField>	fieldsOrNull()
org.apache.lucene.search.Explanation	getExplanation() If enabled, the explanation of the search hit.
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.lang.String	getSourceAsString() The source of the document as string (can be null).
BytesReference	getSourceRef() Returns bytes reference, also un compress 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() A map of highlighted fields.
void	highlightFields(java.util.Map<java.lang.String,HighlightField> highlightFields)
java.lang.String	id() The id of the document.
java.lang.String	index() The index of the hit.
java.util.Map<java.lang.String,HighlightField>	internalHighlightFields()
BytesReference	internalSourceRef() Internal source representation, might be compressed....
java.util.Iterator<SearchHitField>	iterator()
java.lang.String[]	matchedQueries() The set of query and filter names the query matched with.
void	matchedQueries(java.lang.String[] matchedQueries)
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
void	readFrom(StreamInput in, InternalSearchHits.StreamContext context)
static InternalSearchHit	readSearchHit(StreamInput in, InternalSearchHits.StreamContext context)
float	score() The score.
void	score(float score)
void	setInnerHits(java.util.Map<java.lang.String,InternalSearchHits> innerHits)
SearchShardTarget	shard() The shard of the search hit.
void	shard(SearchShardTarget target)
void	shardTarget(SearchShardTarget shardTarget)
java.lang.Object[]	sortValues() An array of the sort values used.
void	sortValues(java.lang.Object[] sortValues, DocValueFormat[] sortValueFormats)
byte[]	source() The source of the document (can be null).
java.util.Map<java.lang.String,java.lang.Object>	sourceAsMap() The source of the document as a map (can be null).
java.lang.String	sourceAsString() The source of the document as string (can be null).
BytesReference	sourceRef() Returns bytes reference, also un compress the source if needed.
InternalSearchHit	sourceRef(BytesReference source) Sets representation, might be compressed....
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	type() The type of the document.
long	version() The version of the hit.
void	version(long version)
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.
void	writeTo(StreamOutput out, InternalSearchHits.StreamContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

InternalSearchHit

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

InternalSearchHit

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

Method Detail

docId

public int docId()

shardTarget

public void shardTarget(SearchShardTarget shardTarget)

score

public void score(float score)

score

public float score()

Description copied from interface: SearchHit

The score.

Specified by:

score in interface SearchHit

getScore

public float getScore()

Description copied from interface: SearchHit

The score.

Specified by:

getScore in interface SearchHit

version

public void version(long version)

version

public long version()

Description copied from interface: SearchHit

The version of the hit.

Specified by:

version in interface SearchHit

getVersion

public long getVersion()

Description copied from interface: SearchHit

The version of the hit.

Specified by:

getVersion in interface SearchHit

index

public java.lang.String index()

Description copied from interface: SearchHit

The index of the hit.

Specified by:

index in interface SearchHit

getIndex

public java.lang.String getIndex()

Description copied from interface: SearchHit

The index of the hit.

Specified by:

getIndex in interface SearchHit

id

public java.lang.String id()

Description copied from interface: SearchHit

The id of the document.

Specified by:

id in interface SearchHit

getId

public java.lang.String getId()

Description copied from interface: SearchHit

The id of the document.

Specified by:

getId in interface SearchHit

type

public java.lang.String type()

Description copied from interface: SearchHit

The type of the document.

Specified by:

type in interface SearchHit

getType

public java.lang.String getType()

Description copied from interface: SearchHit

The type of the document.

Specified by:

getType in interface SearchHit

getNestedIdentity

public SearchHit.NestedIdentity getNestedIdentity()

Description copied from interface: SearchHit

If this is a nested hit then nested reference information is returned otherwise null is returned.

Specified by:

getNestedIdentity in interface SearchHit

sourceRef

public BytesReference sourceRef()

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

Specified by:

sourceRef in interface SearchHit

sourceRef

public InternalSearchHit sourceRef(BytesReference source)

Sets representation, might be compressed....

getSourceRef

public BytesReference getSourceRef()

Description copied from interface: SearchHit

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

Specified by:

getSourceRef in interface SearchHit

internalSourceRef

public BytesReference internalSourceRef()

Internal source representation, might be compressed....

source

public byte[] source()

Description copied from interface: SearchHit

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

Specified by:

source in interface SearchHit

hasSource

public boolean hasSource()

Description copied from interface: SearchHit

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.

Specified by:

hasSource in interface SearchHit

getSource

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

Description copied from interface: SearchHit

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

Specified by:

getSource in interface SearchHit

sourceAsString

public java.lang.String sourceAsString()

Description copied from interface: SearchHit

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

Specified by:

sourceAsString in interface SearchHit

getSourceAsString

public java.lang.String getSourceAsString()

Description copied from interface: SearchHit

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

Specified by:

getSourceAsString in interface SearchHit

sourceAsMap

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

Description copied from interface: SearchHit

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

Specified by:

sourceAsMap in interface SearchHit

Throws:

ElasticsearchParseException

iterator

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

Specified by:

iterator in interface java.lang.Iterable<SearchHitField>

field

public SearchHitField field(java.lang.String fieldName)

Description copied from interface: SearchHit

The hit field matching the given field name.

Specified by:

field in interface SearchHit

fields

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

Description copied from interface: SearchHit

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

Specified by:

fields in interface SearchHit

fieldsOrNull

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

getFields

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

Description copied from interface: SearchHit

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

Specified by:

getFields in interface SearchHit

fields

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

internalHighlightFields

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

highlightFields

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

Description copied from interface: SearchHit

A map of highlighted fields.

Specified by:

highlightFields in interface SearchHit

getHighlightFields

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

Description copied from interface: SearchHit

A map of highlighted fields.

Specified by:

getHighlightFields in interface SearchHit

highlightFields

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

sortValues

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

sortValues

public java.lang.Object[] sortValues()

Description copied from interface: SearchHit

An array of the sort values used.

Specified by:

sortValues in interface SearchHit

getSortValues

public java.lang.Object[] getSortValues()

Description copied from interface: SearchHit

An array of the sort values used.

Specified by:

getSortValues in interface SearchHit

explanation

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

Description copied from interface: SearchHit

If enabled, the explanation of the search hit.

Specified by:

explanation in interface SearchHit

getExplanation

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

Description copied from interface: SearchHit

If enabled, the explanation of the search hit.

Specified by:

getExplanation in interface SearchHit

explanation

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

shard

public SearchShardTarget shard()

Description copied from interface: SearchHit

The shard of the search hit.

Specified by:

shard in interface SearchHit

getShard

public SearchShardTarget getShard()

Description copied from interface: SearchHit

The shard of the search hit.

Specified by:

getShard in interface SearchHit

shard

public void shard(SearchShardTarget target)

matchedQueries

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

matchedQueries

public java.lang.String[] matchedQueries()

Description copied from interface: SearchHit

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

Specified by:

matchedQueries in interface SearchHit

getMatchedQueries

public java.lang.String[] getMatchedQueries()

Description copied from interface: SearchHit

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

Specified by:

getMatchedQueries in interface SearchHit

getInnerHits

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

Specified by:

getInnerHits in interface SearchHit

Returns:

Inner hits or null if there are none

setInnerHits

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

readSearchHit

public static InternalSearchHit readSearchHit(StreamInput in,
                                              InternalSearchHits.StreamContext context)
                                       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

readFrom

public void readFrom(StreamInput in,
                     InternalSearchHits.StreamContext context)
              throws java.io.IOException

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

writeTo

public void writeTo(StreamOutput out,
                    InternalSearchHits.StreamContext context)
             throws java.io.IOException

Throws:

java.io.IOException