fr.ifremer.adagio.core.dao.technical.optimization.taxon

Class TaxonGroup2TaxonHierarchyDaoBase

Object

HibernateDaoSupport

TaxonGroup2TaxonHierarchyDaoBase

All Implemented Interfaces:

TaxonGroup2TaxonHierarchyDao

Direct Known Subclasses:

TaxonGroup2TaxonHierarchyDaoImpl

public abstract class TaxonGroup2TaxonHierarchyDaoBase
extends HibernateDaoSupport
implements TaxonGroup2TaxonHierarchyDao

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

See Also:

TaxonGroup2TaxonHierarchy

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface TaxonGroup2TaxonHierarchyDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
TaxonGroup2TaxonHierarchyDaoBase()

Method Summary

Methods

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

TaxonGroup2TaxonHierarchyDaoBase

public TaxonGroup2TaxonHierarchyDaoBase()

Method Detail

get

public Object get(int transform,
         TaxonGroup2TaxonHierarchyPK taxonGroup2TaxonHierarchyPk)

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

Parameters:

transform - flag to determine transformation type.

taxonGroup2TaxonHierarchyPk - the identifier of the entity to get.

Returns:

either the entity or the object transformed from the entity.

get

public TaxonGroup2TaxonHierarchy get(TaxonGroup2TaxonHierarchyPK taxonGroup2TaxonHierarchyPk)

Gets an instance of TaxonGroup2TaxonHierarchy from the persistent store.

Specified by:

get in interface TaxonGroup2TaxonHierarchyDao

Returns:

TaxonGroup2TaxonHierarchy

load

public Object load(int transform,
          TaxonGroup2TaxonHierarchyPK taxonGroup2TaxonHierarchyPk)

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

Parameters:

transform - flag to determine transformation type.

taxonGroup2TaxonHierarchyPk - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

public TaxonGroup2TaxonHierarchy load(TaxonGroup2TaxonHierarchyPK taxonGroup2TaxonHierarchyPk)

Loads an instance of TaxonGroup2TaxonHierarchy from the persistent store.

Specified by:

load in interface TaxonGroup2TaxonHierarchyDao

Returns:

TaxonGroup2TaxonHierarchy

loadAll

public Collection<TaxonGroup2TaxonHierarchy> loadAll()

Loads all entities of type TaxonGroup2TaxonHierarchy.

Specified by:

loadAll in interface TaxonGroup2TaxonHierarchyDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 TaxonGroup2TaxonHierarchy create(TaxonGroup2TaxonHierarchy taxonGroup2TaxonHierarchy)

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

Specified by:

create in interface TaxonGroup2TaxonHierarchyDao

Returns:

TaxonGroup2TaxonHierarchy

create

public Object create(int transform,
            TaxonGroup2TaxonHierarchy taxonGroup2TaxonHierarchy)

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

Returns:

Object

create

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

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

Specified by:

create in interface TaxonGroup2TaxonHierarchyDao

Parameters:

entities - the collection of TaxonGroup2TaxonHierarchy instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public TaxonGroup2TaxonHierarchy create(Date endDate,
                               Boolean isInherited)

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

Specified by:

create in interface TaxonGroup2TaxonHierarchyDao

Returns:

TaxonGroup2TaxonHierarchy

create

public Object create(int transform,
            Date endDate,
            Boolean isInherited)

Does the same thing as TaxonGroup2TaxonHierarchyDao.create(Date, Boolean) 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 TaxonGroup2TaxonHierarchyDao

Returns:

TaxonGroup2TaxonHierarchy

create

public TaxonGroup2TaxonHierarchy create(ReferenceTaxon childReferenceTaxon,
                               Boolean isInherited,
                               TaxonGroup parentTaxonGroup)

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

Specified by:

create in interface TaxonGroup2TaxonHierarchyDao

Returns:

TaxonGroup2TaxonHierarchy

create

public Object create(int transform,
            ReferenceTaxon childReferenceTaxon,
            Boolean isInherited,
            TaxonGroup parentTaxonGroup)

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

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(TaxonGroup2TaxonHierarchy taxonGroup2TaxonHierarchy)

Updates the taxonGroup2TaxonHierarchy instance in the persistent store.

Specified by:

update in interface TaxonGroup2TaxonHierarchyDao

update

public void update(Collection<TaxonGroup2TaxonHierarchy> entities)

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

Specified by:

update in interface TaxonGroup2TaxonHierarchyDao

remove

public void remove(TaxonGroup2TaxonHierarchy taxonGroup2TaxonHierarchy)

Removes the instance of TaxonGroup2TaxonHierarchy from the persistent store.

Specified by:

remove in interface TaxonGroup2TaxonHierarchyDao

remove

public void remove(TaxonGroup2TaxonHierarchyPK taxonGroup2TaxonHierarchyPk)

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

Specified by:

remove in interface TaxonGroup2TaxonHierarchyDao

remove

public void remove(Collection<TaxonGroup2TaxonHierarchy> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface TaxonGroup2TaxonHierarchyDao

transformEntity

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

Specified by:

transformEntity in interface TaxonGroup2TaxonHierarchyDao

Parameters:

transform - one of the constants declared in TaxonGroup2TaxonHierarchyDao

entity - an entity that was found

Returns:

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

See Also:

TaxonGroup2TaxonHierarchyDao.transformEntity(int, TaxonGroup2TaxonHierarchy)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface TaxonGroup2TaxonHierarchyDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.technical.optimization.taxon.TaxonGroup2TaxonHierarchyDao

entities - the collection of entities to transform

See Also:

TaxonGroup2TaxonHierarchyDao.transformEntity(int,TaxonGroup2TaxonHierarchy)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: TaxonGroup2TaxonHierarchyDao

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

Specified by:

toEntities in interface TaxonGroup2TaxonHierarchyDao

Parameters:

results - the query results.

See Also:

TaxonGroup2TaxonHierarchyDao.toEntities(Collection)

toEntity

protected TaxonGroup2TaxonHierarchy toEntity(Object[] row)

Parameters:

row -

Returns:

TaxonGroup2TaxonHierarchy

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

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

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

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

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

Specified by:

search in interface TaxonGroup2TaxonHierarchyDao

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