fr.ifremer.adagio.core.dao.referential.pmfm

Class UnitDaoBase

Object

HibernateDaoSupport

UnitDaoBase

All Implemented Interfaces:

UnitDao

Direct Known Subclasses:

UnitDaoImpl

public abstract class UnitDaoBase
extends HibernateDaoSupport
implements UnitDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type Unit.

See Also:

Unit

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface UnitDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
UnitDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateFirstResult(int pageNumber, int pageSize) firstResult = (pageNumber - 1) * pageSize
Collection<Unit>	create(Collection<Unit> entities) Creates a new instance of Unit and adds from the passed in entities collection
Unit	create(Date creationDate, String name, Status status, String symbol, Timestamp updateDate) Creates a new Unit instance from only required properties (attributes and association ends) and adds it to the persistent store.
Collection<?>	create(int transform, Collection<Unit> entities) Does the same thing as UnitDao.create(Unit) with an additional flag called transform.
Object	create(int transform, Date creationDate, String name, Status status, String symbol, Timestamp updateDate) Does the same thing as UnitDao.create(String, String, Date, Timestamp) with an additional flag called transform.
Object	create(int transform, String symbol, String name, Date creationDate, Timestamp updateDate) Does the same thing as UnitDao.create(String, String, Date, Timestamp) with an additional flag called transform.
Object	create(int transform, Unit unit) Does the same thing as UnitDao.create(Unit) with an additional flag called transform.
Unit	create(String symbol, String name, Date creationDate, Timestamp updateDate) Creates a new Unit instance from all attributes and adds it to the persistent store.
Unit	create(Unit unit) Creates an instance of Unit and adds it to the persistent store.
Unit	get(Integer id) Gets an instance of Unit from the persistent store.
Object	get(int transform, Integer id) Does the same thing as UnitDao.get(Integer) with an additional flag called transform.
protected PaginationResult	getPaginationResult(Query queryObject, int transform, int pageNumber, int pageSize) Executes and returns the given Hibernate queryObject as a PaginationResult instance.
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
Unit	load(Integer id) Loads an instance of Unit from the persistent store.
Object	load(int transform, Integer id) Does the same thing as UnitDao.load(Integer) with an additional flag called transform.
Collection<Unit>	loadAll() Loads all entities of type Unit.
Collection<?>	loadAll(int transform) Does the same thing as UnitDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as UnitDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as UnitDao.loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Collection<Unit> entities) Removes all entities in the given entities collection.
void	remove(Integer id) Removes the instance of Unit having the given identifier from the persistent store.
void	remove(Unit unit) Removes the instance of Unit from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as UnitDao.search(int, Search) but with an additional two flags called pageNumber and pageSize.
PaginationResult	search(int pageNumber, int pageSize, Search search) Does the same thing as UnitDao.search(Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as UnitDao.search(Search) but with an additional flag called transform.
Set<Unit>	search(Search search) Performs a search using the parameters specified in the given search object.
void	toEntities(Collection<?> results) Transforms the given results to a collection of Unit instances (this is useful when the returned results contains a row of data and you want just entities only).
protected Unit	toEntity(Object[] row)
void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the UnitDao.transformEntity(int,Unit) method.
Object	transformEntity(int transform, Unit 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 UnitDao, please note that the UnitDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<Unit> entities) Updates all instances in the entities collection in the persistent store.
void	update(Unit unit) Updates the unit instance in the persistent store.

Methods inherited from class HibernateDaoSupport

convertDatabase2UI, convertUI2DatabaseMandatoryDate, createQuery, dateOfYearWithOneMiliSecond, dateOfYearWithOneMiliSecondInMili, dateWithNoMiliSecond, dateWithNoSecondAndMiliSecond, dateWithNoSecondAndOneMiliSecond, dateWithNoTime, dateWithOneMiliSecond, deleteAll, get, getSession, getSession, getSessionFactory, load, newCreateDate, queryIterator, queryIteratorTyped, queryIteratorWithPage, queryList, queryListTyped, queryUnique, queryUniqueTyped, queryUpdate, setQueryParams, setSessionFactory

Methods inherited from class Object

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

Constructor Detail

UnitDaoBase

public UnitDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

Does the same thing as UnitDao.get(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:

get in interface UnitDao

Parameters:

transform - flag to determine transformation type.

id - the identifier of the entity to get.

Returns:

either the entity or the object transformed from the entity.

get

public Unit get(Integer id)

Gets an instance of Unit from the persistent store.

Specified by:

get in interface UnitDao

Returns:

Unit

load

public Object load(int transform,
          Integer id)

Does the same thing as UnitDao.load(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 UnitDao

Parameters:

transform - flag to determine transformation type.

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

public Unit load(Integer id)

Loads an instance of Unit from the persistent store.

Specified by:

load in interface UnitDao

Returns:

Unit

loadAll

public Collection<Unit> loadAll()

Loads all entities of type Unit.

Specified by:

loadAll in interface UnitDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

Does the same thing as UnitDao.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 UnitDao

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

loadAll

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

Does the same thing as UnitDao.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 UnitDao

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.

loadAll

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

Does the same thing as UnitDao.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 UnitDao

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.

calculateFirstResult

protected int calculateFirstResult(int pageNumber,
                       int pageSize)

firstResult = (pageNumber - 1) * pageSize

Parameters:

pageNumber -

pageSize -

Returns:

firstResult

create

public Unit create(Unit unit)

Creates an instance of Unit and adds it to the persistent store.

Specified by:

create in interface UnitDao

Returns:

Unit

create

public Object create(int transform,
            Unit unit)

Does the same thing as UnitDao.create(Unit) 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:

create in interface UnitDao

Returns:

Object

create

public Collection<Unit> create(Collection<Unit> entities)

Creates a new instance of Unit and adds from the passed in entities collection

Specified by:

create in interface UnitDao

Parameters:

entities - the collection of Unit instances to create.

Returns:

the created instances.

create

public Collection<?> create(int transform,
                   Collection<Unit> entities)

Does the same thing as UnitDao.create(Unit) 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 entities (into value objects for example). By default, transformation does not occur.

Specified by:

create in interface UnitDao

Returns:

Collection

create

public Unit create(String symbol,
          String name,
          Date creationDate,
          Timestamp updateDate)

Creates a new Unit instance from all attributes and adds it to the persistent store.

Specified by:

create in interface UnitDao

Returns:

Unit

create

public Object create(int transform,
            String symbol,
            String name,
            Date creationDate,
            Timestamp updateDate)

Does the same thing as UnitDao.create(String, String, Date, Timestamp) 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:

create in interface UnitDao

Returns:

Unit

create

public Unit create(Date creationDate,
          String name,
          Status status,
          String symbol,
          Timestamp updateDate)

Creates a new Unit instance from only required properties (attributes and association ends) and adds it to the persistent store.

Specified by:

create in interface UnitDao

Returns:

Unit

create

public Object create(int transform,
            Date creationDate,
            String name,
            Status status,
            String symbol,
            Timestamp updateDate)

Does the same thing as UnitDao.create(String, String, Date, Timestamp) 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:

create in interface UnitDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(Unit unit)

Updates the unit instance in the persistent store.

Specified by:

update in interface UnitDao

update

public void update(Collection<Unit> entities)

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

Specified by:

update in interface UnitDao

remove

public void remove(Unit unit)

Removes the instance of Unit from the persistent store.

Specified by:

remove in interface UnitDao

remove

public void remove(Integer id)

Removes the instance of Unit having the given identifier from the persistent store.

Specified by:

remove in interface UnitDao

remove

public void remove(Collection<Unit> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface UnitDao

transformEntity

public Object transformEntity(int transform,
                     Unit 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 UnitDao, please note that the UnitDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown UnitDao.TRANSFORM_NONE is assumed.

Specified by:

transformEntity in interface UnitDao

Parameters:

transform - one of the constants declared in UnitDao

entity - an entity that was found

Returns:

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

See Also:

UnitDao.transformEntity(int, Unit)

transformEntities

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

Transforms a collection of entities using the UnitDao.transformEntity(int,Unit) method. This method does not instantiate a new collection.

This method is to be used internally only.

Specified by:

transformEntities in interface UnitDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.referential.pmfm.UnitDao

entities - the collection of entities to transform

See Also:

UnitDao.transformEntity(int,Unit)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: UnitDao

Transforms the given results to a collection of Unit instances (this is useful when the returned results contains a row of data and you want just entities only).

Specified by:

toEntities in interface UnitDao

Parameters:

results - the query results.

See Also:

UnitDao.toEntities(Collection)

toEntity

protected Unit toEntity(Object[] row)

Parameters:

row -

Returns:

Unit

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)

Does the same thing as UnitDao.search(int, 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 UnitDao

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.

search

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

Does the same thing as UnitDao.search(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 UnitDao

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.

search

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

Does the same thing as UnitDao.search(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 UnitDao

Parameters:

transform - the transformation flag.

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

Returns:

any found results from the search.

search

public Set<Unit> search(Search search)

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

Specified by:

search in interface UnitDao

Parameters:

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

Returns:

any found results from the search.

getPaginationResult

protected PaginationResult getPaginationResult(Query queryObject,
                                   int transform,
                                   int pageNumber,
                                   int pageSize)

Executes and returns the given Hibernate queryObject as a PaginationResult instance.

Parameters:

queryObject -

transform -

pageNumber -

pageSize -

Returns:

PaginationResult