Class SqlResultEntityTypeMapper<RS,R>

java.lang.Object

io.micronaut.data.runtime.mapper.sql.SqlResultEntityTypeMapper<RS,R>

Type Parameters:

RS - The result set type

R - The result type

All Implemented Interfaces:

SqlTypeMapper<RS,R>, TypeMapper<RS,R>

@Internal
public final class SqlResultEntityTypeMapper<RS,R>
extends Object
implements SqlTypeMapper<RS,R>

A TypeMapper that can take a RuntimePersistentEntity and a ResultReader and materialize an instance using column naming conventions mapped by the entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SqlResultEntityTypeMapper.PushingMapper<RS,R>	The pushing mapper helper interface.

Constructor Summary

Constructors

Constructor	Description
SqlResultEntityTypeMapper(RuntimePersistentEntity<R> entity, ResultReader<RS,String> resultReader, @Nullable Set<JoinPath> joinPaths, @Nullable SqlJsonColumnReader<RS> jsonColumnReader, DataConversionService conversionService)	Constructor used to customize the join paths.
SqlResultEntityTypeMapper(RuntimePersistentEntity<R> entity, ResultReader<RS,String> resultReader, @Nullable Set<JoinPath> joinPaths, @Nullable SqlJsonColumnReader<RS> jsonColumnReader, @Nullable BiFunction<RuntimePersistentEntity<Object>, Object, Object> loadListener, DataConversionService conversionService, @Nullable DatabaseConversionContextFactory conversionContextFactory)	Constructor used to customize the join paths.
SqlResultEntityTypeMapper(@Nullable String prefix, RuntimePersistentEntity<R> entity, ResultReader<RS,String> resultReader, @Nullable SqlJsonColumnReader<RS> jsonColumnReader, DataConversionService conversionService)	Default constructor.

Method Summary

Modifier and Type	Method	Description
DataConversionService	getConversionService()
RuntimePersistentEntity<R>	getEntity()
RuntimePersistentEntity<R>	getPersistentEntity()
ResultReader<RS,String>	getResultReader()
boolean	hasNext(RS resultSet)	Is another result available.
R	map(RS rs, Class<R> type)	Map the given result set to the given object.
@Nullable Object	read(RS resultSet, io.micronaut.core.type.Argument<?> argument)	Read a value for the given name from the given object.
@Nullable Object	read(RS resultSet, String name)	Read a value for the given name from the given object.
R	readEntity(RS rs)	Read the entity from the result set.
SqlResultEntityTypeMapper.PushingMapper<RS,List<R>>	readManyMapper()	Read multiple entities with a pushing mapper.
SqlResultEntityTypeMapper.PushingMapper<RS,R>	readOneMapper()	Read one entity with a pushing mapper.

Methods inherited from class Object

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

Constructor Details

SqlResultEntityTypeMapper

public SqlResultEntityTypeMapper(@Nullable String prefix,
 RuntimePersistentEntity<R> entity,
 ResultReader<RS,String> resultReader,
 @Nullable SqlJsonColumnReader<RS> jsonColumnReader,
 DataConversionService conversionService)

Default constructor.

Parameters:

prefix - The prefix to startup from.

entity - The entity

resultReader - The result reader

jsonColumnReader - The json column reader

conversionService - The conversion service

SqlResultEntityTypeMapper

public SqlResultEntityTypeMapper(RuntimePersistentEntity<R> entity,
 ResultReader<RS,String> resultReader,
 @Nullable Set<JoinPath> joinPaths,
 @Nullable SqlJsonColumnReader<RS> jsonColumnReader,
 DataConversionService conversionService)

Constructor used to customize the join paths.

Parameters:

entity - The entity

resultReader - The result reader

joinPaths - The join paths

jsonColumnReader - The json column reader

conversionService - The conversion service

SqlResultEntityTypeMapper

public SqlResultEntityTypeMapper(RuntimePersistentEntity<R> entity,
 ResultReader<RS,String> resultReader,
 @Nullable Set<JoinPath> joinPaths,
 @Nullable SqlJsonColumnReader<RS> jsonColumnReader,
 @Nullable BiFunction<RuntimePersistentEntity<Object>, Object, Object> loadListener,
 DataConversionService conversionService,
 @Nullable DatabaseConversionContextFactory conversionContextFactory)

Constructor used to customize the join paths.

Parameters:

entity - The entity

resultReader - The result reader

joinPaths - The join paths

jsonColumnReader - The json column reader

loadListener - The event listener

conversionService - The conversion service

conversionContextFactory - The conversion context factory

Method Details

getConversionService

public DataConversionService getConversionService()

Specified by:

getConversionService in interface TypeMapper<RS,R>

Returns:

The conversion service to use.

getEntity

public RuntimePersistentEntity<R> getEntity()

Returns:

The entity to be materialized

getResultReader

public ResultReader<RS,String> getResultReader()

Returns:

The result reader instance.

map

public R map(RS rs,
 Class<R> type)
      throws DataAccessException

Description copied from interface: TypeMapper

Map the given result set to the given object.

Specified by:

map in interface TypeMapper<RS,R>

Parameters:

rs - The object to map

type - The type

Returns:

The mapped object

Throws:

DataAccessException - If the object cannot be mapped.

readEntity

public R readEntity(RS rs)
             throws DataAccessException

Read the entity from the result set.

Parameters:

rs - The result set

Returns:

The entity

Throws:

DataAccessException

Since:

4.2.0

read

public @Nullable Object read(RS resultSet,
 String name)

Description copied from interface: TypeMapper

Read a value for the given name from the given object.

Specified by:

read in interface TypeMapper<RS,R>

Parameters:

resultSet - The object to read from

name - The name

Returns:

The value

read

public @Nullable Object read(RS resultSet,
 io.micronaut.core.type.Argument<?> argument)

Description copied from interface: TypeMapper

Read a value for the given name from the given object.

Specified by:

read in interface TypeMapper<RS,R>

Parameters:

resultSet - The object to read from

argument - The argument

Returns:

The value

hasNext

public boolean hasNext(RS resultSet)

Description copied from interface: SqlTypeMapper

Is another result available.

Specified by:

hasNext in interface SqlTypeMapper<RS,R>

Parameters:

resultSet - The result set

Returns:

True if it is

readOneMapper

public SqlResultEntityTypeMapper.PushingMapper<RS,R> readOneMapper()

Read one entity with a pushing mapper.

Returns:

The pushing mapper

readManyMapper

public SqlResultEntityTypeMapper.PushingMapper<RS,List<R>> readManyMapper()

Read multiple entities with a pushing mapper.

Returns:

The pushing mapper

getPersistentEntity

public RuntimePersistentEntity<R> getPersistentEntity()