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

Class OperationDaoBase

Object

HibernateDaoSupport

OperationDaoBase

All Implemented Interfaces:

OperationDao

Direct Known Subclasses:

OperationDaoImpl

public abstract class OperationDaoBase
extends HibernateDaoSupport
implements OperationDao

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

See Also:

Operation

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface OperationDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
OperationDaoBase()

Method Summary

Methods

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

OperationDaoBase

public OperationDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

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

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

Gets an instance of Operation from the persistent store.

Specified by:

get in interface OperationDao

Returns:

Operation

load

public Object load(int transform,
          Integer id)

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

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

Loads an instance of Operation from the persistent store.

Specified by:

load in interface OperationDao

Returns:

Operation

loadAll

public Collection<Operation> loadAll()

Loads all entities of type Operation.

Specified by:

loadAll in interface OperationDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 Operation create(Operation operation)

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

Specified by:

create in interface OperationDao

Returns:

Operation

create

public Object create(int transform,
            Operation operation)

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

Returns:

Object

create

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

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

Specified by:

create in interface OperationDao

Parameters:

entities - the collection of Operation instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public Operation create(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 Operation instance from all attributes and adds it to the persistent store.

Specified by:

create in interface OperationDao

Parameters:

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:

Operation

create

public Object create(int transform,
            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 OperationDao.create(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 OperationDao

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:

Operation

create

public Operation create(QualityFlag qualityFlag,
               Vessel vessel)

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

Specified by:

create in interface OperationDao

Returns:

Operation

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 OperationDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(Operation operation)

Updates the operation instance in the persistent store.

Specified by:

update in interface OperationDao

update

public void update(Collection<Operation> entities)

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

Specified by:

update in interface OperationDao

remove

public void remove(Operation operation)

Removes the instance of Operation from the persistent store.

Specified by:

remove in interface OperationDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface OperationDao

remove

public void remove(Collection<Operation> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface OperationDao

transformEntity

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

Specified by:

transformEntity in interface OperationDao

Parameters:

transform - one of the constants declared in OperationDao

entity - an entity that was found

Returns:

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

See Also:

OperationDao.transformEntity(int, Operation)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface OperationDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.data.operation.OperationDao

entities - the collection of entities to transform

See Also:

OperationDao.transformEntity(int,Operation)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: OperationDao

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

Specified by:

toEntities in interface OperationDao

Parameters:

results - the query results.

See Also:

OperationDao.toEntities(Collection)

toEntity

protected Operation toEntity(Object[] row)

Parameters:

row -

Returns:

Operation

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

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

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

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

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

Specified by:

search in interface OperationDao

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