fr.ifremer.adagio.core.dao.referential.regulation

Class RegulationArea2RegulationLocationDaoBase

Object

HibernateDaoSupport

RegulationArea2RegulationLocationDaoBase

All Implemented Interfaces:

RegulationArea2RegulationLocationDao

Direct Known Subclasses:

RegulationArea2RegulationLocationDaoImpl

public abstract class RegulationArea2RegulationLocationDaoBase
extends HibernateDaoSupport
implements RegulationArea2RegulationLocationDao

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

See Also:

RegulationArea2RegulationLocation

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface RegulationArea2RegulationLocationDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
RegulationArea2RegulationLocationDaoBase()

Method Summary

Methods

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

RegulationArea2RegulationLocationDaoBase

public RegulationArea2RegulationLocationDaoBase()

Method Detail

get

public Object get(int transform,
         RegulationArea2RegulationLocationPK regulationArea2RegulationLocationPk)

Does the same thing as RegulationArea2RegulationLocationDao.get(RegulationArea2RegulationLocationPK) 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 RegulationArea2RegulationLocationDao

Parameters:

transform - flag to determine transformation type.

regulationArea2RegulationLocationPk - the identifier of the entity to get.

Returns:

either the entity or the object transformed from the entity.

get

public RegulationArea2RegulationLocation get(RegulationArea2RegulationLocationPK regulationArea2RegulationLocationPk)

Gets an instance of RegulationArea2RegulationLocation from the persistent store.

Specified by:

get in interface RegulationArea2RegulationLocationDao

Returns:

RegulationArea2RegulationLocation

load

public Object load(int transform,
          RegulationArea2RegulationLocationPK regulationArea2RegulationLocationPk)

Does the same thing as RegulationArea2RegulationLocationDao.load(RegulationArea2RegulationLocationPK) 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 RegulationArea2RegulationLocationDao

Parameters:

transform - flag to determine transformation type.

regulationArea2RegulationLocationPk - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

public RegulationArea2RegulationLocation load(RegulationArea2RegulationLocationPK regulationArea2RegulationLocationPk)

Loads an instance of RegulationArea2RegulationLocation from the persistent store.

Specified by:

load in interface RegulationArea2RegulationLocationDao

Returns:

RegulationArea2RegulationLocation

loadAll

public Collection<RegulationArea2RegulationLocation> loadAll()

Loads all entities of type RegulationArea2RegulationLocation.

Specified by:

loadAll in interface RegulationArea2RegulationLocationDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 RegulationArea2RegulationLocation create(RegulationArea2RegulationLocation regulationArea2RegulationLocation)

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

Specified by:

create in interface RegulationArea2RegulationLocationDao

Returns:

RegulationArea2RegulationLocation

create

public Object create(int transform,
            RegulationArea2RegulationLocation regulationArea2RegulationLocation)

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

Returns:

Object

create

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

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

Specified by:

create in interface RegulationArea2RegulationLocationDao

Parameters:

entities - the collection of RegulationArea2RegulationLocation instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public RegulationArea2RegulationLocation create(Location location,
                                       RegulationArea regulationArea)

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

Specified by:

create in interface RegulationArea2RegulationLocationDao

Returns:

RegulationArea2RegulationLocation

create

public Object create(int transform,
            Location location,
            RegulationArea regulationArea)

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 RegulationArea2RegulationLocationDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(RegulationArea2RegulationLocation regulationArea2RegulationLocation)

Updates the regulationArea2RegulationLocation instance in the persistent store.

Specified by:

update in interface RegulationArea2RegulationLocationDao

update

public void update(Collection<RegulationArea2RegulationLocation> entities)

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

Specified by:

update in interface RegulationArea2RegulationLocationDao

remove

public void remove(RegulationArea2RegulationLocation regulationArea2RegulationLocation)

Removes the instance of RegulationArea2RegulationLocation from the persistent store.

Specified by:

remove in interface RegulationArea2RegulationLocationDao

remove

public void remove(RegulationArea2RegulationLocationPK regulationArea2RegulationLocationPk)

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

Specified by:

remove in interface RegulationArea2RegulationLocationDao

remove

public void remove(Collection<RegulationArea2RegulationLocation> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface RegulationArea2RegulationLocationDao

transformEntity

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

Specified by:

transformEntity in interface RegulationArea2RegulationLocationDao

Parameters:

transform - one of the constants declared in RegulationArea2RegulationLocationDao

entity - an entity that was found

Returns:

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

See Also:

RegulationArea2RegulationLocationDao.transformEntity(int, RegulationArea2RegulationLocation)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface RegulationArea2RegulationLocationDao

Parameters:

transform - one of the constants declared in RegulationArea2RegulationLocationDao

entities - the collection of entities to transform

See Also:

RegulationArea2RegulationLocationDao.transformEntity(int,RegulationArea2RegulationLocation)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: RegulationArea2RegulationLocationDao

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

Specified by:

toEntities in interface RegulationArea2RegulationLocationDao

Parameters:

results - the query results.

See Also:

RegulationArea2RegulationLocationDao.toEntities(Collection)

toEntity

protected RegulationArea2RegulationLocation toEntity(Object[] row)

Parameters:

row -

Returns:

RegulationArea2RegulationLocation

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

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

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

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

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

Specified by:

search in interface RegulationArea2RegulationLocationDao

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