fr.ifremer.adagio.core.dao.data.survey.economy

Class EconomicalSurveyDaoBase

Object

HibernateDaoSupport

EconomicalSurveyDaoBase

All Implemented Interfaces:

EconomicalSurveyDao

Direct Known Subclasses:

EconomicalSurveyDaoImpl

public abstract class EconomicalSurveyDaoBase
extends HibernateDaoSupport
implements EconomicalSurveyDao

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

See Also:

EconomicalSurvey

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface EconomicalSurveyDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
EconomicalSurveyDaoBase()

Method Summary

Methods

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

EconomicalSurveyDaoBase

public EconomicalSurveyDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

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

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

Gets an instance of EconomicalSurvey from the persistent store.

Specified by:

get in interface EconomicalSurveyDao

Returns:

EconomicalSurvey

load

public Object load(int transform,
          Integer id)

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

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

Loads an instance of EconomicalSurvey from the persistent store.

Specified by:

load in interface EconomicalSurveyDao

Returns:

EconomicalSurvey

loadAll

public Collection<EconomicalSurvey> loadAll()

Loads all entities of type EconomicalSurvey.

Specified by:

loadAll in interface EconomicalSurveyDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 EconomicalSurvey create(EconomicalSurvey economicalSurvey)

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

Specified by:

create in interface EconomicalSurveyDao

Returns:

EconomicalSurvey

create

public Object create(int transform,
            EconomicalSurvey economicalSurvey)

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

Returns:

Object

create

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

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

Specified by:

create in interface EconomicalSurveyDao

Parameters:

entities - the collection of EconomicalSurvey instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public EconomicalSurvey create(String comments,
                      Date creationDate,
                      Date controlDate,
                      Date validationDate,
                      Date qualificationDate,
                      String qualificationComments,
                      Timestamp updateDate)

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

Specified by:

create in interface EconomicalSurveyDao

Returns:

EconomicalSurvey

create

public Object create(int transform,
            String comments,
            Date creationDate,
            Date controlDate,
            Date validationDate,
            Date qualificationDate,
            String qualificationComments,
            Timestamp updateDate)

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

Returns:

EconomicalSurvey

create

public EconomicalSurvey create(Date creationDate,
                      Program program,
                      QualityFlag qualityFlag,
                      Department recorderDepartment,
                      Timestamp updateDate)

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

Specified by:

create in interface EconomicalSurveyDao

Returns:

EconomicalSurvey

create

public Object create(int transform,
            Date creationDate,
            Program program,
            QualityFlag qualityFlag,
            Department recorderDepartment,
            Timestamp updateDate)

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

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(EconomicalSurvey economicalSurvey)

Updates the economicalSurvey instance in the persistent store.

Specified by:

update in interface EconomicalSurveyDao

update

public void update(Collection<EconomicalSurvey> entities)

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

Specified by:

update in interface EconomicalSurveyDao

remove

public void remove(EconomicalSurvey economicalSurvey)

Removes the instance of EconomicalSurvey from the persistent store.

Specified by:

remove in interface EconomicalSurveyDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface EconomicalSurveyDao

remove

public void remove(Collection<EconomicalSurvey> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface EconomicalSurveyDao

transformEntity

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

Specified by:

transformEntity in interface EconomicalSurveyDao

Parameters:

transform - one of the constants declared in EconomicalSurveyDao

entity - an entity that was found

Returns:

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

See Also:

EconomicalSurveyDao.transformEntity(int, EconomicalSurvey)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface EconomicalSurveyDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.data.survey.economy.EconomicalSurveyDao

entities - the collection of entities to transform

See Also:

EconomicalSurveyDao.transformEntity(int,EconomicalSurvey)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: EconomicalSurveyDao

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

Specified by:

toEntities in interface EconomicalSurveyDao

Parameters:

results - the query results.

See Also:

EconomicalSurveyDao.toEntities(Collection)

toEntity

protected EconomicalSurvey toEntity(Object[] row)

Parameters:

row -

Returns:

EconomicalSurvey

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

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

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

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

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

Specified by:

search in interface EconomicalSurveyDao

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