fr.ifremer.adagio.core.dao.data.sample

Class SampleDaoBase

Object

HibernateDaoSupport

SampleDaoBase

All Implemented Interfaces:

SampleDao

Direct Known Subclasses:

SampleDaoImpl

public abstract class SampleDaoBase
extends HibernateDaoSupport
implements SampleDao

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

See Also:

Sample

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface SampleDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
SampleDaoBase()

Method Summary

Methods

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

SampleDaoBase

public SampleDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

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

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

Gets an instance of Sample from the persistent store.

Specified by:

get in interface SampleDao

Returns:

Sample

load

public Object load(int transform,
          Integer id)

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

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

Loads an instance of Sample from the persistent store.

Specified by:

load in interface SampleDao

Returns:

Sample

loadAll

public Collection<Sample> loadAll()

Loads all entities of type Sample.

Specified by:

loadAll in interface SampleDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 Sample create(Sample sample)

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

Specified by:

create in interface SampleDao

Returns:

Sample

create

public Object create(int transform,
            Sample sample)

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

Returns:

Object

create

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

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

Specified by:

create in interface SampleDao

Parameters:

entities - the collection of Sample instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public Sample create(String label,
            Date sampleDate,
            Short individualCount,
            Float size,
            String comments,
            Date creationDate,
            Date controlDate,
            Date validationDate,
            Date qualificationDate,
            String qualificationComments,
            Timestamp updateDate)

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

Specified by:

create in interface SampleDao

Parameters:

label - Mnémonique du prélèvement. Par exemple, il peut s'agir d'un code propre à chaque programme : pour les marées observée, par exemple, il s'agira d'une étiquette permettant d'identifier l'échantillon sur le terrain puis en laboratoire. Autant que possible, le mnémonique devra etre unique pour tous le système, ou à défaut unique au sein de la marée, du débarquement, de la vente ou de la campagne. Nomenclature retenue à l'issu des spécifications Allegro V3 : ____ Avec : - : date de l’observation au format AAAMMJJ. La date est issue (suivant la donnée mère rattachée) : de la date de début de l’opération de pêche ou du groupe d’opérations (si période du groupe d’opération n’a pas été renseigné : prendre la date de début de la marée) ou de la date de débarquement, ou de la date de la vente. - : il s’agit des initiales déjà saisit par l’utilisateur (cf variante précédente). - : mnémonique du lieu d’observation, si présent, ou libellé sinon. Le lieu d’observation est issu (suivant la donnée mère rattachée) : pour une opération de pêche ou un groupe d’opérations, il s’agit du port de départ de la marée, pour un débarquement, du lieu de débarquement pour une vente, du lieu de la vente - : suivant la donnée mère rattachée : ‘G’ (=Ground) si donnée mère rattachée est un débarquement ou une vente ; ‘S’ (=Sea) si donnée mère rattachée est une opération de pêche ou à une groupe d’opérations. - : Il s’agit d’un numéro au format NNN (sur trois caractère. Exemple : « 001 »), auto-incrémentée (valeur maximale connue + 1) de manière à être unique au sein de (suivant la donnée mère rattachée) : la marée, si la donnée mère rattachée est une opération de pêche ou un groupe d’opérations ou du débarquement, ou de la vente

sampleDate - Jour du prélèvement (heure optionnelle).

individualCount - Nombre d'individus constituant l'échantillon.

size - La taille de l'échantillon peut représenter une surface ou un volume suivant les cas. Il peut aussi s'agir du nombre d'individus entrant dans l'homogénat.

comments - Commentaire libre concernant l'échantillon.

Returns:

Sample

create

public Object create(int transform,
            String label,
            Date sampleDate,
            Short individualCount,
            Float size,
            String comments,
            Date creationDate,
            Date controlDate,
            Date validationDate,
            Date qualificationDate,
            String qualificationComments,
            Timestamp updateDate)

Does the same thing as #create(String, Date, Short, Float, String, String, Date, Date, Date, Date, String, 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 SampleDao

label - Mnémonique du prélèvement. Par exemple, il peut s'agir d'un code propre à chaque programme : pour les marées observée, par exemple, il s'agira d'une étiquette permettant d'identifier l'échantillon sur le terrain puis en laboratoire. Autant que possible, le mnémonique devra etre unique pour tous le système, ou à défaut unique au sein de la marée, du débarquement, de la vente ou de la campagne. Nomenclature retenue à l'issu des spécifications Allegro V3 : ____ Avec : - : date de l’observation au format AAAMMJJ. La date est issue (suivant la donnée mère rattachée) : de la date de début de l’opération de pêche ou du groupe d’opérations (si période du groupe d’opération n’a pas été renseigné : prendre la date de début de la marée) ou de la date de débarquement, ou de la date de la vente. - : il s’agit des initiales déjà saisit par l’utilisateur (cf variante précédente). - : mnémonique du lieu d’observation, si présent, ou libellé sinon. Le lieu d’observation est issu (suivant la donnée mère rattachée) : pour une opération de pêche ou un groupe d’opérations, il s’agit du port de départ de la marée, pour un débarquement, du lieu de débarquement pour une vente, du lieu de la vente - : suivant la donnée mère rattachée : ‘G’ (=Ground) si donnée mère rattachée est un débarquement ou une vente ; ‘S’ (=Sea) si donnée mère rattachée est une opération de pêche ou à une groupe d’opérations. - : Il s’agit d’un numéro au format NNN (sur trois caractère. Exemple : « 001 »), auto-incrémentée (valeur maximale connue + 1) de manière à être unique au sein de (suivant la donnée mère rattachée) : la marée, si la donnée mère rattachée est une opération de pêche ou un groupe d’opérations ou du débarquement, ou de la vente

sampleDate - Jour du prélèvement (heure optionnelle).

individualCount - Nombre d'individus constituant l'échantillon.

size - La taille de l'échantillon peut représenter une surface ou un volume suivant les cas. Il peut aussi s'agir du nombre d'individus entrant dans l'homogénat.

comments - Commentaire libre concernant l'échantillon.

Returns:

Sample

create

public Sample create(Date creationDate,
            String label,
            Matrix matrix,
            Program program,
            QualityFlag qualityFlag,
            Department recorderDepartment,
            Timestamp updateDate)

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

Specified by:

create in interface SampleDao

Returns:

Sample

create

public Object create(int transform,
            Date creationDate,
            String label,
            Matrix matrix,
            Program program,
            QualityFlag qualityFlag,
            Department recorderDepartment,
            Timestamp updateDate)

Does the same thing as #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 SampleDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(Sample sample)

Updates the sample instance in the persistent store.

Specified by:

update in interface SampleDao

update

public void update(Collection<Sample> entities)

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

Specified by:

update in interface SampleDao

remove

public void remove(Sample sample)

Removes the instance of Sample from the persistent store.

Specified by:

remove in interface SampleDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface SampleDao

remove

public void remove(Collection<Sample> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface SampleDao

transformEntity

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

Specified by:

transformEntity in interface SampleDao

Parameters:

transform - one of the constants declared in SampleDao

entity - an entity that was found

Returns:

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

See Also:

SampleDao.transformEntity(int, Sample)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface SampleDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.data.sample.SampleDao

entities - the collection of entities to transform

See Also:

SampleDao.transformEntity(int,Sample)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: SampleDao

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

Specified by:

toEntities in interface SampleDao

Parameters:

results - the query results.

See Also:

SampleDao.toEntities(Collection)

toEntity

protected Sample toEntity(Object[] row)

Parameters:

row -

Returns:

Sample

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

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

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

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

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

Specified by:

search in interface SampleDao

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