de.julielab.elastic.query.components.data

Interface ISearchServerDocument

All Known Implementing Classes:

ElasticSearchDocumentHit

public interface ISearchServerDocument

Method Summary

Modifier and Type	Method and Description
<V> Optional<V>	get(String fieldName) Shortcut to getFieldValue(String).
default <V> Optional<V>	getFieldPayload(String fieldName)
<V> Optional<V>	getFieldValue(String fieldName)
Optional<List<Object>>	getFieldValues(String fieldName)
default Map<String,List<String>>	getHighlights()
default String	getId()
default String	getIndexType()
default Map<String,List<ISearchServerDocument>>	getInnerHits() Returns inner document hits, if existing.
float	getScore()

Method Detail

get

<V> Optional<V> get(String fieldName)

Shortcut to getFieldValue(String).

Parameters:

fieldName -

Returns:

getFieldValue

<V> Optional<V> getFieldValue(String fieldName)

getFieldValues

Optional<List<Object>> getFieldValues(String fieldName)

getScore

float getScore()

getInnerHits

default Map<String,List<ISearchServerDocument>> getInnerHits()

Returns inner document hits, if existing. They exist if a nested query was performed and the inner hits were set to be returned and the result document actually has at least one queried inner hit. That means the field value of the nested field must be non-empty on the document.

The keys of the map are the nested field names, e.g. "events" or "sentences". The values are the list of the inner hits - which are documents themselves - for the respective field.

Returns:

The inner hits of the document, ordered by nested field name.

getId

default String getId()

getIndexType

default String getIndexType()

getHighlights

default Map<String,List<String>> getHighlights()

getFieldPayload

default <V> Optional<V> getFieldPayload(String fieldName)