fr.ifremer.adagio.core.dao.data.batch

Class BatchDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

fr.ifremer.adagio.core.dao.data.batch.BatchDaoBase

All Implemented Interfaces:

BatchDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

BatchDaoImpl

public abstract class BatchDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements BatchDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type fr.ifremer.adagio.core.dao.data.batch.Batch.

See Also:

Batch

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface fr.ifremer.adagio.core.dao.data.batch.BatchDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
BatchDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
Batch	load(Integer id) Loads an instance of fr.ifremer.adagio.core.dao.data.batch.Batch from the persistent store.
Object	load(int transform, Integer id) Does the same thing as BatchDao.load(java.lang.Integer) with an additional flag called transform.
Collection<Batch>	loadAll() Loads all entities of type Batch.
Collection<?>	loadAll(int transform) Does the same thing as BatchDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as BatchDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as BatchDao.loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Batch batch) Removes the instance of fr.ifremer.adagio.core.dao.data.batch.Batch from the persistent store.
void	remove(Collection<Batch> entities) Removes all entities in the given entities collection.
void	remove(Integer id) Removes the instance of fr.ifremer.adagio.core.dao.data.batch.Batch having the given identifier from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as {@link #search(int, fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize.
PaginationResult	search(int pageNumber, int pageSize, Search search) Does the same thing as {@link #search(fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as BatchDao.search(fr.ifremer.adagio.core.dao.Search) but with an additional flag called transform.
Set<Batch>	search(Search search) Performs a search using the parameters specified in the given search object.
protected Batch	toEntity(Object[] row)
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,fr.ifremer.adagio.core.dao.data.batch.Batch) method.
protected Object	transformEntity(int transform, Batch entity) Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in fr.ifremer.adagio.core.dao.data.batch.BatchDao, please note that the BatchDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Batch batch) Updates the batch instance in the persistent store.
void	update(Collection<Batch> entities) Updates all instances in the entities collection in the persistent store.

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchDaoBase

public BatchDaoBase()

Method Detail

load

public Object load(int transform,
          Integer id)

Description copied from interface: BatchDao

Does the same thing as BatchDao.load(java.lang.Integer) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

load in interface BatchDao

id - identifier of the entity to load

Returns:

either the entity or the object transformed from the entity.

See Also:

BatchDao.load(int, java.lang.Integer)

load

public Batch load(Integer id)

Description copied from interface: BatchDao

Loads an instance of fr.ifremer.adagio.core.dao.data.batch.Batch from the persistent store.

Specified by:

load in interface BatchDao

See Also:

BatchDao.load(java.lang.Integer)

loadAll

public Collection<Batch> loadAll()

Description copied from interface: BatchDao

Loads all entities of type Batch.

Specified by:

loadAll in interface BatchDao

Returns:

the loaded entities.

See Also:

BatchDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: BatchDao

Does the same thing as BatchDao.loadAll() with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

loadAll in interface BatchDao

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

BatchDao.loadAll(int)

loadAll

public Collection<?> loadAll(int pageNumber,
                    int pageSize)

Description copied from interface: BatchDao

Does the same thing as BatchDao.loadAll() with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

Specified by:

loadAll in interface BatchDao

Parameters:

pageNumber - the page number to retrieve when paging results.

pageSize - the size of the page to retrieve when paging results.

Returns:

the loaded entities.

See Also:

BatchDao.loadAll(int, int)

loadAll

public Collection<?> loadAll(int transform,
                    int pageNumber,
                    int pageSize)

Description copied from interface: BatchDao

Does the same thing as BatchDao.loadAll(int) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

Specified by:

loadAll in interface BatchDao

Parameters:

transform - the flag indicating what transformation to use.

pageNumber - the page number to retrieve when paging results.

pageSize - the size of the page to retrieve when paging results.

Returns:

the loaded entities.

See Also:

BatchDao.loadAll(int, int, int)

update

public void update(Batch batch)

Description copied from interface: BatchDao

Updates the batch instance in the persistent store.

Specified by:

update in interface BatchDao

See Also:

BatchDao.update(fr.ifremer.adagio.core.dao.data.batch.Batch)

update

public void update(Collection<Batch> entities)

Description copied from interface: BatchDao

Updates all instances in the entities collection in the persistent store.

Specified by:

update in interface BatchDao

See Also:

fr.ifremer.adagio.core.dao.data.batch.BatchDao#update(java.util.Collection)

remove

public void remove(Batch batch)

Description copied from interface: BatchDao

Removes the instance of fr.ifremer.adagio.core.dao.data.batch.Batch from the persistent store.

Specified by:

remove in interface BatchDao

See Also:

BatchDao.remove(fr.ifremer.adagio.core.dao.data.batch.Batch)

remove

public void remove(Integer id)

Description copied from interface: BatchDao

Removes the instance of fr.ifremer.adagio.core.dao.data.batch.Batch having the given identifier from the persistent store.

Specified by:

remove in interface BatchDao

See Also:

BatchDao.remove(java.lang.Integer)

remove

public void remove(Collection<Batch> entities)

Description copied from interface: BatchDao

Removes all entities in the given entities collection.

Specified by:

remove in interface BatchDao

See Also:

fr.ifremer.adagio.core.dao.data.batch.BatchDao#remove(java.util.Collection)

transformEntity

protected Object transformEntity(int transform,
                     Batch entity)

Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in fr.ifremer.adagio.core.dao.data.batch.BatchDao, please note that the BatchDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown BatchDao.TRANSFORM_NONE is assumed.

Parameters:

transform - one of the constants declared in BatchDao

entity - an entity that was found

Returns:

the transformed entity (i.e. new value object, etc)

See Also:

transformEntities(int,java.util.Collection)

transformEntities

protected void transformEntities(int transform,
                     Collection<?> entities)

Transforms a collection of entities using the transformEntity(int,fr.ifremer.adagio.core.dao.data.batch.Batch) method. This method does not instantiate a new collection.

This method is to be used internally only.

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.data.batch.BatchDao

entities - the collection of entities to transform

See Also:

transformEntity(int,fr.ifremer.adagio.core.dao.data.batch.Batch)

toEntity

protected Batch toEntity(Object[] row)

getPrincipal

protected Principal getPrincipal()

Gets the current principal if one has been set, otherwise returns null.

Returns:

the current principal

search

public PaginationResult search(int transform,
                      int pageNumber,
                      int pageSize,
                      Search search)

Description copied from interface: BatchDao

Does the same thing as {@link #search(int, fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size.

Specified by:

search in interface BatchDao

Parameters:

transform - the transformation flag.

pageNumber - the page number in the data to retrieve

pageSize - the size of the page to retrieve.

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search wrapped in a PaginationResult instance.

See Also:

BatchDao.search(int, int, int, fr.ifremer.adagio.core.dao.Search)

search

public PaginationResult search(int pageNumber,
                      int pageSize,
                      Search search)

Description copied from interface: BatchDao

Does the same thing as {@link #search(fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size.

Specified by:

search in interface BatchDao

Parameters:

pageNumber - the page number in the data to retrieve

pageSize - the size of the page to retrieve.

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search wrapped in a PaginationResult instance.

See Also:

BatchDao.search(int, int, fr.ifremer.adagio.core.dao.Search)

search

public Set<?> search(int transform,
            Search search)

Description copied from interface: BatchDao

Does the same thing as BatchDao.search(fr.ifremer.adagio.core.dao.Search) but with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

Specified by:

search in interface BatchDao

Parameters:

transform - the transformation flag.

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search.

See Also:

BatchDao.search(int, fr.ifremer.adagio.core.dao.Search)

search

public Set<Batch> search(Search search)

Description copied from interface: BatchDao

Performs a search using the parameters specified in the given search object.

Specified by:

search in interface BatchDao

Parameters:

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search.

See Also:

BatchDao.search(fr.ifremer.adagio.core.dao.Search)