Package org.springframework.data.elasticsearch.core.convert

Class MappingElasticsearchConverter

java.lang.Object

org.springframework.data.elasticsearch.core.convert.MappingElasticsearchConverter

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware, EnvironmentCapable, EntityConverter<ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty,Object,Document>, EntityReader<Object,Document>, EntityWriter<Object,Document>, ElasticsearchConverter

public class MappingElasticsearchConverter
extends Object
implements ElasticsearchConverter, ApplicationContextAware, InitializingBean, EnvironmentCapable

Elasticsearch specific EntityConverter implementation based on domain type metadata.

Since:

3.2

Author:

Rizwan Idrees, Mohsin Husen, Christoph Strobl, Peter-Josef Meisch, Mark Paluch, Roman Puchkovskiy, Konrad Kurdej, Subhobrata Dey, Marc Vanbrabant, Anton Naydenov, vdisk, Junghoon Ban, llosimura

Field Summary

Fields

Modifier and Type	Field	Description
protected Environment	environment

Constructor Summary

Constructors

Constructor	Description
MappingElasticsearchConverter(MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty> mappingContext)
MappingElasticsearchConverter(MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty> mappingContext, GenericConversionService conversionService)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
ConversionService	getConversionService()
Environment	getEnvironment()
MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty>	getMappingContext()
ElasticsearchTypeMapper	getTypeMapper()
<R> R	read(Class<R> type, Document source)
void	setApplicationContext(ApplicationContext applicationContext)
void	setConversions(CustomConversions conversions)	Set the CustomConversions to be applied during the mapping process.
String	updateFieldNames(String propertyPath, ElasticsearchPersistentEntity<?> persistentEntity)	Replaces the parts in a dot separated property path with the field names of the respective properties.
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 PropertyValueConverter.
void	write(Object source, Document sink)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.elasticsearch.core.convert.ElasticsearchConverter

convertId, getProjectionFactory, mapObject

Field Details

environment

@Nullable
protected Environment environment

Constructor Details

MappingElasticsearchConverter

public MappingElasticsearchConverter(MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty> mappingContext)

MappingElasticsearchConverter

public MappingElasticsearchConverter(MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty> mappingContext,
 @Nullable
 GenericConversionService conversionService)

Method Details

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

getEnvironment

public Environment getEnvironment()

Specified by:

getEnvironment in interface EnvironmentCapable

getMappingContext

public MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty> getMappingContext()

Specified by:

getMappingContext in interface EntityConverter<ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty,Object,Document>

getConversionService

public ConversionService getConversionService()

Specified by:

getConversionService in interface EntityConverter<ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty,Object,Document>

setConversions

public void setConversions(CustomConversions conversions)

Set the CustomConversions to be applied during the mapping process.
Conversions are registered after bean initialization.

Parameters:

conversions - must not be null.

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

getTypeMapper

public ElasticsearchTypeMapper getTypeMapper()

read

public <R> R read(Class<R> type,
 Document source)

Specified by:

read in interface EntityReader<Object,Document>

write

public void write(Object source,
 Document sink)

Specified by:

write in interface EntityWriter<Object,Document>

updateQuery

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

Description copied from interface: ElasticsearchConverter

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 PropertyValueConverter. If domainClass is null it's a noop.

Specified by:

updateQuery in interface ElasticsearchConverter

Parameters:

query - the query that is internally updated, must not be null

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

updateFieldNames

public String updateFieldNames(String propertyPath,
 ElasticsearchPersistentEntity<?> persistentEntity)

Description copied from interface: ElasticsearchConverter

Replaces the parts in a dot separated property path with the field names of the respective properties. If no matching property is found, the original parts are rteturned.

Specified by:

updateFieldNames in interface ElasticsearchConverter

Parameters:

propertyPath - the property path

persistentEntity - the replaced values.

Returns:

a String wihere the property names are replaced with field names