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

Interface QuantificationMeasurementDao

All Known Implementing Classes:

QuantificationMeasurementDaoBase, QuantificationMeasurementDaoImpl

public interface QuantificationMeasurementDao

Résultat de mesure de quantification d'un lot. Les mesures de quantification portent sur le paramètre "Poids". Elle peuvent être obtenue par différentes méthodes : - mesuré (ex : par une règle ou Ichtyomètre), - estimé (ex : jugement par un expert), - calculé par une relation taille/poids - calculé à partir de volumes (nombre d'unité de volume x Poids d'une unité de volume). Il s'agit donc d'un poids estimé, mais par le volume. - déclaré (cf SACROIS/RIC2)

See Also:

QuantificationMeasurement

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRANSFORM_NONE This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

Method Summary

Methods

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

Field Detail

TRANSFORM_NONE

static final int TRANSFORM_NONE

This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes no transformation will occur.

See Also:

Constant Field Values

Method Detail

toEntities

void toEntities(Collection<?> results)

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

Parameters:

results - the query results.

get

QuantificationMeasurement get(Integer id)

Gets an instance of QuantificationMeasurement from the persistent store.

Parameters:

id -

Returns:

QuantificationMeasurement

get

Object get(int transform,
         Integer id)

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

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.

load

QuantificationMeasurement load(Integer id)

Loads an instance of QuantificationMeasurement from the persistent store.

Parameters:

id -

Returns:

QuantificationMeasurement

load

Object load(int transform,
          Integer id)

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

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.

loadAll

Collection<QuantificationMeasurement> loadAll()

Loads all entities of type QuantificationMeasurement.

Returns:

the loaded entities.

loadAll

Collection<?> loadAll(int transform)

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

loadAll

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

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

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

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

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

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.

create

QuantificationMeasurement create(QuantificationMeasurement quantificationMeasurement)

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

Parameters:

quantificationMeasurement -

Returns:

QuantificationMeasurement

create

Object create(int transform,
            QuantificationMeasurement quantificationMeasurement)

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

Parameters:

transform -

quantificationMeasurement -

Returns:

Object

create

Collection<QuantificationMeasurement> create(Collection<QuantificationMeasurement> entities)

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

Parameters:

entities - the collection of QuantificationMeasurement instances to create.

Returns:

the created instances.

create

Collection<?> create(int transform,
                   Collection<QuantificationMeasurement> entities)

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

Parameters:

transform -

entities -

Returns:

Collection

create

QuantificationMeasurement create(Short subgroupNumber,
                               Boolean isReferenceQuantification,
                               Float numericalValue,
                               String alphanumericalValue,
                               Integer digitCount,
                               Float precisionValue,
                               Date controlDate,
                               Date validationDate,
                               Date qualificationDate,
                               String qualificationComments)

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

Parameters:

subgroupNumber - Numéro du sous ensemble sur lequel porte la mesure de quantification. Si non renseigné, le mesure porte sur tout le lot rattaché.Une quantification d'un lot peut faire intervenir plusieurs sous-ensemble sur lequel des mesures sont éffectuées. Par exemple, plusieurs sous-ensembles peuvent être quantifié par pesée, chaque mesure est donc rattaché à un sous-ensemmble, via le numéro de sous ensemble.

isReferenceQuantification - S'agit t il de la mesure de référence pour la quantification du lot ? Par défaut, le poids calculé (par relation taille/poids) est le poids de référence. Doit etre NULL si subgroupNumber est NULL (un poids de référence ne peut pas porter sur une sous-ensemble du lot , mais sur tout le lot)

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"

qualificationComments -

Returns:

QuantificationMeasurement

create

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

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

Parameters:

transform -

subgroupNumber - Numéro du sous ensemble sur lequel porte la mesure de quantification. Si non renseigné, le mesure porte sur tout le lot rattaché.Une quantification d'un lot peut faire intervenir plusieurs sous-ensemble sur lequel des mesures sont éffectuées. Par exemple, plusieurs sous-ensembles peuvent être quantifié par pesée, chaque mesure est donc rattaché à un sous-ensemmble, via le numéro de sous ensemble.

isReferenceQuantification - S'agit t il de la mesure de référence pour la quantification du lot ? Par défaut, le poids calculé (par relation taille/poids) est le poids de référence. Doit etre NULL si subgroupNumber est NULL (un poids de référence ne peut pas porter sur une sous-ensemble du lot , mais sur tout le lot)

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"

qualificationComments -

Returns:

QuantificationMeasurement

create

QuantificationMeasurement create(Pmfm pmfm,
                               QualityFlag qualityFlag,
                               Batch batch)

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

Parameters:

pmfm -

qualityFlag -

batch -

Returns:

QuantificationMeasurement

create

Object create(int transform,
            Pmfm pmfm,
            QualityFlag qualityFlag,
            Batch batch)

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

Parameters:

transform - flag to determine transformation type.

pmfm -

qualityFlag -

batch -

Returns:

Object

update

void update(QuantificationMeasurement quantificationMeasurement)

Updates the quantificationMeasurement instance in the persistent store.

Parameters:

quantificationMeasurement -

update

void update(Collection<QuantificationMeasurement> entities)

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

Parameters:

entities -

remove

void remove(QuantificationMeasurement quantificationMeasurement)

Removes the instance of QuantificationMeasurement from the persistent store.

Parameters:

quantificationMeasurement -

remove

void remove(Integer id)

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

Parameters:

id -

remove

void remove(Collection<QuantificationMeasurement> entities)

Removes all entities in the given entities collection.

Parameters:

entities -

search

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

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

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

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

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

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

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

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

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

Set<QuantificationMeasurement> search(Search search)

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

Parameters:

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

Returns:

any found results from the search.

transformEntity

Object transformEntity(int transform,
                     QuantificationMeasurement 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 fr.ifremer.adagio.core.dao.data.measure.QuantificationMeasurementDao, please note that the TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown TRANSFORM_NONE is assumed.

Parameters:

transform - one of the constants declared in QuantificationMeasurementDao

entity - an entity that was found

Returns:

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

See Also:

transformEntities(int,Collection)

transformEntities

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

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

This method is to be used internally only.

Parameters:

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

entities - the collection of entities to transform

See Also:

transformEntity(int,QuantificationMeasurement)