fr.ifremer.adagio.core.dao.referential.taxon

Class ReferenceDocumentDaoBase

Object

HibernateDaoSupport

ReferenceDocumentDaoBase

All Implemented Interfaces:

ReferenceDocumentDao

Direct Known Subclasses:

ReferenceDocumentDaoImpl

public abstract class ReferenceDocumentDaoBase
extends HibernateDaoSupport
implements ReferenceDocumentDao

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

See Also:

ReferenceDocument

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface ReferenceDocumentDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
ReferenceDocumentDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateFirstResult(int pageNumber, int pageSize) firstResult = (pageNumber - 1) * pageSize
ReferenceDocument	create(Collection<Author> authors, Date creationDate, String reference, Status status, Timestamp updateDate) Creates a new ReferenceDocument instance from only required properties (attributes and association ends) and adds it to the persistent store.
Collection<ReferenceDocument>	create(Collection<ReferenceDocument> entities) Creates a new instance of ReferenceDocument and adds from the passed in entities collection
Object	create(int transform, Collection<Author> authors, Date creationDate, String reference, Status status, Timestamp updateDate) Does the same thing as #create(String, Date, Timestamp) with an additional flag called transform.
Collection<?>	create(int transform, Collection<ReferenceDocument> entities) Does the same thing as ReferenceDocumentDao.create(ReferenceDocument) with an additional flag called transform.
Object	create(int transform, ReferenceDocument referenceDocument) Does the same thing as ReferenceDocumentDao.create(ReferenceDocument) with an additional flag called transform.
Object	create(int transform, String reference, Date publicationDate, String comments, Date creationDate, Timestamp updateDate) Does the same thing as ReferenceDocumentDao.create(String, Date, String, Date, Timestamp) with an additional flag called transform.
ReferenceDocument	create(ReferenceDocument referenceDocument) Creates an instance of ReferenceDocument and adds it to the persistent store.
ReferenceDocument	create(String reference, Date publicationDate, String comments, Date creationDate, Timestamp updateDate) Creates a new ReferenceDocument instance from all attributes and adds it to the persistent store.
ReferenceDocument	get(Integer id) Gets an instance of ReferenceDocument from the persistent store.
Object	get(int transform, Integer id) Does the same thing as ReferenceDocumentDao.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.
ReferenceDocument	load(Integer id) Loads an instance of ReferenceDocument from the persistent store.
Object	load(int transform, Integer id) Does the same thing as ReferenceDocumentDao.load(Integer) with an additional flag called transform.
Collection<ReferenceDocument>	loadAll() Loads all entities of type ReferenceDocument.
Collection<?>	loadAll(int transform) Does the same thing as ReferenceDocumentDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as ReferenceDocumentDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as ReferenceDocumentDao.loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Collection<ReferenceDocument> entities) Removes all entities in the given entities collection.
void	remove(Integer id) Removes the instance of ReferenceDocument having the given identifier from the persistent store.
void	remove(ReferenceDocument referenceDocument) Removes the instance of ReferenceDocument from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as ReferenceDocumentDao.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 ReferenceDocumentDao.search(Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as ReferenceDocumentDao.search(Search) but with an additional flag called transform.
Set<ReferenceDocument>	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 ReferenceDocument instances (this is useful when the returned results contains a row of data and you want just entities only).
protected ReferenceDocument	toEntity(Object[] row)
void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the ReferenceDocumentDao.transformEntity(int,ReferenceDocument) method.
Object	transformEntity(int transform, ReferenceDocument 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 ReferenceDocumentDao, please note that the ReferenceDocumentDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<ReferenceDocument> entities) Updates all instances in the entities collection in the persistent store.
void	update(ReferenceDocument referenceDocument) Updates the referenceDocument 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

ReferenceDocumentDaoBase

public ReferenceDocumentDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

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

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 ReferenceDocument get(Integer id)

Gets an instance of ReferenceDocument from the persistent store.

Specified by:

get in interface ReferenceDocumentDao

Returns:

ReferenceDocument

load

public Object load(int transform,
          Integer id)

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

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 ReferenceDocument load(Integer id)

Loads an instance of ReferenceDocument from the persistent store.

Specified by:

load in interface ReferenceDocumentDao

Returns:

ReferenceDocument

loadAll

public Collection<ReferenceDocument> loadAll()

Loads all entities of type ReferenceDocument.

Specified by:

loadAll in interface ReferenceDocumentDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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 ReferenceDocumentDao.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 ReferenceDocumentDao

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 ReferenceDocumentDao.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 ReferenceDocumentDao

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 ReferenceDocument create(ReferenceDocument referenceDocument)

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

Specified by:

create in interface ReferenceDocumentDao

Returns:

ReferenceDocument

create

public Object create(int transform,
            ReferenceDocument referenceDocument)

Does the same thing as ReferenceDocumentDao.create(ReferenceDocument) 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 ReferenceDocumentDao

Returns:

Object

create

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

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

Specified by:

create in interface ReferenceDocumentDao

Parameters:

entities - the collection of ReferenceDocument instances to create.

Returns:

the created instances.

create

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

Does the same thing as ReferenceDocumentDao.create(ReferenceDocument) 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 ReferenceDocumentDao

Returns:

Collection

create

public ReferenceDocument create(String reference,
                       Date publicationDate,
                       String comments,
                       Date creationDate,
                       Timestamp updateDate)

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

Specified by:

create in interface ReferenceDocumentDao

Parameters:

reference - Libellé stockant la référence du document. Ceci peut être le nom, l'édition etc.

publicationDate - Date de parution du document.

comments - Commentaires divers associés au document de référence.

creationDate - Date de création système du document de référence. Renseigné automatiquement par le système.

updateDate - Date de mise à jour système de la référence. Renseigné automatiquement par le système.

Returns:

ReferenceDocument

create

public Object create(int transform,
            String reference,
            Date publicationDate,
            String comments,
            Date creationDate,
            Timestamp updateDate)

Does the same thing as ReferenceDocumentDao.create(String, Date, 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 ReferenceDocumentDao

reference - Libellé stockant la référence du document. Ceci peut être le nom, l'édition etc.

publicationDate - Date de parution du document.

comments - Commentaires divers associés au document de référence.

creationDate - Date de création système du document de référence. Renseigné automatiquement par le système.

updateDate - Date de mise à jour système de la référence. Renseigné automatiquement par le système.

Returns:

ReferenceDocument

create

public ReferenceDocument create(Collection<Author> authors,
                       Date creationDate,
                       String reference,
                       Status status,
                       Timestamp updateDate)

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

Specified by:

create in interface ReferenceDocumentDao

Returns:

ReferenceDocument

create

public Object create(int transform,
            Collection<Author> authors,
            Date creationDate,
            String reference,
            Status status,
            Timestamp updateDate)

Does the same thing as #create(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 ReferenceDocumentDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(ReferenceDocument referenceDocument)

Updates the referenceDocument instance in the persistent store.

Specified by:

update in interface ReferenceDocumentDao

update

public void update(Collection<ReferenceDocument> entities)

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

Specified by:

update in interface ReferenceDocumentDao

remove

public void remove(ReferenceDocument referenceDocument)

Removes the instance of ReferenceDocument from the persistent store.

Specified by:

remove in interface ReferenceDocumentDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface ReferenceDocumentDao

remove

public void remove(Collection<ReferenceDocument> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface ReferenceDocumentDao

transformEntity

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

Specified by:

transformEntity in interface ReferenceDocumentDao

Parameters:

transform - one of the constants declared in ReferenceDocumentDao

entity - an entity that was found

Returns:

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

See Also:

ReferenceDocumentDao.transformEntity(int, ReferenceDocument)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface ReferenceDocumentDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.referential.taxon.ReferenceDocumentDao

entities - the collection of entities to transform

See Also:

ReferenceDocumentDao.transformEntity(int,ReferenceDocument)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: ReferenceDocumentDao

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

Specified by:

toEntities in interface ReferenceDocumentDao

Parameters:

results - the query results.

See Also:

ReferenceDocumentDao.toEntities(Collection)

toEntity

protected ReferenceDocument toEntity(Object[] row)

Parameters:

row -

Returns:

ReferenceDocument

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 ReferenceDocumentDao.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 ReferenceDocumentDao

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 ReferenceDocumentDao.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 ReferenceDocumentDao

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 ReferenceDocumentDao.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 ReferenceDocumentDao

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<ReferenceDocument> search(Search search)

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

Specified by:

search in interface ReferenceDocumentDao

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