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

Class LocationHierarchyDaoBase

Object

HibernateDaoSupport

LocationHierarchyDaoBase

All Implemented Interfaces:

LocationHierarchyDao

Direct Known Subclasses:

LocationHierarchyDaoImpl

public abstract class LocationHierarchyDaoBase
extends HibernateDaoSupport
implements LocationHierarchyDao

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

See Also:

LocationHierarchy

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface LocationHierarchyDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
LocationHierarchyDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateFirstResult(int pageNumber, int pageSize) firstResult = (pageNumber - 1) * pageSize
Collection<LocationHierarchy>	create(Collection<LocationHierarchy> entities) Creates a new instance of LocationHierarchy and adds from the passed in entities collection
LocationHierarchy	create(Float childSurfaceRatio, Boolean isMainAssociation) Creates a new LocationHierarchy instance from all attributes and adds it to the persistent store.
LocationHierarchy	create(Float childSurfaceRatio, Boolean isMainAssociation, Location location, Location parent) Creates a new LocationHierarchy instance from only required properties (attributes and association ends) and adds it to the persistent store.
Collection<?>	create(int transform, Collection<LocationHierarchy> entities) Does the same thing as LocationHierarchyDao.create(LocationHierarchy) with an additional flag called transform.
Object	create(int transform, Float childSurfaceRatio, Boolean isMainAssociation) Does the same thing as LocationHierarchyDao.create(Float, Boolean) with an additional flag called transform.
Object	create(int transform, Float childSurfaceRatio, Boolean isMainAssociation, Location location, Location parent) Does the same thing as LocationHierarchyDao.create(Float, Boolean) with an additional flag called transform.
Object	create(int transform, LocationHierarchy locationHierarchy) Does the same thing as LocationHierarchyDao.create(LocationHierarchy) with an additional flag called transform.
LocationHierarchy	create(LocationHierarchy locationHierarchy) Creates an instance of LocationHierarchy and adds it to the persistent store.
Collection	findLocationHierarchiesByFatherId(Integer fatherId)
Collection	findLocationHierarchiesById(Integer id)
LocationHierarchy	findLocationHierarchyByIdentifiers(Integer id, Integer fatherId)
Object	get(int transform, LocationHierarchyPK locationHierarchyPk) Does the same thing as LocationHierarchyDao.get(LocationHierarchyPK) with an additional flag called transform.
LocationHierarchy	get(LocationHierarchyPK locationHierarchyPk) Gets an instance of LocationHierarchy 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.
protected abstract Collection<?>	handleFindLocationHierarchiesByFatherId(Integer fatherId) Performs the core logic for findLocationHierarchiesByFatherId(Integer)
protected abstract Collection<?>	handleFindLocationHierarchiesById(Integer id) Performs the core logic for findLocationHierarchiesById(Integer)
protected abstract LocationHierarchy	handleFindLocationHierarchyByIdentifiers(Integer id, Integer fatherId) Performs the core logic for findLocationHierarchyByIdentifiers(Integer, Integer)
Object	load(int transform, LocationHierarchyPK locationHierarchyPk) Does the same thing as LocationHierarchyDao.load(LocationHierarchyPK) with an additional flag called transform.
LocationHierarchy	load(LocationHierarchyPK locationHierarchyPk) Loads an instance of LocationHierarchy from the persistent store.
Collection<LocationHierarchy>	loadAll() Loads all entities of type LocationHierarchy.
Collection<?>	loadAll(int transform) Does the same thing as LocationHierarchyDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as LocationHierarchyDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as LocationHierarchyDao.loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Collection<LocationHierarchy> entities) Removes all entities in the given entities collection.
void	remove(LocationHierarchy locationHierarchy) Removes the instance of LocationHierarchy from the persistent store.
void	remove(LocationHierarchyPK locationHierarchyPk) Removes the instance of LocationHierarchy having the given identifier from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as LocationHierarchyDao.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 LocationHierarchyDao.search(Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as LocationHierarchyDao.search(Search) but with an additional flag called transform.
Set<LocationHierarchy>	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 LocationHierarchy instances (this is useful when the returned results contains a row of data and you want just entities only).
protected LocationHierarchy	toEntity(Object[] row)
void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the LocationHierarchyDao.transformEntity(int,LocationHierarchy) method.
Object	transformEntity(int transform, LocationHierarchy 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 LocationHierarchyDao, please note that the LocationHierarchyDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<LocationHierarchy> entities) Updates all instances in the entities collection in the persistent store.
void	update(LocationHierarchy locationHierarchy) Updates the locationHierarchy 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

LocationHierarchyDaoBase

public LocationHierarchyDaoBase()

Method Detail

get

public Object get(int transform,
         LocationHierarchyPK locationHierarchyPk)

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

Parameters:

transform - flag to determine transformation type.

locationHierarchyPk - the identifier of the entity to get.

Returns:

either the entity or the object transformed from the entity.

get

public LocationHierarchy get(LocationHierarchyPK locationHierarchyPk)

Gets an instance of LocationHierarchy from the persistent store.

Specified by:

get in interface LocationHierarchyDao

Returns:

LocationHierarchy

load

public Object load(int transform,
          LocationHierarchyPK locationHierarchyPk)

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

Parameters:

transform - flag to determine transformation type.

locationHierarchyPk - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

public LocationHierarchy load(LocationHierarchyPK locationHierarchyPk)

Loads an instance of LocationHierarchy from the persistent store.

Specified by:

load in interface LocationHierarchyDao

Returns:

LocationHierarchy

loadAll

public Collection<LocationHierarchy> loadAll()

Loads all entities of type LocationHierarchy.

Specified by:

loadAll in interface LocationHierarchyDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 LocationHierarchy create(LocationHierarchy locationHierarchy)

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

Specified by:

create in interface LocationHierarchyDao

Returns:

LocationHierarchy

create

public Object create(int transform,
            LocationHierarchy locationHierarchy)

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

Returns:

Object

create

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

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

Specified by:

create in interface LocationHierarchyDao

Parameters:

entities - the collection of LocationHierarchy instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public LocationHierarchy create(Float childSurfaceRatio,
                       Boolean isMainAssociation)

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

Specified by:

create in interface LocationHierarchyDao

Parameters:

childSurfaceRatio - Ratio de couverture (en surface) du lieu fils par rapport au lieu père. La valeur doit etre supérieure strictement à 0 et inférieur ou égale à 1. Déduit à partir de la valeur de LocationAssociation.childSurfaceRatio, selon un algorithme de parcours d'arbre (cf procedure stockée P_FILL_LOCATION_HIERARCHY)

isMainAssociation -

Indique si l'association est considérée comme la principale.

Dans le cas d'une zone en mer rattachée à plusieurs zones parente, cela permet de de récupérer qu'une seule zone (utiliser notamment pour le SIG SIH)

Returns:

LocationHierarchy

create

public Object create(int transform,
            Float childSurfaceRatio,
            Boolean isMainAssociation)

Does the same thing as LocationHierarchyDao.create(Float, 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 LocationHierarchyDao

childSurfaceRatio - Ratio de couverture (en surface) du lieu fils par rapport au lieu père. La valeur doit etre supérieure strictement à 0 et inférieur ou égale à 1. Déduit à partir de la valeur de LocationAssociation.childSurfaceRatio, selon un algorithme de parcours d'arbre (cf procedure stockée P_FILL_LOCATION_HIERARCHY)

isMainAssociation -

Indique si l'association est considérée comme la principale.

Dans le cas d'une zone en mer rattachée à plusieurs zones parente, cela permet de de récupérer qu'une seule zone (utiliser notamment pour le SIG SIH)

Returns:

LocationHierarchy

create

public LocationHierarchy create(Float childSurfaceRatio,
                       Boolean isMainAssociation,
                       Location location,
                       Location parent)

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

Specified by:

create in interface LocationHierarchyDao

Returns:

LocationHierarchy

create

public Object create(int transform,
            Float childSurfaceRatio,
            Boolean isMainAssociation,
            Location location,
            Location parent)

Does the same thing as LocationHierarchyDao.create(Float, 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 LocationHierarchyDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(LocationHierarchy locationHierarchy)

Updates the locationHierarchy instance in the persistent store.

Specified by:

update in interface LocationHierarchyDao

update

public void update(Collection<LocationHierarchy> entities)

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

Specified by:

update in interface LocationHierarchyDao

remove

public void remove(LocationHierarchy locationHierarchy)

Removes the instance of LocationHierarchy from the persistent store.

Specified by:

remove in interface LocationHierarchyDao

remove

public void remove(LocationHierarchyPK locationHierarchyPk)

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

Specified by:

remove in interface LocationHierarchyDao

remove

public void remove(Collection<LocationHierarchy> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface LocationHierarchyDao

findLocationHierarchyByIdentifiers

public LocationHierarchy findLocationHierarchyByIdentifiers(Integer id,
                                                   Integer fatherId)

Specified by:

findLocationHierarchyByIdentifiers in interface LocationHierarchyDao

Returns:

LocationHierarchy

handleFindLocationHierarchyByIdentifiers

protected abstract LocationHierarchy handleFindLocationHierarchyByIdentifiers(Integer id,
                                                         Integer fatherId)
                                                                       throws Exception

Performs the core logic for findLocationHierarchyByIdentifiers(Integer, Integer)

Parameters:

id -

fatherId -

Returns:

LocationHierarchy

Throws:

Exception

findLocationHierarchiesById

public Collection findLocationHierarchiesById(Integer id)

Specified by:

findLocationHierarchiesById in interface LocationHierarchyDao

Returns:

Collection

handleFindLocationHierarchiesById

protected abstract Collection<?> handleFindLocationHierarchiesById(Integer id)
                                                            throws Exception

Performs the core logic for findLocationHierarchiesById(Integer)

Parameters:

id -

Returns:

Collection

Throws:

Exception

findLocationHierarchiesByFatherId

public Collection findLocationHierarchiesByFatherId(Integer fatherId)

Specified by:

findLocationHierarchiesByFatherId in interface LocationHierarchyDao

Returns:

Collection

handleFindLocationHierarchiesByFatherId

protected abstract Collection<?> handleFindLocationHierarchiesByFatherId(Integer fatherId)
                                                                  throws Exception

Performs the core logic for findLocationHierarchiesByFatherId(Integer)

Parameters:

fatherId -

Returns:

Collection

Throws:

Exception

transformEntity

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

Specified by:

transformEntity in interface LocationHierarchyDao

Parameters:

transform - one of the constants declared in LocationHierarchyDao

entity - an entity that was found

Returns:

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

See Also:

LocationHierarchyDao.transformEntity(int, LocationHierarchy)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface LocationHierarchyDao

Parameters:

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

entities - the collection of entities to transform

See Also:

LocationHierarchyDao.transformEntity(int,LocationHierarchy)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: LocationHierarchyDao

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

Specified by:

toEntities in interface LocationHierarchyDao

Parameters:

results - the query results.

See Also:

LocationHierarchyDao.toEntities(Collection)

toEntity

protected LocationHierarchy toEntity(Object[] row)

Parameters:

row -

Returns:

LocationHierarchy

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

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

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

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

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

Specified by:

search in interface LocationHierarchyDao

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