org.springframework.data.elasticsearch.core

Interface ResultsMapper

All Superinterfaces:

GetResultMapper, MultiGetResultMapper, SearchResultMapper

All Known Implementing Classes:

AbstractResultMapper, DefaultResultMapper

public interface ResultsMapper
extends SearchResultMapper, GetResultMapper, MultiGetResultMapper

ResultsMapper

Author:

Rizwan Idrees, Mohsin Husen, Artur Konczak, Christoph Strobl

Method Summary

Modifier and Type	Method and Description
EntityMapper	getEntityMapper()
default ProjectionFactory	getProjectionFactory() Get the configured ProjectionFactory.
default <T> T	mapEntity(String source, Class<T> clazz)
default <T> T	mapGetResult(org.elasticsearch.index.get.GetResult getResult, Class<T> type) Map a single GetResult to an instance of the given type.
default <T> T	mapSearchHit(org.elasticsearch.search.SearchHit searchHit, Class<T> type) Map a single SearchHit to an instance of the given type.

Methods inherited from interface org.springframework.data.elasticsearch.core.SearchResultMapper

mapResults

Methods inherited from interface org.springframework.data.elasticsearch.core.GetResultMapper

mapResult

Methods inherited from interface org.springframework.data.elasticsearch.core.MultiGetResultMapper

mapResults

Method Detail

getEntityMapper

EntityMapper getEntityMapper()

getProjectionFactory

default ProjectionFactory getProjectionFactory()

Get the configured ProjectionFactory.
NOTE Should be overwritten in implementation to make use of the type cache.

Since:

3.2

mapEntity

@Nullable
default <T> T mapEntity(String source,
                                  Class<T> clazz)

mapGetResult

@Nullable
default <T> T mapGetResult(org.elasticsearch.index.get.GetResult getResult,
                                     Class<T> type)

Map a single GetResult to an instance of the given type.

Specified by:

mapGetResult in interface GetResultMapper

Type Parameters:

T -

Parameters:

getResult - must not be null.

type - must not be null.

Returns:

can be null if the is empty.

Since:

3.2

mapSearchHit

@Nullable
default <T> T mapSearchHit(org.elasticsearch.search.SearchHit searchHit,
                                     Class<T> type)

Map a single SearchHit to an instance of the given type.

Specified by:

mapSearchHit in interface SearchResultMapper

Type Parameters:

T -

Parameters:

searchHit - must not be null.

type - must not be null.

Returns:

can be null if the SearchHit does not have a source.

Since:

3.2