fr.ifremer.adagio.core.dao.data.samplingScheme

Class SamplingStrataDaoBase

Object

HibernateDaoSupport

SamplingStrataDaoBase

All Implemented Interfaces:

SamplingStrataDao

Direct Known Subclasses:

SamplingStrataDaoImpl

public abstract class SamplingStrataDaoBase
extends HibernateDaoSupport
implements SamplingStrataDao

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

See Also:

SamplingStrata

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface SamplingStrataDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
SamplingStrataDaoBase()

Method Summary

Methods

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

SamplingStrataDaoBase

public SamplingStrataDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

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

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

Gets an instance of SamplingStrata from the persistent store.

Specified by:

get in interface SamplingStrataDao

Returns:

SamplingStrata

load

public Object load(int transform,
          Integer id)

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

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

Loads an instance of SamplingStrata from the persistent store.

Specified by:

load in interface SamplingStrataDao

Returns:

SamplingStrata

loadAll

public Collection<SamplingStrata> loadAll()

Loads all entities of type SamplingStrata.

Specified by:

loadAll in interface SamplingStrataDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 SamplingStrata create(SamplingStrata samplingStrata)

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

Specified by:

create in interface SamplingStrataDao

Returns:

SamplingStrata

create

public Object create(int transform,
            SamplingStrata samplingStrata)

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

Returns:

Object

create

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

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

Specified by:

create in interface SamplingStrataDao

Parameters:

entities - the collection of SamplingStrata instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public SamplingStrata create(String label,
                    Date startDate,
                    Date endDate,
                    String description,
                    String comments,
                    Timestamp updateDate)

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

Specified by:

create in interface SamplingStrataDao

Parameters:

label - Mnémonique de la ligne du plan. Ce mnémonique doit être unique en base (clef naturelle) pour tout les plans d'échantillonnage de la base de données, car il s'agit d'un code fréquemment utilisé pour identifier une ligne de plan.

description - Nom de la strate. Dans WAO : METIER_LIBELLE "Chalutage hauturier à démerseaux à grand fond" TODO : à renommer en "name" ?

comments - Commentaires sur la strate. Dans WAO : PLAN_COMMENT

Returns:

SamplingStrata

create

public Object create(int transform,
            String label,
            Date startDate,
            Date endDate,
            String description,
            String comments,
            Timestamp updateDate)

Does the same thing as SamplingStrataDao.create(String, Date, Date, 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 SamplingStrataDao

label - Mnémonique de la ligne du plan. Ce mnémonique doit être unique en base (clef naturelle) pour tout les plans d'échantillonnage de la base de données, car il s'agit d'un code fréquemment utilisé pour identifier une ligne de plan.

description - Nom de la strate. Dans WAO : METIER_LIBELLE "Chalutage hauturier à démerseaux à grand fond" TODO : à renommer en "name" ?

comments - Commentaires sur la strate. Dans WAO : PLAN_COMMENT

Returns:

SamplingStrata

create

public SamplingStrata create(String label,
                    SamplingScheme samplingScheme,
                    Timestamp updateDate)

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

Specified by:

create in interface SamplingStrataDao

Returns:

SamplingStrata

create

public Object create(int transform,
            String label,
            SamplingScheme samplingScheme,
            Timestamp updateDate)

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

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(SamplingStrata samplingStrata)

Updates the samplingStrata instance in the persistent store.

Specified by:

update in interface SamplingStrataDao

update

public void update(Collection<SamplingStrata> entities)

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

Specified by:

update in interface SamplingStrataDao

remove

public void remove(SamplingStrata samplingStrata)

Removes the instance of SamplingStrata from the persistent store.

Specified by:

remove in interface SamplingStrataDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface SamplingStrataDao

remove

public void remove(Collection<SamplingStrata> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface SamplingStrataDao

transformEntity

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

Specified by:

transformEntity in interface SamplingStrataDao

Parameters:

transform - one of the constants declared in SamplingStrataDao

entity - an entity that was found

Returns:

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

See Also:

SamplingStrataDao.transformEntity(int, SamplingStrata)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface SamplingStrataDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.data.samplingScheme.SamplingStrataDao

entities - the collection of entities to transform

See Also:

SamplingStrataDao.transformEntity(int,SamplingStrata)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: SamplingStrataDao

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

Specified by:

toEntities in interface SamplingStrataDao

Parameters:

results - the query results.

See Also:

SamplingStrataDao.toEntities(Collection)

toEntity

protected SamplingStrata toEntity(Object[] row)

Parameters:

row -

Returns:

SamplingStrata

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

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

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

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

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

Specified by:

search in interface SamplingStrataDao

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