org.springframework.data.elasticsearch.core

Class SearchHit<T>

java.lang.Object

org.springframework.data.elasticsearch.core.SearchHit<T>

Type Parameters:

T - the result data class.

public class SearchHit<T>
extends Object

Encapsulates the found data with additional information from the search.

Since:

4.0

Author:

Peter-Josef Meisch

Constructor Summary

Constructors

Constructor and Description
SearchHit(String id, float score, Object[] sortValues, Map<String,List<String>> highlightFields, T content)

Method Summary

Modifier and Type	Method and Description
T	getContent()
List<String>	getHighlightField(String field) gets the highlight values for a field.
Map<String,List<String>>	getHighlightFields()
String	getId()
float	getScore()
List<Object>	getSortValues()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchHit

public SearchHit(@Nullable
                 String id,
                 float score,
                 @Nullable
                 Object[] sortValues,
                 @Nullable
                 Map<String,List<String>> highlightFields,
                 T content)

Method Detail

getId

@Nullable
public String getId()

getScore

public float getScore()

Returns:

the score for the hit.

getContent

public T getContent()

Returns:

the object data from the search.

getSortValues

public List<Object> getSortValues()

Returns:

the sort values if the query had a sort criterion.

getHighlightFields

public Map<String,List<String>> getHighlightFields()

getHighlightField

public List<String> getHighlightField(String field)

gets the highlight values for a field.

Parameters:

field - must not be null

Returns:

possibly empty List, never null

toString

public String toString()

Overrides:

toString in class Object