org.springframework.data.elasticsearch.core.document

Interface SearchDocument

All Superinterfaces:

Document, Map<String,Object>, StringObjectMap<Document>

public interface SearchDocument
extends Document

Extension to Document exposing search response related data.

Since:

4.0

Author:

Mark Paluch, Peter-Josef Meisch, Matt Gilene

See Also:

Document

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
Explanation	getExplanation()
Map<String,List<Object>>	getFields()
default <V> V	getFieldValue(String name) The first value of the given field.
default Map<String,List<String>>	getHighlightFields()
default Map<String,SearchDocumentResponse>	getInnerHits()
List<String>	getMatchedQueries()
default NestedMetaData	getNestedMetaData()
default String	getRouting()
float	getScore() Return the search score.
default Object[]	getSortValues()

Methods inherited from interface org.springframework.data.elasticsearch.core.document.Document

create, from, fromJson, getId, getIndex, getPrimaryTerm, getSeqNo, getVersion, hasId, hasPrimaryTerm, hasSeqNo, hasVersion, parse, setId, setIndex, setPrimaryTerm, setSeqNo, setVersion, transform

Methods inherited from interface org.springframework.data.elasticsearch.support.StringObjectMap

append, get, getBoolean, getBooleanOrDefault, getBooleanOrDefault, getInt, getIntOrDefault, getIntOrDefault, getLong, getLongOrDefault, getLongOrDefault, getString, getStringOrDefault, getStringOrDefault, toJson

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getScore

float getScore()

Return the search score.

Returns:

the search score.

getFields

Map<String,List<Object>> getFields()

Returns:

the fields for the search result, not null

getFieldValue

@Nullable
default <V> V getFieldValue(String name)

The first value of the given field.

Parameters:

name - the field name

getSortValues

@Nullable
default Object[] getSortValues()

Returns:

the sort values for the search hit

getHighlightFields

@Nullable
default Map<String,List<String>> getHighlightFields()

Returns:

the highlightFields for the search hit.

getInnerHits

@Nullable
default Map<String,SearchDocumentResponse> getInnerHits()

Returns:

the innerHits for the SearchHit

Since:

4.1

getNestedMetaData

@Nullable
default NestedMetaData getNestedMetaData()

Returns:

the nested metadata in case this is a nested inner hit.

Since:

4.1

getRouting

@Nullable
default String getRouting()

Returns:

the routing value for the document

Since:

4.2

getExplanation

@Nullable
Explanation getExplanation()

Returns:

the explanation for the SearchHit.

Since:

4.2

getMatchedQueries

@Nullable
List<String> getMatchedQueries()

Returns:

the matched queries for the SearchHit.