fr.ifremer.adagio.core.dao.referential.gear

Class FishingGearDaoBase

Object

HibernateDaoSupport

FishingGearDaoBase

All Implemented Interfaces:

FishingGearDao

Direct Known Subclasses:

FishingGearDaoImpl

public abstract class FishingGearDaoBase
extends HibernateDaoSupport
implements FishingGearDao

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

See Also:

FishingGear

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface FishingGearDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
FishingGearDaoBase()

Method Summary

Methods

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

FishingGearDaoBase

public FishingGearDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

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

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

Gets an instance of FishingGear from the persistent store.

Specified by:

get in interface FishingGearDao

Returns:

FishingGear

load

public Object load(int transform,
          Integer id)

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

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

Loads an instance of FishingGear from the persistent store.

Specified by:

load in interface FishingGearDao

Returns:

FishingGear

loadAll

public Collection<FishingGear> loadAll()

Loads all entities of type FishingGear.

Specified by:

loadAll in interface FishingGearDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 FishingGear create(FishingGear fishingGear)

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

Specified by:

create in interface FishingGearDao

Returns:

FishingGear

create

public Object create(int transform,
            FishingGear fishingGear)

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

Returns:

Object

create

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

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

Specified by:

create in interface FishingGearDao

Parameters:

entities - the collection of FishingGear instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public FishingGear create(Boolean isActive,
                 Boolean isTowed,
                 String label,
                 String name,
                 String description,
                 Timestamp updateDate,
                 String comments)

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

Specified by:

create in interface FishingGearDao

Parameters:

isActive - Indique si le type d'engin est active (=vrai) ou passif (=faux). - Actif : l'engin se déplace pour capturer l'espèce recherchée.
- Passif : l'engin attend que la cible se prenne dedans.

isTowed -

Indique si le type d'engin est trainant (=vrai) ou dormant (=faux)

Actuellement, isTowed (à défaut d'autre champ libre) a été rempli pour permettre son utilisation dans Allegro avec le sens suivant : « autorise ou non la superposition d'opérations de pêche simultanées ».

• is_towed=1 => l'opération utilisant cet engin ne peut pas être superposée avec d'autres opérations ayant aussi un engin is_towed=1
• is_towed=0 => superposition avec d'autres opérations possibles (quelques soit la valeur is_towed de leur engin)

Le réel concept sous-jacente, plus stricte

thématiquement ("trainant / dormant ou engin fixe / engin mobile"), est reportée à plus tard.

label - Mnémonique (ou code) de l'engin. Le mnémonique doit être unique pour une meme classification d'engin. Par exemple : - Pour la classification FAO/CSITEP : label='OTB'

name - Libellé de l'engin. il s'agit du libellé "officiel" de la classification. note : ce libellé peut etre régionalisé via "GearLocation".

Returns:

FishingGear

create

public Object create(int transform,
            Boolean isActive,
            Boolean isTowed,
            String label,
            String name,
            String description,
            Timestamp updateDate,
            String comments)

Does the same thing as FishingGearDao.create(Boolean, Boolean, String, String, String, Timestamp, 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 FishingGearDao

isActive - Indique si le type d'engin est active (=vrai) ou passif (=faux). - Actif : l'engin se déplace pour capturer l'espèce recherchée.
- Passif : l'engin attend que la cible se prenne dedans.

isTowed -

Indique si le type d'engin est trainant (=vrai) ou dormant (=faux)

Actuellement, isTowed (à défaut d'autre champ libre) a été rempli pour permettre son utilisation dans Allegro avec le sens suivant : « autorise ou non la superposition d'opérations de pêche simultanées ».

• is_towed=1 => l'opération utilisant cet engin ne peut pas être superposée avec d'autres opérations ayant aussi un engin is_towed=1
• is_towed=0 => superposition avec d'autres opérations possibles (quelques soit la valeur is_towed de leur engin)

Le réel concept sous-jacente, plus stricte

thématiquement ("trainant / dormant ou engin fixe / engin mobile"), est reportée à plus tard.

label - Mnémonique (ou code) de l'engin. Le mnémonique doit être unique pour une meme classification d'engin. Par exemple : - Pour la classification FAO/CSITEP : label='OTB'

name - Libellé de l'engin. il s'agit du libellé "officiel" de la classification. note : ce libellé peut etre régionalisé via "GearLocation".

Returns:

FishingGear

create

public FishingGear create(GearClassification gearClassification,
                 String label,
                 String name,
                 Status status,
                 Timestamp updateDate,
                 ValidityStatus validityStatus)

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

Specified by:

create in interface FishingGearDao

Returns:

FishingGear

create

public Object create(int transform,
            GearClassification gearClassification,
            String label,
            String name,
            Status status,
            Timestamp updateDate,
            ValidityStatus validityStatus)

Does the same thing as #create(String, String, Timestamp) 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 FishingGearDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(FishingGear fishingGear)

Updates the fishingGear instance in the persistent store.

Specified by:

update in interface FishingGearDao

update

public void update(Collection<FishingGear> entities)

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

Specified by:

update in interface FishingGearDao

remove

public void remove(FishingGear fishingGear)

Removes the instance of FishingGear from the persistent store.

Specified by:

remove in interface FishingGearDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface FishingGearDao

remove

public void remove(Collection<FishingGear> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface FishingGearDao

transformEntity

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

Specified by:

transformEntity in interface FishingGearDao

Parameters:

transform - one of the constants declared in FishingGearDao

entity - an entity that was found

Returns:

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

See Also:

FishingGearDao.transformEntity(int, FishingGear)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface FishingGearDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.referential.gear.FishingGearDao

entities - the collection of entities to transform

See Also:

FishingGearDao.transformEntity(int,FishingGear)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: FishingGearDao

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

Specified by:

toEntities in interface FishingGearDao

Parameters:

results - the query results.

See Also:

FishingGearDao.toEntities(Collection)

toEntity

protected FishingGear toEntity(Object[] row)

Parameters:

row -

Returns:

FishingGear

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

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

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

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

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

Specified by:

search in interface FishingGearDao

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