Package org.springframework.data.jdbc.core.convert

Class MappingJdbcConverter

java.lang.Object

org.springframework.data.relational.core.conversion.AbstractRelationalConverter

org.springframework.data.relational.core.conversion.MappingRelationalConverter

org.springframework.data.jdbc.core.convert.MappingJdbcConverter

All Implemented Interfaces:

Aware, ApplicationContextAware, EnvironmentCapable, JdbcConverter, RelationalConverter

public class MappingJdbcConverter
extends MappingRelationalConverter
implements JdbcConverter, ApplicationContextAware

RelationalConverter that uses a MappingContext to apply conversion of relational values to property values.

Conversion is configurable by providing a customized CustomConversions.

Since:

3.2

Author:

Mark Paluch, Jens Schauder, Christoph Strobl, Myeonghyeon Lee, Chirag Tailor

See Also:

• MappingContext
• SimpleTypeHolder
• CustomConversions

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.relational.core.conversion.MappingRelationalConverter

MappingRelationalConverter.AggregatePathValueProvider, MappingRelationalConverter.ConversionContext, MappingRelationalConverter.DefaultConversionContext, MappingRelationalConverter.DocumentValueProvider, MappingRelationalConverter.ProjectingConversionContext, MappingRelationalConverter.RelationalPropertyValueProvider

Constructor Summary

Constructors

Constructor	Description
MappingJdbcConverter(RelationalMappingContext context, RelationResolver relationResolver)	Creates a new MappingJdbcConverter given MappingContext and a no-op type factory throwing UnsupportedOperationException on type creation.
MappingJdbcConverter(RelationalMappingContext context, RelationResolver relationResolver, CustomConversions conversions, JdbcTypeFactory typeFactory)	Creates a new MappingJdbcConverter given MappingContext.

Method Summary

Modifier and Type	Method	Description
Class<?>	getColumnType(RelationalPersistentProperty property)	The type to be used to store this property in the database.
protected @Nullable Object	getPotentiallyConvertedSimpleWrite(Object value, TypeInformation<?> type)
SQLType	getTargetSqlType(RelationalPersistentProperty property)	The SQL type constant used when using this property as a parameter for a SQL statement.
protected MappingRelationalConverter.RelationalPropertyValueProvider	newValueProvider(RowDocumentAccessor documentAccessor, ValueExpressionEvaluator evaluator, MappingRelationalConverter.ConversionContext context)
<R> R	readAndResolve(TypeInformation<R> type, RowDocument source, Identifier identifier)	Read a RowDocument into the requested aggregate type and resolve references by looking these up from RelationResolver.
@Nullable Object	readValue(@Nullable Object value, TypeInformation<?> targetType)	Read and convert a single value that is coming from a database to the targetType expected by the domain model.
void	setExceptionTranslator(SQLExceptionTranslator exceptionTranslator)	Set the exception translator for this instance.
protected @Nullable Object	unwrap(@Nullable Object convertedValue)	Unwraps values of type JdbcValue.
JdbcValue	writeJdbcValue(@Nullable Object value, TypeInformation<?> columnType, SQLType sqlType)	Convert a property value into a JdbcValue that contains the converted value and information how to bind it to JDBC parameters.

Methods inherited from class org.springframework.data.relational.core.conversion.MappingRelationalConverter

doReadProjection, getConversionContext, getEnvironment, getPotentiallyConvertedSimpleRead, getPropertyAccessor, introspectProjection, newProjectingConversionContext, project, read, read, readAggregate, readAggregate, readCollectionOrArray, readMap, setApplicationContext, writeValue

Methods inherited from class org.springframework.data.relational.core.conversion.AbstractRelationalConverter

getConversions, getConversionService, getEntityInstantiators, getMappingContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.springframework.data.jdbc.core.convert.JdbcConverter

getMappingContext, readAndResolve, readAndResolve, writeJdbcValue

Methods inherited from interface org.springframework.data.relational.core.conversion.RelationalConverter

getConversionService, getEntityInstantiators, getPropertyAccessor, introspectProjection, project, read, writeValue

Constructor Details

MappingJdbcConverter

public MappingJdbcConverter(RelationalMappingContext context,
 RelationResolver relationResolver)

Creates a new MappingJdbcConverter given MappingContext and a no-op type factory throwing UnsupportedOperationException on type creation. Use MappingJdbcConverter(RelationalMappingContext, RelationResolver, CustomConversions, JdbcTypeFactory) to convert arrays and large objects into JDBC-specific types.

Parameters:

context - must not be null.

relationResolver - used to fetch additional relations from the database. Must not be null.

MappingJdbcConverter

public MappingJdbcConverter(RelationalMappingContext context,
 RelationResolver relationResolver,
 CustomConversions conversions,
 JdbcTypeFactory typeFactory)

Creates a new MappingJdbcConverter given MappingContext.

Parameters:

context - must not be null.

relationResolver - used to fetch additional relations from the database. Must not be null.

typeFactory - must not be null

Method Details

setExceptionTranslator

public void setExceptionTranslator(SQLExceptionTranslator exceptionTranslator)

Set the exception translator for this instance. Defaults to a SQLErrorCodeSQLExceptionTranslator.

See Also:

• SQLExceptionSubclassTranslator

getTargetSqlType

public SQLType getTargetSqlType(RelationalPersistentProperty property)

Description copied from interface: JdbcConverter

The SQL type constant used when using this property as a parameter for a SQL statement.

Specified by:

getTargetSqlType in interface JdbcConverter

Returns:

Must not be null.

See Also:

• Types

getColumnType

public Class<?> getColumnType(RelationalPersistentProperty property)

Description copied from interface: JdbcConverter

The type to be used to store this property in the database. Multidimensional arrays are unwrapped to reflect a top-level array type (e.g. String[][] returns String[]).

Specified by:

getColumnType in interface JdbcConverter

Returns:

a Class that is suitable for usage with JDBC drivers.

See Also:

• JdbcUtil.targetSqlTypeFor(Class)

readValue

public @Nullable Object readValue(@Nullable Object value,
 TypeInformation<?> targetType)

Read and convert a single value that is coming from a database to the targetType expected by the domain model.

Specified by:

readValue in interface RelationalConverter

Overrides:

readValue in class MappingRelationalConverter

Parameters:

value - a value as it is returned by the driver accessing the persistence store. May be null.

targetType - TypeInformation into which the value is to be converted. Must not be null.

Returns:

getPotentiallyConvertedSimpleWrite

protected @Nullable Object getPotentiallyConvertedSimpleWrite(Object value,
 TypeInformation<?> type)

Overrides:

getPotentiallyConvertedSimpleWrite in class MappingRelationalConverter

writeJdbcValue

public JdbcValue writeJdbcValue(@Nullable Object value,
 TypeInformation<?> columnType,
 SQLType sqlType)

Description copied from interface: JdbcConverter

Convert a property value into a JdbcValue that contains the converted value and information how to bind it to JDBC parameters.

Specified by:

writeJdbcValue in interface JdbcConverter

Parameters:

value - a value as it is used in the object model. May be null.

columnType - TypeInformation into which the value is to be converted. Must not be null.

sqlType - the SQLType to be used if non is specified by a converter.

Returns:

The converted value wrapped in a JdbcValue. Guaranteed to be not null.

unwrap

protected @Nullable Object unwrap(@Nullable Object convertedValue)

Unwraps values of type JdbcValue.

Overrides:

unwrap in class MappingRelationalConverter

Parameters:

convertedValue - a value that might need unwrapping.

readAndResolve

public <R> R readAndResolve(TypeInformation<R> type,
 RowDocument source,
 Identifier identifier)

Description copied from interface: JdbcConverter

Read a RowDocument into the requested aggregate type and resolve references by looking these up from RelationResolver.

Specified by:

readAndResolve in interface JdbcConverter

Type Parameters:

R - aggregate type.

Parameters:

type - target aggregate type.

source - source RowDocument.

identifier - identifier chain.

Returns:

the converted object.

See Also:

• RelationalConverter.read(Class, RowDocument)

newValueProvider

protected MappingRelationalConverter.RelationalPropertyValueProvider newValueProvider(RowDocumentAccessor documentAccessor,
 ValueExpressionEvaluator evaluator,
 MappingRelationalConverter.ConversionContext context)

Overrides:

newValueProvider in class MappingRelationalConverter