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

Class CatchBatchDaoBase

Object

HibernateDaoSupport

CatchBatchDaoBase

All Implemented Interfaces:

CatchBatchDao

Direct Known Subclasses:

CatchBatchDaoImpl

public abstract class CatchBatchDaoBase
extends HibernateDaoSupport
implements CatchBatchDao

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

See Also:

CatchBatch

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface CatchBatchDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
CatchBatchDaoBase()

Method Summary

Methods

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

CatchBatchDaoBase

public CatchBatchDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

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

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

Gets an instance of CatchBatch from the persistent store.

Specified by:

get in interface CatchBatchDao

Returns:

CatchBatch

load

public Object load(int transform,
          Integer id)

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

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

Loads an instance of CatchBatch from the persistent store.

Specified by:

load in interface CatchBatchDao

Returns:

CatchBatch

loadAll

public Collection<CatchBatch> loadAll()

Loads all entities of type CatchBatch.

Specified by:

loadAll in interface CatchBatchDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 CatchBatch create(CatchBatch catchBatch)

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

Specified by:

create in interface CatchBatchDao

Returns:

CatchBatch

create

public Object create(int transform,
            CatchBatch catchBatch)

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

Returns:

Object

create

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

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

Specified by:

create in interface CatchBatchDao

Parameters:

entities - the collection of CatchBatch instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public CatchBatch create(Date controlDate,
                Date validationDate,
                Date qualificationDate,
                String qualificationComments,
                Timestamp updateDate,
                Short rankOrder,
                String label,
                Float subgroupCount,
                Integer individualCount,
                Boolean childBatchsReplication,
                Boolean exhaustiveInventory,
                String comments)

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

Specified by:

create in interface CatchBatchDao

rankOrder - Numéro d'ordre du lot. Sert pour déterminer l'ordre de présentation des lots rattaché à un même lot père.

label - Libellé du lot (besoin pour le flux d'échantillonnage ISCAX). mantis #13091

subgroupCount - Nombre de sous ensembles ayant servit à la quantification. Attention : Il ne s'agit pas du nombre de lot fils. Par exemple il pourra s'agir d'un nombre de caisse servant à quantifié le lot. Par exemple, pour une détermination de la quantification par les volumes : - nombre_sous_ensembles_quantifiés = 3 - poids moyen par sous-ensemble = 5 kg => Poids total du lot = 3 x 5 = 15kg

individualCount - Nombre d'individus comptés. Passage en Integer (sous oracle = NUMBER(10)) pour les besoins des données historiques SIH-OBSMER.

childBatchsReplication - Indique si les lots fils sont des réplicats ou non. Attribut non renseigné si un des lots père est rattaché à un taxon ou groupe de taxon.

exhaustiveInventory -

Indique si l'inventaire des espèces scientifiques (ReferenceTaxon) est exhaustif ou non.Attribut non renseigné si le lot ou un de ses lots père est rattaché à un taxon.

Si l'inventaire est exhautif, il convient de remplir BatchExhautiveInventory, pour tracer sur quelle liste d'espèces porte l'exhaustivité. Si BatchExhautiveInventory n'est pas renseigné, alors l'exhautivité porte sur toutes les espèces.

Returns:

CatchBatch

create

public Object create(int transform,
            Date controlDate,
            Date validationDate,
            Date qualificationDate,
            String qualificationComments,
            Timestamp updateDate,
            Short rankOrder,
            String label,
            Float subgroupCount,
            Integer individualCount,
            Boolean childBatchsReplication,
            Boolean exhaustiveInventory,
            String comments)

Does the same thing as #create(String, Date, Date, Date, String, Timestamp, Short, String, Float, Integer, Boolean, Boolean, String) 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 CatchBatchDao

rankOrder - Numéro d'ordre du lot. Sert pour déterminer l'ordre de présentation des lots rattaché à un même lot père.

label - Libellé du lot (besoin pour le flux d'échantillonnage ISCAX). mantis #13091

subgroupCount - Nombre de sous ensembles ayant servit à la quantification. Attention : Il ne s'agit pas du nombre de lot fils. Par exemple il pourra s'agir d'un nombre de caisse servant à quantifié le lot. Par exemple, pour une détermination de la quantification par les volumes : - nombre_sous_ensembles_quantifiés = 3 - poids moyen par sous-ensemble = 5 kg => Poids total du lot = 3 x 5 = 15kg

individualCount - Nombre d'individus comptés. Passage en Integer (sous oracle = NUMBER(10)) pour les besoins des données historiques SIH-OBSMER.

childBatchsReplication - Indique si les lots fils sont des réplicats ou non. Attribut non renseigné si un des lots père est rattaché à un taxon ou groupe de taxon.

exhaustiveInventory -

Indique si l'inventaire des espèces scientifiques (ReferenceTaxon) est exhaustif ou non.Attribut non renseigné si le lot ou un de ses lots père est rattaché à un taxon.

Si l'inventaire est exhautif, il convient de remplir BatchExhautiveInventory, pour tracer sur quelle liste d'espèces porte l'exhaustivité. Si BatchExhautiveInventory n'est pas renseigné, alors l'exhautivité porte sur toutes les espèces.

Returns:

CatchBatch

create

public CatchBatch create(Boolean childBatchsReplication,
                Boolean exhaustiveInventory,
                QualityFlag qualityFlag,
                Short rankOrder,
                Timestamp updateDate)

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

Specified by:

create in interface CatchBatchDao

Returns:

CatchBatch

create

public Object create(int transform,
            Boolean childBatchsReplication,
            Boolean exhaustiveInventory,
            QualityFlag qualityFlag,
            Short rankOrder,
            Timestamp updateDate)

Does the same thing as #create(String, Timestamp, Short, Boolean, Boolean) 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 CatchBatchDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(CatchBatch catchBatch)

Updates the catchBatch instance in the persistent store.

Specified by:

update in interface CatchBatchDao

update

public void update(Collection<CatchBatch> entities)

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

Specified by:

update in interface CatchBatchDao

remove

public void remove(CatchBatch catchBatch)

Removes the instance of CatchBatch from the persistent store.

Specified by:

remove in interface CatchBatchDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface CatchBatchDao

remove

public void remove(Collection<CatchBatch> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface CatchBatchDao

transformEntity

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

Specified by:

transformEntity in interface CatchBatchDao

Parameters:

transform - one of the constants declared in CatchBatchDao

entity - an entity that was found

Returns:

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

See Also:

CatchBatchDao.transformEntity(int, CatchBatch)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface CatchBatchDao

Parameters:

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

entities - the collection of entities to transform

See Also:

CatchBatchDao.transformEntity(int,CatchBatch)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: CatchBatchDao

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

Specified by:

toEntities in interface CatchBatchDao

Parameters:

results - the query results.

See Also:

CatchBatchDao.toEntities(Collection)

toEntity

protected CatchBatch toEntity(Object[] row)

Parameters:

row -

Returns:

CatchBatch

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

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

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

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

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

Specified by:

search in interface CatchBatchDao

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