org.springframework.data.elasticsearch.core.convert

Class MappingElasticsearchConverter

java.lang.Object

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

All Implemented Interfaces:

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

public class MappingElasticsearchConverter
extends Object
implements ElasticsearchConverter, ApplicationContextAware, InitializingBean

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addCustomTypeKeyIfNecessary(Object source, Map<String,Object> sink, TypeInformation<?> type) Adds custom typeInformation information to the given Map if necessary.
void	afterPropertiesSet()
protected List<Object>	createCollection(Collection<?> collection, ElasticsearchPersistentProperty property) Writes the given Collection using the given ElasticsearchPersistentProperty information.
protected Map<String,Object>	createMap(Map<?,?> map, ElasticsearchPersistentProperty property) Writes the given Map using the given ElasticsearchPersistentProperty information.
ConversionService	getConversionService()
MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty>	getMappingContext()
protected Object	getWriteComplexValue(ElasticsearchPersistentProperty property, TypeInformation<?> typeHint, Object value) Deprecated. since 4.2, use writeInternal(Object, Map, TypeInformation) instead.
protected Object	getWriteSimpleValue(Object value) Deprecated. since 4.2, use getPotentiallyConvertedSimpleWrite(Object, Class) instead.
<R> R	read(Class<R> type, Document source)
protected <R> R	readEntity(ElasticsearchPersistentEntity<?> entity, Map<String,Object> source)
protected <R> R	readProperties(ElasticsearchPersistentEntity<?> entity, R instance, org.springframework.data.elasticsearch.core.convert.MappingElasticsearchConverter.ElasticsearchPropertyValueProvider valueProvider)
protected <R> R	readValue(Object value, ElasticsearchPersistentProperty property, TypeInformation<?> type)
boolean	requiresTypeHint(Class<?> type) Check if a given type requires a type hint (aka _class attribute) when writing to the document.
void	setApplicationContext(ApplicationContext applicationContext)
void	setConversions(CustomConversions conversions) Set the CustomConversions to be applied during the mapping process.
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.
void	write(Object source, Document sink)
protected void	writeInternal(Object source, Map<String,Object> sink, ElasticsearchPersistentEntity<?> entity) Internal write conversion method which should be used for nested invocations.
protected void	writeInternal(Object source, Map<String,Object> sink, TypeInformation<?> typeInformation) Internal write conversion method which should be used for nested invocations.
protected Map<String,Object>	writeMapInternal(Map<?,?> source, Map<String,Object> sink, TypeInformation<?> propertyType) Writes the given Map to the given Document considering the given TypeInformation.
protected void	writeProperties(ElasticsearchPersistentEntity<?> entity, PersistentPropertyAccessor<?> accessor, org.springframework.data.elasticsearch.core.convert.MappingElasticsearchConverter.MapValueAccessor sink)
protected void	writeProperty(ElasticsearchPersistentProperty property, Object value, org.springframework.data.elasticsearch.core.convert.MappingElasticsearchConverter.MapValueAccessor 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

Constructor Detail

MappingElasticsearchConverter

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

MappingElasticsearchConverter

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

Method Detail

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

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

read

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

Specified by:

read in interface EntityReader<Object,Document>

readEntity

protected <R> R readEntity(ElasticsearchPersistentEntity<?> entity,
                           Map<String,Object> source)

readProperties

protected <R> R readProperties(ElasticsearchPersistentEntity<?> entity,
                               R instance,
                               org.springframework.data.elasticsearch.core.convert.MappingElasticsearchConverter.ElasticsearchPropertyValueProvider valueProvider)

readValue

@Nullable
protected <R> R readValue(@Nullable
                                    Object value,
                                    ElasticsearchPersistentProperty property,
                                    TypeInformation<?> type)

write

public void write(Object source,
                  Document sink)

Specified by:

write in interface EntityWriter<Object,Document>

writeInternal

protected void writeInternal(@Nullable
                             Object source,
                             Map<String,Object> sink,
                             @Nullable
                             TypeInformation<?> typeInformation)

Internal write conversion method which should be used for nested invocations.

Parameters:

source - the object to write

sink - the write destination

typeInformation - type information for the source

writeInternal

protected void writeInternal(@Nullable
                             Object source,
                             Map<String,Object> sink,
                             @Nullable
                             ElasticsearchPersistentEntity<?> entity)

Internal write conversion method which should be used for nested invocations.

Parameters:

source - the object to write

sink - the write destination

entity - entity for the source

writeProperties

protected void writeProperties(ElasticsearchPersistentEntity<?> entity,
                               PersistentPropertyAccessor<?> accessor,
                               org.springframework.data.elasticsearch.core.convert.MappingElasticsearchConverter.MapValueAccessor sink)

writeProperty

protected void writeProperty(ElasticsearchPersistentProperty property,
                             Object value,
                             org.springframework.data.elasticsearch.core.convert.MappingElasticsearchConverter.MapValueAccessor sink)

createCollection

protected List<Object> createCollection(Collection<?> collection,
                                        ElasticsearchPersistentProperty property)

Writes the given Collection using the given ElasticsearchPersistentProperty information.

Parameters:

collection - must not be null.

property - must not be null.

createMap

protected Map<String,Object> createMap(Map<?,?> map,
                                       ElasticsearchPersistentProperty property)

Writes the given Map using the given ElasticsearchPersistentProperty information.

Parameters:

map - must not null.

property - must not be null.

writeMapInternal

protected Map<String,Object> writeMapInternal(Map<?,?> source,
                                              Map<String,Object> sink,
                                              TypeInformation<?> propertyType)

Writes the given Map to the given Document considering the given TypeInformation.

Parameters:

source - must not be null.

sink - must not be null.

propertyType - must not be null.

getWriteSimpleValue

@Nullable
 @Deprecated
protected Object getWriteSimpleValue(Object value)

Deprecated. since 4.2, use getPotentiallyConvertedSimpleWrite(Object, Class) instead.

getWriteComplexValue

@Deprecated
protected Object getWriteComplexValue(ElasticsearchPersistentProperty property,
                                                  TypeInformation<?> typeHint,
                                                  Object value)

Deprecated. since 4.2, use writeInternal(Object, Map, TypeInformation) instead.

addCustomTypeKeyIfNecessary

protected void addCustomTypeKeyIfNecessary(Object source,
                                           Map<String,Object> sink,
                                           @Nullable
                                           TypeInformation<?> type)

Adds custom typeInformation information to the given Map if necessary. That is if the value is not the same as the one given. This is usually the case if you store a subtype of the actual declared typeInformation of the property.

Parameters:

source - must not be null.

sink - must not be null.

type - type to compare to

requiresTypeHint

public boolean requiresTypeHint(Class<?> type)

Check if a given type requires a type hint (aka _class attribute) when writing to the document.

Parameters:

type - must not be null.

Returns:

true if not a simple type, Collection or type with custom write target.

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 ElasticsearchPersistentPropertyConverter. 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