org.springframework.data.elasticsearch.core.convert

Interface ElasticsearchConverter

All Superinterfaces:

EntityConverter<ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty,Object,Document>, EntityReader<Object,Document>, EntityWriter<Object,Document>

All Known Implementing Classes:

MappingElasticsearchConverter

public interface ElasticsearchConverter
extends EntityConverter<ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty,Object,Document>

Author:

Rizwan Idrees, Mohsin Husen, Christoph Strobl, Peter-Josef Meisch, Sasch Woo, Roman Puchkovskiy

Method Summary

Modifier and Type	Method and Description
default String	convertId(Object idValue) Convert a given idValue to its String representation taking potentially registered Converters into account.
default ProjectionFactory	getProjectionFactory() Get the configured ProjectionFactory.
default Document	mapObject(Object source) Map an object to a Document.
void	updateCriteriaQuery(CriteriaQuery criteriaQuery, Class<?> domainClass) Updates a CriteriaQuery by renaming the property names in the query to the correct mapped field names and the values to the converted values if the ElasticsearchPersistentProperty for a property has a ElasticsearchPersistentPropertyConverter.
default void	updateQuery(Query query, Class<?> domainClass) Updates a query by renaming the property names in the query to the correct mapped field names and the values to the converted values if the ElasticsearchPersistentProperty for a property has a ElasticsearchPersistentPropertyConverter.

Methods inherited from interface org.springframework.data.convert.EntityConverter

getConversionService, getMappingContext

Methods inherited from interface org.springframework.data.convert.EntityReader

read

Methods inherited from interface org.springframework.data.convert.EntityWriter

write

Method Detail

getProjectionFactory

default ProjectionFactory getProjectionFactory()

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

Since:

3.2

convertId

default String convertId(Object idValue)

Convert a given idValue to its String representation taking potentially registered Converters into account.

Parameters:

idValue - must not be null.

Returns:

never null.

Since:

3.2

mapObject

default Document mapObject(@Nullable
                           Object source)

Map an object to a Document.

Parameters:

source - the object to map

Returns:

will not be null.

updateQuery

default void updateQuery(Query query,
                         @Nullable
                         Class<?> domainClass)

Updates a query by renaming the property names in the query to the correct mapped field names and the values to the converted values if the ElasticsearchPersistentProperty for a property has a ElasticsearchPersistentPropertyConverter. If domainClass is null, it's a noop; handling null here eliminates null checks in the caller.

Parameters:

query - the query that is internally updated

domainClass - the class of the object that is searched with the query

updateCriteriaQuery

void updateCriteriaQuery(CriteriaQuery criteriaQuery,
                         Class<?> domainClass)

Updates a CriteriaQuery by renaming the property names in the query to the correct mapped field names and the values to the converted values if the ElasticsearchPersistentProperty for a property has a ElasticsearchPersistentPropertyConverter.

Parameters:

criteriaQuery - the query that is internally updated

domainClass - the class of the object that is searched with the query