fr.ifremer.adagio.core.dao.data.measure

Class SampleMeasurementDaoBase

Object

HibernateDaoSupport

SampleMeasurementDaoBase

All Implemented Interfaces:

SampleMeasurementDao

Direct Known Subclasses:

SampleMeasurementDaoImpl

public abstract class SampleMeasurementDaoBase
extends HibernateDaoSupport
implements SampleMeasurementDao

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

See Also:

SampleMeasurement

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface SampleMeasurementDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
SampleMeasurementDaoBase()

Method Summary

Methods

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

SampleMeasurementDaoBase

public SampleMeasurementDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

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

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

Gets an instance of SampleMeasurement from the persistent store.

Specified by:

get in interface SampleMeasurementDao

Returns:

SampleMeasurement

load

public Object load(int transform,
          Integer id)

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

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

Loads an instance of SampleMeasurement from the persistent store.

Specified by:

load in interface SampleMeasurementDao

Returns:

SampleMeasurement

loadAll

public Collection<SampleMeasurement> loadAll()

Loads all entities of type SampleMeasurement.

Specified by:

loadAll in interface SampleMeasurementDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 SampleMeasurement create(SampleMeasurement sampleMeasurement)

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

Specified by:

create in interface SampleMeasurementDao

Returns:

SampleMeasurement

create

public Object create(int transform,
            SampleMeasurement sampleMeasurement)

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

Returns:

Object

create

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

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

Specified by:

create in interface SampleMeasurementDao

Parameters:

entities - the collection of SampleMeasurement instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public SampleMeasurement create(Short individualNumber,
                       Boolean isReferenceMeasurement,
                       Float numericalValue,
                       String alphanumericalValue,
                       Integer digitCount,
                       Float precisionValue,
                       Date controlDate,
                       Date validationDate,
                       Date qualificationDate,
                       String qualificationComments)

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

Specified by:

create in interface SampleMeasurementDao

Parameters:

individualNumber - Numéro de l'individu sur lequel est effectué la mesure. (quand plusieurs individu ont été comptés, au niveau de l'échantillon)

isReferenceMeasurement - Dans le cas de plusieurs résultat de mesure au sein d'un prélèvement sur un meme individu (identifié par le numéro d'individu), cela permet de distinguer la valeur de référence (celle qu'il faudra exploiter) tout en gardant les autres mesure. Exemple : - Pour la leture d'age, plusieurs déterminations d'age sont effectuées, mais une seule est conservée.

numericalValue - valeur numérique de la mesure.
Elle est nécessairement exprimée dans l'unité associé au PSFM de la mesure.
Renseigné uniquement pour un PSFM numérique (PMFM.parameter.isQualitative=false)

alphanumericalValue -

Valeur alphanumérique de la mesure.

Attention : Utilisation à éviter. A utiliser uniquement dans des cas ou les valeurs qualitatives ne peuvent pas convenir (format non fixe, etc.).

Exemples :
* Numéros de contrat (Ventre ERS)
* Type de dimension d'engin (logbook - flux SACAPT) "2X60", "2x6 dragues 75", "13.9x2", "2x7m²", "2x17.50", "2m x 2", etc

digitCount -

Nombre de digits saisis dans la valeur numérique de la mesure.

Cela permet de stocker "10.00" (numericalvalue=10 et digitCount=2) et de pouvoir restituer la valeur sous la meme forme.

precisionValue -

Précision de la mesure. Par exemple : precisioNValue=0.5 pour indiquer une précision à + ou - "0.5".

Valeur exprimée soit dans l'unite de la mesure (ex : "mm"), soit en poucentage de la mesure (suivant la valeur de PrecisionType).

controlDate - Date du controle de la donnée. Le controle est la première phase de validation de la donnée. Exemple : - Dans Allegro, ce controle est effectué lorsque l'utilisateur a achevé sa saisie et qu'il souhaite "Terminer la saisie", dans le but de transmettre ses données au système centrale. Les controle effectué par Allegro sur le poste client sont des vérifications sur les champs obligatoires, ou encore sur la cohérence des données (cas d'un arbre d'échantillonnage).

validationDate - Date de validation de la donnée. La validation est typiquement effectué par un thématicien responsable des données. Dans Allegro, il s'agit du superviseur du portefeuille de données qui en est responsable.

qualificationDate - Date de qualification de la donnée. L'étape de qualification est liée à l'affectation d'un flag qualité (bon, mauvais, etc.) sur la donnée. - la qualification n'est pas encore gérée dans Allegro, dans le sens ou il n'existe pass encore d'interface pour affecter le flag qualité. Par défaut, le niveau de qualité est donc à "non qualifiée"

Returns:

SampleMeasurement

create

public Object create(int transform,
            Short individualNumber,
            Boolean isReferenceMeasurement,
            Float numericalValue,
            String alphanumericalValue,
            Integer digitCount,
            Float precisionValue,
            Date controlDate,
            Date validationDate,
            Date qualificationDate,
            String qualificationComments)

Does the same thing as SampleMeasurementDao.create(Short, Boolean, Float, String, Integer, Float, Date, Date, Date, 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 SampleMeasurementDao

individualNumber - Numéro de l'individu sur lequel est effectué la mesure. (quand plusieurs individu ont été comptés, au niveau de l'échantillon)

isReferenceMeasurement - Dans le cas de plusieurs résultat de mesure au sein d'un prélèvement sur un meme individu (identifié par le numéro d'individu), cela permet de distinguer la valeur de référence (celle qu'il faudra exploiter) tout en gardant les autres mesure. Exemple : - Pour la leture d'age, plusieurs déterminations d'age sont effectuées, mais une seule est conservée.

numericalValue - valeur numérique de la mesure.
Elle est nécessairement exprimée dans l'unité associé au PSFM de la mesure.
Renseigné uniquement pour un PSFM numérique (PMFM.parameter.isQualitative=false)

alphanumericalValue -

Valeur alphanumérique de la mesure.

Attention : Utilisation à éviter. A utiliser uniquement dans des cas ou les valeurs qualitatives ne peuvent pas convenir (format non fixe, etc.).

Exemples :
* Numéros de contrat (Ventre ERS)
* Type de dimension d'engin (logbook - flux SACAPT) "2X60", "2x6 dragues 75", "13.9x2", "2x7m²", "2x17.50", "2m x 2", etc

digitCount -

Nombre de digits saisis dans la valeur numérique de la mesure.

Cela permet de stocker "10.00" (numericalvalue=10 et digitCount=2) et de pouvoir restituer la valeur sous la meme forme.

precisionValue -

Précision de la mesure. Par exemple : precisioNValue=0.5 pour indiquer une précision à + ou - "0.5".

Valeur exprimée soit dans l'unite de la mesure (ex : "mm"), soit en poucentage de la mesure (suivant la valeur de PrecisionType).

controlDate - Date du controle de la donnée. Le controle est la première phase de validation de la donnée. Exemple : - Dans Allegro, ce controle est effectué lorsque l'utilisateur a achevé sa saisie et qu'il souhaite "Terminer la saisie", dans le but de transmettre ses données au système centrale. Les controle effectué par Allegro sur le poste client sont des vérifications sur les champs obligatoires, ou encore sur la cohérence des données (cas d'un arbre d'échantillonnage).

validationDate - Date de validation de la donnée. La validation est typiquement effectué par un thématicien responsable des données. Dans Allegro, il s'agit du superviseur du portefeuille de données qui en est responsable.

qualificationDate - Date de qualification de la donnée. L'étape de qualification est liée à l'affectation d'un flag qualité (bon, mauvais, etc.) sur la donnée. - la qualification n'est pas encore gérée dans Allegro, dans le sens ou il n'existe pass encore d'interface pour affecter le flag qualité. Par défaut, le niveau de qualité est donc à "non qualifiée"

Returns:

SampleMeasurement

create

public SampleMeasurement create(Pmfm pmfm,
                       QualityFlag qualityFlag,
                       Boolean isReferenceMeasurement,
                       Sample sample)

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

Specified by:

create in interface SampleMeasurementDao

Returns:

SampleMeasurement

create

public Object create(int transform,
            Pmfm pmfm,
            QualityFlag qualityFlag,
            Boolean isReferenceMeasurement,
            Sample sample)

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

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(SampleMeasurement sampleMeasurement)

Updates the sampleMeasurement instance in the persistent store.

Specified by:

update in interface SampleMeasurementDao

update

public void update(Collection<SampleMeasurement> entities)

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

Specified by:

update in interface SampleMeasurementDao

remove

public void remove(SampleMeasurement sampleMeasurement)

Removes the instance of SampleMeasurement from the persistent store.

Specified by:

remove in interface SampleMeasurementDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface SampleMeasurementDao

remove

public void remove(Collection<SampleMeasurement> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface SampleMeasurementDao

transformEntity

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

Specified by:

transformEntity in interface SampleMeasurementDao

Parameters:

transform - one of the constants declared in SampleMeasurementDao

entity - an entity that was found

Returns:

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

See Also:

SampleMeasurementDao.transformEntity(int, SampleMeasurement)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface SampleMeasurementDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.data.measure.SampleMeasurementDao

entities - the collection of entities to transform

See Also:

SampleMeasurementDao.transformEntity(int,SampleMeasurement)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: SampleMeasurementDao

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

Specified by:

toEntities in interface SampleMeasurementDao

Parameters:

results - the query results.

See Also:

SampleMeasurementDao.toEntities(Collection)

toEntity

protected SampleMeasurement toEntity(Object[] row)

Parameters:

row -

Returns:

SampleMeasurement

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

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

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

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

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

Specified by:

search in interface SampleMeasurementDao

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