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

Interface JdbcConverter

All Superinterfaces:

RelationalConverter

All Known Implementing Classes:

BasicJdbcConverter, MappingJdbcConverter

public interface JdbcConverter
extends RelationalConverter

A JdbcConverter is responsible for converting for values to the native relational representation and vice versa.

Since:

1.1

Author:

Jens Schauder

Method Summary

Modifier and Type	Method	Description
Class<?>	getColumnType(RelationalPersistentProperty property)	The type to be used to store this property in the database.
RelationalMappingContext	getMappingContext()	Returns the underlying MappingContext used by the converter.
SQLType	getTargetSqlType(RelationalPersistentProperty property)	The SQL type constant used when using this property as a parameter for a SQL statement.
default <T> T	mapRow(PersistentPropertyPathExtension path, ResultSet resultSet, Identifier identifier, Object key)	Deprecated, for removal: This API element is subject to removal in a future version. use readAndResolve(Class, RowDocument, Identifier) instead.
default <T> T	mapRow(RelationalPersistentEntity<T> entity, ResultSet resultSet, Object key)	Deprecated. since 3.2, use readAndResolve(Class, RowDocument, Identifier) instead.
default <R> R	readAndResolve(Class<R> type, RowDocument source)	Read a RowDocument into the requested aggregate type and resolve references by looking these up from RelationResolver.
<R> R	readAndResolve(Class<R> type, RowDocument source, Identifier identifier)	Read a RowDocument into the requested aggregate type and resolve references by looking these up from RelationResolver.
JdbcValue	writeJdbcValue(Object value, Class<?> type, 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 interface org.springframework.data.relational.core.conversion.RelationalConverter

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

Method Details

writeJdbcValue

JdbcValue writeJdbcValue(@Nullable
 Object value,
 Class<?> type,
 SQLType sqlType)

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

Parameters:

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

type - Class 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.

Since:

2.4

mapRow

@Deprecated(since="3.2")
default <T> T mapRow(RelationalPersistentEntity<T> entity,
 ResultSet resultSet,
 Object key)

Deprecated.

since 3.2, use readAndResolve(Class, RowDocument, Identifier) instead.

Read the current row from ResultSet to an entity.

Type Parameters:

T -

Parameters:

entity - the persistent entity type.

resultSet - the ResultSet to read from.

key - primary key.

Returns:

mapRow

@Deprecated(since="3.2",
            forRemoval=true)
default <T> T mapRow(PersistentPropertyPathExtension path,
 ResultSet resultSet,
 Identifier identifier,
 Object key)

Deprecated, for removal: This API element is subject to removal in a future version.

use readAndResolve(Class, RowDocument, Identifier) instead.

Read the current row from ResultSet to an entity.

Type Parameters:

T -

Parameters:

path - path to the owning property.

resultSet - the ResultSet to read from.

identifier - entity identifier.

key - primary key.

Returns:

readAndResolve

default <R> R readAndResolve(Class<R> type,
 RowDocument source)

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

Type Parameters:

R - aggregate type.

Parameters:

type - target aggregate type.

source - source RowDocument.

Returns:

the converted object.

Since:

3.2

See Also:

• RelationalConverter.read(Class, RowDocument)

readAndResolve

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

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

Type Parameters:

R - aggregate type.

Parameters:

type - target aggregate type.

source - source RowDocument.

identifier - identifier chain.

Returns:

the converted object.

Since:

3.2

See Also:

• RelationalConverter.read(Class, RowDocument)

getColumnType

Class<?> getColumnType(RelationalPersistentProperty property)

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[]).

Returns:

a Class that is suitable for usage with JDBC drivers.

Since:

2.0

See Also:

• JdbcUtil.targetSqlTypeFor(Class)

getTargetSqlType

SQLType getTargetSqlType(RelationalPersistentProperty property)

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

Returns:

Must not be null.

Since:

2.0

See Also:

• Types

getMappingContext

RelationalMappingContext getMappingContext()

Description copied from interface: RelationalConverter

Returns the underlying MappingContext used by the converter.

Specified by:

getMappingContext in interface RelationalConverter

Returns:

never null