org.ovirt.engine.core.dao

Class DefaultGenericDaoDbFacade<T extends BusinessEntity<ID>,ID extends Serializable>

java.lang.Object

org.ovirt.engine.core.dao.BaseDAODbFacade

org.ovirt.engine.core.dao.DefaultGenericDaoDbFacade<T,ID>

Type Parameters:

T - The type of entity.

ID - The type of the entity's id.

All Implemented Interfaces:

DAO, GenericDao<T,ID>, ModificationDao<T,ID>, ReadDao<T,ID>

Direct Known Subclasses:

DiskDaoDbFacadeImpl, MassOperationsGenericDaoDbFacade

public abstract class DefaultGenericDaoDbFacade<T extends BusinessEntity<ID>,ID extends Serializable>
extends BaseDAODbFacade
implements GenericDao<T,ID>

Implementation for the GenericDao which provides a default implementation for all the methods which only requires extending classes to provide procedure names and relevant mapper classes.

Field Summary

Fields inherited from class org.ovirt.engine.core.dao.BaseDAODbFacade

dbFacade, dialect, jdbcTemplate, RETURN_VALUE_PARAMETER

Constructor Summary

Constructors

Constructor and Description
DefaultGenericDaoDbFacade()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract org.springframework.jdbc.core.simple.ParameterizedRowMapper<T>	createEntityRowMapper() Create a row mapper to map results to the entity.
protected abstract org.springframework.jdbc.core.namedparam.MapSqlParameterSource	createFullParametersMapper(T entity) Create a parameter mapper to map all entity fields to procedure parameters.
protected abstract org.springframework.jdbc.core.namedparam.MapSqlParameterSource	createIdParameterMapper(ID id) Create a parameter mapper to map the entity id to the id in the procedure parameters.
protected org.springframework.jdbc.core.simple.SimpleJdbcCallOperations	createQueryCall(String procedureName) Create a SimpleJdbcCallOperations used to call the given query procedure. Warning: This call should be used only for fetching entities.
T	get(ID id) Retrieves the entity with the given id.
List<T>	getAll() Retrieves all the entities of type T.
protected abstract String	getProcedureNameForGet()
protected abstract String	getProcedureNameForGetAll()
protected abstract String	getProcedureNameForRemove()
protected abstract String	getProcedureNameForSave()
protected abstract String	getProcedureNameForUpdate()
protected void	modify(String procedureName, org.springframework.jdbc.core.namedparam.MapSqlParameterSource paramSource)
void	remove(ID id) Removes the entity with the given id from the underlying store of data.
void	save(T entity) Persist a new instance of the entity.
protected void	update(org.springframework.jdbc.core.simple.SimpleJdbcCallOperations callToUpdate, T entity)
void	update(T entity) Update the entity in the DB using the given SimpleJdbcCallOperations.

Methods inherited from class org.ovirt.engine.core.dao.BaseDAODbFacade

getCallsHandler, getCustomMapSqlParameterSource, setDbFacade, setDialect, setTemplate

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGenericDaoDbFacade

public DefaultGenericDaoDbFacade()

Method Detail

update

public void update(T entity)

Update the entity in the DB using the given SimpleJdbcCallOperations.

Specified by:

update in interface ModificationDao<T extends BusinessEntity<ID>,ID extends Serializable>

Parameters:

entity - The image dynamic data.

getProcedureNameForUpdate

protected abstract String getProcedureNameForUpdate()

Returns:

The name of the procedure used to update the entity.

update

protected void update(org.springframework.jdbc.core.simple.SimpleJdbcCallOperations callToUpdate,
          T entity)

get

public T get(ID id)

Description copied from interface: ReadDao

Retrieves the entity with the given id.

Specified by:

get in interface ReadDao<T extends BusinessEntity<ID>,ID extends Serializable>

Parameters:

id - The id to look by (can't be null).

Returns:

The entity instance, or null if not found.

getProcedureNameForGet

protected abstract String getProcedureNameForGet()

Returns:

The name of the procedure used to fetch the entity.

getAll

public List<T> getAll()

Description copied from interface: ReadDao

Retrieves all the entities of type T.

Specified by:

getAll in interface ReadDao<T extends BusinessEntity<ID>,ID extends Serializable>

Returns:

A list of all the entities, or an empty list if none is found.

getProcedureNameForGetAll

protected abstract String getProcedureNameForGetAll()

Returns:

The name of the procedure used to fetch all the entities.

modify

protected void modify(String procedureName,
          org.springframework.jdbc.core.namedparam.MapSqlParameterSource paramSource)

save

public void save(T entity)

Description copied from interface: ModificationDao

Persist a new instance of the entity.

Specified by:

save in interface ModificationDao<T extends BusinessEntity<ID>,ID extends Serializable>

Parameters:

entity - The entity to persist (can't be null).

getProcedureNameForSave

protected abstract String getProcedureNameForSave()

Returns:

The name of the procedure used to save the entity.

remove

public void remove(ID id)

Description copied from interface: ModificationDao

Removes the entity with the given id from the underlying store of data.

Specified by:

remove in interface ModificationDao<T extends BusinessEntity<ID>,ID extends Serializable>

Parameters:

id - The id of the entity to remove (can't be null).

getProcedureNameForRemove

protected abstract String getProcedureNameForRemove()

Returns:

The name of the procedure used to remove the entity.

createIdParameterMapper

protected abstract org.springframework.jdbc.core.namedparam.MapSqlParameterSource createIdParameterMapper(ID id)

Create a parameter mapper to map the entity id to the id in the procedure parameters.

Parameters:

id - The entity to map id for.

Returns:

The mapper for the id from the entity.

createFullParametersMapper

protected abstract org.springframework.jdbc.core.namedparam.MapSqlParameterSource createFullParametersMapper(T entity)

Create a parameter mapper to map all entity fields to procedure parameters.

Parameters:

entity - The entity to map parameters for.

Returns:

The mapper for the parameters from the entity.

createEntityRowMapper

protected abstract org.springframework.jdbc.core.simple.ParameterizedRowMapper<T> createEntityRowMapper()

Create a row mapper to map results to the entity.

Returns:

A row mapper which can map results to an entity.

createQueryCall

protected org.springframework.jdbc.core.simple.SimpleJdbcCallOperations createQueryCall(String procedureName)

Create a SimpleJdbcCallOperations used to call the given query procedure.
Warning: This call should be used only for fetching entities.

Parameters:

procedureName - The name of the stored procedure to call.

Returns:

The SimpleJdbcCallOperations which can be used to call the procedure.