fr.ifremer.adagio.core.dao.data.operation

Interface FishingOperationDao

All Known Implementing Classes:

FishingOperationDaoBase, FishingOperationDaoImpl

public interface FishingOperationDao

Opération de peche durant laquelle un prélèvement peut etre effectué, au cours d'une sortie en mer (marée observée en mer, marée enquetée au débarquement, sortie lors d'une campagne à la mer, etc.). Il peut également s'agir d'une séquence de peche, lorsque les dates début/fin ne sont pas connus, et si la zone de peche est unique. Les dates/heures et lat/long de début/fin caractérisent le début/fin de la capture réalisée (hors temps d'établissement de l'engin). REMARQUE : les caractéristiques "indicateur jour/nuit" et "Trajectoire rectiligne ou non" sont présent à ce niveau dans Harmonie, mais gérés dans Allegro via les "cracatéristique d'utilisation du navire" (VesselUseFeatures) rattachée à l'opération parente.

See Also:

FishingOperation

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<FishingOperation>	create(Collection<FishingOperation> entities) Creates a new instance of FishingOperation and adds from the passed in entities collection
FishingOperation	create(Date fishingStartDateTime, Date fishingEndDateTime, Boolean hasCatch, String name, Short rankOrderOnPeriod, Date startDateTime, Date endDateTime, Boolean isMainOperation, LineString position, String comments, Date controlDate, Date validationDate, Date qualificationDate, String qualificationComments) Creates a new FishingOperation instance from all attributes and adds it to the persistent store.
FishingOperation	create(FishingOperation fishingOperation) Creates an instance of FishingOperation and adds it to the persistent store.
Collection<?>	create(int transform, Collection<FishingOperation> entities) Does the same thing as create(FishingOperation) with an additional flag called transform.
Object	create(int transform, Date fishingStartDateTime, Date fishingEndDateTime, Boolean hasCatch, String name, Short rankOrderOnPeriod, Date startDateTime, Date endDateTime, Boolean isMainOperation, LineString position, String comments, Date controlDate, Date validationDate, Date qualificationDate, String qualificationComments) Does the same thing as create(Date, Date, Boolean, String, Short, Date, Date, Boolean, LineString, String, Date, Date, Date, String) with an additional flag called transform.
Object	create(int transform, FishingOperation fishingOperation) Does the same thing as create(FishingOperation) with an additional flag called transform.
Object	create(int transform, QualityFlag qualityFlag, Vessel vessel) Does the same thing as #create() with an additional flag called transform.
FishingOperation	create(QualityFlag qualityFlag, Vessel vessel) Creates a new FishingOperation instance from only required properties (attributes and association ends) and adds it to the persistent store.
FishingOperation	get(Integer id) Gets an instance of FishingOperation from the persistent store.
Object	get(int transform, Integer id) Does the same thing as get(Integer) with an additional flag called transform.
FishingOperation	load(Integer id) Loads an instance of FishingOperation from the persistent store.
Object	load(int transform, Integer id) Does the same thing as load(Integer) with an additional flag called transform.
Collection<FishingOperation>	loadAll() Loads all entities of type FishingOperation.
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<FishingOperation> entities) Removes all entities in the given entities collection.
void	remove(FishingOperation fishingOperation) Removes the instance of FishingOperation from the persistent store.
void	remove(Integer id) Removes the instance of FishingOperation having the given identifier 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<FishingOperation>	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 FishingOperation 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,FishingOperation) method.
Object	transformEntity(int transform, FishingOperation 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.operation.FishingOperationDao, please note that the TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<FishingOperation> entities) Updates all instances in the entities collection in the persistent store.
void	update(FishingOperation fishingOperation) Updates the fishingOperation 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 FishingOperation 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

FishingOperation get(Integer id)

Gets an instance of FishingOperation from the persistent store.

Parameters:

id -

Returns:

FishingOperation

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

FishingOperation load(Integer id)

Loads an instance of FishingOperation from the persistent store.

Parameters:

id -

Returns:

FishingOperation

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<FishingOperation> loadAll()

Loads all entities of type FishingOperation.

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

FishingOperation create(FishingOperation fishingOperation)

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

Parameters:

fishingOperation -

Returns:

FishingOperation

create

Object create(int transform,
            FishingOperation fishingOperation)

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

fishingOperation -

Returns:

Object

create

Collection<FishingOperation> create(Collection<FishingOperation> entities)

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

Parameters:

entities - the collection of FishingOperation instances to create.

Returns:

the created instances.

create

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

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

FishingOperation create(Date fishingStartDateTime,
                      Date fishingEndDateTime,
                      Boolean hasCatch,
                      String name,
                      Short rankOrderOnPeriod,
                      Date startDateTime,
                      Date endDateTime,
                      Boolean isMainOperation,
                      LineString position,
                      String comments,
                      Date controlDate,
                      Date validationDate,
                      Date qualificationDate,
                      String qualificationComments)

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

Parameters:

fishingStartDateTime - Date/heure au début du prélèvement. Par exemple, pour le cas d'une opération avec un chalut, il s'agit la date/heure à l'établissement du chalut (le temps de descente n'est pas pris en compte).

fishingEndDateTime - Date/heure à la fin du prélèvement. Par exemple, pour le cas d'une opération avec un chalut, le temps de remontée n'est pas comptabilisé.

hasCatch - Une capture a t elle été prélevée ? Si non, il s'agit d'une opération de peche infructueuse. A priori, si une capture avec quantification différente de 0 est saisie, ou bien si des produits sont rattachés à l'opération, alors hasCatch=true (HAS_CATCH=1). Si on ne sait pas si une capture a été réalisée ou non, le champ est laissé vide. Champ utile pour les marées observées au débarquement, pour lesquelles on ne peut pas saisir systématiquement de lot capture ou bien des produits.

name - @deprecated - NE PLUS UTILISER Libellé de l'opération. REMARQUE : attribut absent des IHM. Présent pour les données historiques. Sans doute à supprimer dans l'avenir.

rankOrderOnPeriod - Rang (de présentation) de l'opération, sur la période date début/fin. ATTENTION : Lorsque plusieurs opérations sont présentes sur la meme période, cela permet de les dissocier. C'est par exemple le cas des séquences de peches (opérations agrégées en Jour/Métier/Secteur) : plusieurs opérations peuvent etre sur le meme jour (avec des engin/secteur différents), il faut donc leur attribuer un rang, pour les distinguer. Ce rang peut etre celui de la déclaration du pecheur (ordre de saisie), ou bien un ordre quelconque. Dans Allegro, ce rang sera utilisé pour ordonner ces opérations entre elles, dans les listes qui les représentent. S'il est absent, seule la date de début est utilisée pour cela.

startDateTime - Date/heure de début de l'opération

endDateTime - Date/heure de fin de l'opération

isMainOperation -

Indique s'il s'agit d'une opération ou d'un groupe d'opérations "principal".

Cela est utilisé notamment quand on ne connait que l'activité principale (le métier) d'un navire. On parle alors de métrier principal.

Généralement, cet atrribut est utilisé pour des groupes d'opérations (rankOrderOnPerod is not null), pour identifier sur la marée ou une journée de peche, le groupe d'opération portant le métier principal de la marée ou de la journée.

position - Géométrie de l'opération. Ce champ est optionnel pour etre compatible avec uDIG/geotools.

comments -

controlDate -

validationDate -

qualificationDate -

qualificationComments -

Returns:

FishingOperation

create

Object create(int transform,
            Date fishingStartDateTime,
            Date fishingEndDateTime,
            Boolean hasCatch,
            String name,
            Short rankOrderOnPeriod,
            Date startDateTime,
            Date endDateTime,
            Boolean isMainOperation,
            LineString position,
            String comments,
            Date controlDate,
            Date validationDate,
            Date qualificationDate,
            String qualificationComments)

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

fishingStartDateTime - Date/heure au début du prélèvement. Par exemple, pour le cas d'une opération avec un chalut, il s'agit la date/heure à l'établissement du chalut (le temps de descente n'est pas pris en compte).

fishingEndDateTime - Date/heure à la fin du prélèvement. Par exemple, pour le cas d'une opération avec un chalut, le temps de remontée n'est pas comptabilisé.

hasCatch - Une capture a t elle été prélevée ? Si non, il s'agit d'une opération de peche infructueuse. A priori, si une capture avec quantification différente de 0 est saisie, ou bien si des produits sont rattachés à l'opération, alors hasCatch=true (HAS_CATCH=1). Si on ne sait pas si une capture a été réalisée ou non, le champ est laissé vide. Champ utile pour les marées observées au débarquement, pour lesquelles on ne peut pas saisir systématiquement de lot capture ou bien des produits.

name - @deprecated - NE PLUS UTILISER Libellé de l'opération. REMARQUE : attribut absent des IHM. Présent pour les données historiques. Sans doute à supprimer dans l'avenir.

rankOrderOnPeriod - Rang (de présentation) de l'opération, sur la période date début/fin. ATTENTION : Lorsque plusieurs opérations sont présentes sur la meme période, cela permet de les dissocier. C'est par exemple le cas des séquences de peches (opérations agrégées en Jour/Métier/Secteur) : plusieurs opérations peuvent etre sur le meme jour (avec des engin/secteur différents), il faut donc leur attribuer un rang, pour les distinguer. Ce rang peut etre celui de la déclaration du pecheur (ordre de saisie), ou bien un ordre quelconque. Dans Allegro, ce rang sera utilisé pour ordonner ces opérations entre elles, dans les listes qui les représentent. S'il est absent, seule la date de début est utilisée pour cela.

startDateTime - Date/heure de début de l'opération

endDateTime - Date/heure de fin de l'opération

isMainOperation -

Indique s'il s'agit d'une opération ou d'un groupe d'opérations "principal".

Cela est utilisé notamment quand on ne connait que l'activité principale (le métier) d'un navire. On parle alors de métrier principal.

Généralement, cet atrribut est utilisé pour des groupes d'opérations (rankOrderOnPerod is not null), pour identifier sur la marée ou une journée de peche, le groupe d'opération portant le métier principal de la marée ou de la journée.

position - Géométrie de l'opération. Ce champ est optionnel pour etre compatible avec uDIG/geotools.

comments -

controlDate -

validationDate -

qualificationDate -

qualificationComments -

Returns:

FishingOperation

create

FishingOperation create(QualityFlag qualityFlag,
                      Vessel vessel)

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

Parameters:

qualityFlag -

vessel -

Returns:

FishingOperation

create

Object create(int transform,
            QualityFlag qualityFlag,
            Vessel vessel)

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.

qualityFlag -

vessel -

Returns:

Object

update

void update(FishingOperation fishingOperation)

Updates the fishingOperation instance in the persistent store.

Parameters:

fishingOperation -

update

void update(Collection<FishingOperation> entities)

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

Parameters:

entities -

remove

void remove(FishingOperation fishingOperation)

Removes the instance of FishingOperation from the persistent store.

Parameters:

fishingOperation -

remove

void remove(Integer id)

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

Parameters:

id -

remove

void remove(Collection<FishingOperation> 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<FishingOperation> 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,
                     FishingOperation 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.operation.FishingOperationDao, 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 FishingOperationDao

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,FishingOperation) 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.operation.FishingOperationDao

entities - the collection of entities to transform

See Also:

transformEntity(int,FishingOperation)