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

Class FishingOperationDaoBase

Object

HibernateDaoSupport

FishingOperationDaoBase

All Implemented Interfaces:

FishingOperationDao

Direct Known Subclasses:

FishingOperationDaoImpl

public abstract class FishingOperationDaoBase
extends HibernateDaoSupport
implements FishingOperationDao

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

See Also:

FishingOperation

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface FishingOperationDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
FishingOperationDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateFirstResult(int pageNumber, int pageSize) firstResult = (pageNumber - 1) * pageSize
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 FishingOperationDao.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 FishingOperationDao.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 FishingOperationDao.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 FishingOperationDao.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.
FishingOperation	load(Integer id) Loads an instance of FishingOperation from the persistent store.
Object	load(int transform, Integer id) Does the same thing as FishingOperationDao.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 FishingOperationDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as FishingOperationDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as FishingOperationDao.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 FishingOperationDao.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 FishingOperationDao.search(Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as FishingOperationDao.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).
protected FishingOperation	toEntity(Object[] row)
void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the FishingOperationDao.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 FishingOperationDao, please note that the FishingOperationDao.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.

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

FishingOperationDaoBase

public FishingOperationDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

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

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

Gets an instance of FishingOperation from the persistent store.

Specified by:

get in interface FishingOperationDao

Returns:

FishingOperation

load

public Object load(int transform,
          Integer id)

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

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

Loads an instance of FishingOperation from the persistent store.

Specified by:

load in interface FishingOperationDao

Returns:

FishingOperation

loadAll

public Collection<FishingOperation> loadAll()

Loads all entities of type FishingOperation.

Specified by:

loadAll in interface FishingOperationDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 FishingOperation create(FishingOperation fishingOperation)

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

Specified by:

create in interface FishingOperationDao

Returns:

FishingOperation

create

public Object create(int transform,
            FishingOperation fishingOperation)

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

Specified by:

create in interface FishingOperationDao

Returns:

Object

create

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

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

Specified by:

create in interface FishingOperationDao

Parameters:

entities - the collection of FishingOperation instances to create.

Returns:

the created instances.

create

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

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

Specified by:

create in interface FishingOperationDao

Returns:

Collection

create

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

Specified by:

create in interface FishingOperationDao

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.

Returns:

FishingOperation

create

public 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 FishingOperationDao.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.

Specified by:

create in interface FishingOperationDao

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.

Returns:

FishingOperation

create

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

Specified by:

create in interface FishingOperationDao

Returns:

FishingOperation

create

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

Specified by:

create in interface FishingOperationDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(FishingOperation fishingOperation)

Updates the fishingOperation instance in the persistent store.

Specified by:

update in interface FishingOperationDao

update

public void update(Collection<FishingOperation> entities)

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

Specified by:

update in interface FishingOperationDao

remove

public void remove(FishingOperation fishingOperation)

Removes the instance of FishingOperation from the persistent store.

Specified by:

remove in interface FishingOperationDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface FishingOperationDao

remove

public void remove(Collection<FishingOperation> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface FishingOperationDao

transformEntity

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

Specified by:

transformEntity in interface FishingOperationDao

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:

FishingOperationDao.transformEntity(int, FishingOperation)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface FishingOperationDao

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:

FishingOperationDao.transformEntity(int,FishingOperation)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: FishingOperationDao

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

Specified by:

toEntities in interface FishingOperationDao

Parameters:

results - the query results.

See Also:

FishingOperationDao.toEntities(Collection)

toEntity

protected FishingOperation toEntity(Object[] row)

Parameters:

row -

Returns:

FishingOperation

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

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

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

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

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

Specified by:

search in interface FishingOperationDao

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