org.apache.deltaspike.data.api.mapping

Class SimpleQueryInOutMapperBase<Entity,Dto>

java.lang.Object

org.apache.deltaspike.data.api.mapping.SimpleQueryInOutMapperBase<Entity,Dto>

Type Parameters:

Entity - The Entity type.

Dto - The Dto type.

All Implemented Interfaces:

QueryInOutMapper<Entity>

public abstract class SimpleQueryInOutMapperBase<Entity,Dto>
extends Object
implements QueryInOutMapper<Entity>

A base mapper to map from Dto to Entity and vice versa. This should be sufficient for most mapping cases and simplify the implementation of a mapper.

Constructor Summary

Constructors

Constructor and Description
SimpleQueryInOutMapperBase()

Method Summary

Modifier and Type	Method and Description
protected Entity	findEntity(Object primaryKey)
protected abstract Object	getPrimaryKey(Dto dto) Return the primary key of the Entity corresponding to the Dto.
Object	mapParameter(Object parameter) Map a query parameter.
Object	mapResult(Entity result) Map a single result query.
Object	mapResultList(List<Entity> result) Map a query result list.
boolean	mapsParameter(Object parameter) Check if this mapper handles a specific input parameter.
protected Entity	newEntity()
protected abstract Dto	toDto(Entity entity)
protected abstract Entity	toEntity(Entity entity, Dto dto) Map a Dto to an Entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleQueryInOutMapperBase

public SimpleQueryInOutMapperBase()

Method Detail

getPrimaryKey

protected abstract Object getPrimaryKey(Dto dto)

Return the primary key of the Entity corresponding to the Dto. If this is a new Entity, return null.

Parameters:

dto - The Dto to map to an Entity.

Returns:

The Entity primary key, or null for a new Entity.

toDto

protected abstract Dto toDto(Entity entity)

toEntity

protected abstract Entity toEntity(Entity entity,
                                   Dto dto)

Map a Dto to an Entity. In case the Dto contains a valid primary key, the Entity will be retrieved first and used as method parameter. Otherwise Entity is a unmanaged new instance.

Parameters:

entity - Either a managed Entity looked up by the primary key, or a new Entity instance.

dto - The Dto to map.

Returns:

Mapped Entity.

mapResult

public Object mapResult(Entity result)

Description copied from interface: QueryInOutMapper

Map a single result query.

Specified by:

mapResult in interface QueryInOutMapper<Entity>

Parameters:

result - The query result to map.

Returns:

The mapped result object.

mapResultList

public Object mapResultList(List<Entity> result)

Description copied from interface: QueryInOutMapper

Map a query result list.

Specified by:

mapResultList in interface QueryInOutMapper<Entity>

Parameters:

result - The query result list to map.

Returns:

The mapped result. Does not have to be a collection.

mapsParameter

public boolean mapsParameter(Object parameter)

Description copied from interface: QueryInOutMapper

Check if this mapper handles a specific input parameter.

Specified by:

mapsParameter in interface QueryInOutMapper<Entity>

Parameters:

parameter - The parameter candidate for mapping.

Returns:

true if the mapper handles the parameter.

mapParameter

public Object mapParameter(Object parameter)

Description copied from interface: QueryInOutMapper

Map a query parameter.

Specified by:

mapParameter in interface QueryInOutMapper<Entity>

Parameters:

parameter - The parameter to map. It can be assumed that the QueryInOutMapper.mapsParameter(Object) method has been called before with this parameter.

Returns:

The mapped result.

newEntity

protected Entity newEntity()

findEntity

protected Entity findEntity(Object primaryKey)