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

Class LocationHierarchyDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

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

All Implemented Interfaces:

LocationHierarchyDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

LocationHierarchyDaoImpl

public abstract class LocationHierarchyDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements LocationHierarchyDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy.

See Also:

LocationHierarchy

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchyDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
LocationHierarchyDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<LocationHierarchy>	create(Collection<LocationHierarchy> entities) Creates a new instance of fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy and adds from the passed in entities collection
LocationHierarchy	create(Float childSurfaceRatio, Boolean isMainAssociation, Location parent, Location location) Creates a new fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy instance from all attributes and properties and adds it to the persistent store.
Collection<?>	create(int transform, Collection<LocationHierarchy> entities) Does the same thing as LocationHierarchyDao.create(fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy) with an additional flag called transform.
Object	create(int transform, Float childSurfaceRatio, Boolean isMainAssociation, Location parent, Location location) Does the same thing as LocationHierarchyDao.create(java.lang.Float,java.lang.Boolean,fr.ifremer.adagio.core.dao.referential.location.Location,fr.ifremer.adagio.core.dao.referential.location.Location) with an additional flag called transform.
Object	create(int transform, LocationHierarchy locationHierarchy) Does the same thing as LocationHierarchyDao.create(fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy) with an additional flag called transform.
LocationHierarchy	create(LocationHierarchy locationHierarchy) Creates an instance of fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy and adds it to the persistent store.
Collection<?>	findLocationHierarchiesByFatherId(Integer fatherId)
Collection<?>	findLocationHierarchiesById(Integer id)
LocationHierarchy	findLocationHierarchyByIdentifiers(Integer id, Integer fatherId)
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(java.lang.Integer)
protected abstract Collection<?>	handleFindLocationHierarchiesById(Integer id) Performs the core logic for findLocationHierarchiesById(java.lang.Integer)
protected abstract LocationHierarchy	handleFindLocationHierarchyByIdentifiers(Integer id, Integer fatherId) Performs the core logic for findLocationHierarchyByIdentifiers(java.lang.Integer, java.lang.Integer)
Object	load(int transform, Location parent, Location location) Does the same thing as LocationHierarchyDao.load(fr.ifremer.adagio.core.dao.referential.location.Location,fr.ifremer.adagio.core.dao.referential.location.Location) with an additional flag called transform.
LocationHierarchy	load(Location parent, Location location) Loads an instance of fr.ifremer.adagio.core.dao.technical.optimization.location.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 fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy from the persistent store.
void	remove(Location parent, Location location) Removes the instance of fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy having the given identifiers from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as {@link #search(int, fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize.
PaginationResult	search(int pageNumber, int pageSize, Search search) Does the same thing as {@link #search(fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as LocationHierarchyDao.search(fr.ifremer.adagio.core.dao.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.
protected LocationHierarchy	toEntity(Object[] row)
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy) method.
protected 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 fr.ifremer.adagio.core.dao.technical.optimization.location.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 org.springframework.orm.hibernate3.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocationHierarchyDaoBase

public LocationHierarchyDaoBase()

Method Detail

load

public Object load(int transform,
          Location parent,
          Location location)

Description copied from interface: LocationHierarchyDao

Does the same thing as LocationHierarchyDao.load(fr.ifremer.adagio.core.dao.referential.location.Location,fr.ifremer.adagio.core.dao.referential.location.Location) 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

parent - identifier of the entity to load

location - identifier of the entity to load

Returns:

either the entity or the object transformed from the entity.

See Also:

LocationHierarchyDao.load(int, fr.ifremer.adagio.core.dao.referential.location.Location,fr.ifremer.adagio.core.dao.referential.location.Location)

load

public LocationHierarchy load(Location parent,
                     Location location)

Description copied from interface: LocationHierarchyDao

Loads an instance of fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy from the persistent store.

Specified by:

load in interface LocationHierarchyDao

See Also:

LocationHierarchyDao.load(fr.ifremer.adagio.core.dao.referential.location.Location,fr.ifremer.adagio.core.dao.referential.location.Location)

loadAll

public Collection<LocationHierarchy> loadAll()

Description copied from interface: LocationHierarchyDao

Loads all entities of type LocationHierarchy.

Specified by:

loadAll in interface LocationHierarchyDao

Returns:

the loaded entities.

See Also:

LocationHierarchyDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: LocationHierarchyDao

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.

See Also:

LocationHierarchyDao.loadAll(int)

loadAll

public Collection<?> loadAll(int pageNumber,
                    int pageSize)

Description copied from interface: LocationHierarchyDao

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.

See Also:

LocationHierarchyDao.loadAll(int, int)

loadAll

public Collection<?> loadAll(int transform,
                    int pageNumber,
                    int pageSize)

Description copied from interface: LocationHierarchyDao

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.

See Also:

LocationHierarchyDao.loadAll(int, int, int)

create

public LocationHierarchy create(LocationHierarchy locationHierarchy)

Description copied from interface: LocationHierarchyDao

Creates an instance of fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy and adds it to the persistent store.

Specified by:

create in interface LocationHierarchyDao

See Also:

LocationHierarchyDao.create(fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy)

create

public Object create(int transform,
            LocationHierarchy locationHierarchy)

Description copied from interface: LocationHierarchyDao

Does the same thing as LocationHierarchyDao.create(fr.ifremer.adagio.core.dao.technical.optimization.location.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

See Also:

LocationHierarchyDao.create(int transform, fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy)

create

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

Description copied from interface: LocationHierarchyDao

Creates a new instance of fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy and adds from the passed in entities collection

Specified by:

create in interface LocationHierarchyDao

Parameters:

entities - the collection of fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy instances to create.

Returns:

the created instances.

See Also:

fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchyDao#create(java.util.Collection)

create

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

Description copied from interface: LocationHierarchyDao

Does the same thing as LocationHierarchyDao.create(fr.ifremer.adagio.core.dao.technical.optimization.location.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

See Also:

fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchyDao#create(int, java.util.Collection)

create

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

Description copied from interface: LocationHierarchyDao

Creates a new fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy instance from all attributes and properties and adds it to the persistent store.

Specified by:

create in interface LocationHierarchyDao

See Also:

LocationHierarchyDao.create(java.lang.Float,java.lang.Boolean,fr.ifremer.adagio.core.dao.referential.location.Location,fr.ifremer.adagio.core.dao.referential.location.Location)

create

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

Description copied from interface: LocationHierarchyDao

Does the same thing as LocationHierarchyDao.create(java.lang.Float,java.lang.Boolean,fr.ifremer.adagio.core.dao.referential.location.Location,fr.ifremer.adagio.core.dao.referential.location.Location) 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

See Also:

LocationHierarchyDao.create(int, java.lang.Float,java.lang.Boolean,fr.ifremer.adagio.core.dao.referential.location.Location,fr.ifremer.adagio.core.dao.referential.location.Location)

update

public void update(LocationHierarchy locationHierarchy)

Description copied from interface: LocationHierarchyDao

Updates the locationHierarchy instance in the persistent store.

Specified by:

update in interface LocationHierarchyDao

See Also:

LocationHierarchyDao.update(fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy)

update

public void update(Collection<LocationHierarchy> entities)

Description copied from interface: LocationHierarchyDao

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

Specified by:

update in interface LocationHierarchyDao

See Also:

fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchyDao#update(java.util.Collection)

remove

public void remove(LocationHierarchy locationHierarchy)

Description copied from interface: LocationHierarchyDao

Removes the instance of fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy from the persistent store.

Specified by:

remove in interface LocationHierarchyDao

See Also:

LocationHierarchyDao.remove(fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy)

remove

public void remove(Location parent,
          Location location)

Description copied from interface: LocationHierarchyDao

Removes the instance of fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy having the given identifiers from the persistent store.

Specified by:

remove in interface LocationHierarchyDao

See Also:

LocationHierarchyDao.remove(fr.ifremer.adagio.core.dao.referential.location.Location,fr.ifremer.adagio.core.dao.referential.location.Location)

remove

public void remove(Collection<LocationHierarchy> entities)

Description copied from interface: LocationHierarchyDao

Removes all entities in the given entities collection.

Specified by:

remove in interface LocationHierarchyDao

See Also:

fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchyDao#remove(java.util.Collection)

findLocationHierarchyByIdentifiers

public LocationHierarchy findLocationHierarchyByIdentifiers(Integer id,
                                                   Integer fatherId)

Specified by:

findLocationHierarchyByIdentifiers in interface LocationHierarchyDao

See Also:

LocationHierarchyDao.findLocationHierarchyByIdentifiers(java.lang.Integer, java.lang.Integer)

handleFindLocationHierarchyByIdentifiers

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

Performs the core logic for findLocationHierarchyByIdentifiers(java.lang.Integer, java.lang.Integer)

Throws:

Exception

findLocationHierarchiesById

public Collection<?> findLocationHierarchiesById(Integer id)

Specified by:

findLocationHierarchiesById in interface LocationHierarchyDao

See Also:

LocationHierarchyDao.findLocationHierarchiesById(java.lang.Integer)

handleFindLocationHierarchiesById

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

Performs the core logic for findLocationHierarchiesById(java.lang.Integer)

Throws:

Exception

findLocationHierarchiesByFatherId

public Collection<?> findLocationHierarchiesByFatherId(Integer fatherId)

Specified by:

findLocationHierarchiesByFatherId in interface LocationHierarchyDao

See Also:

LocationHierarchyDao.findLocationHierarchiesByFatherId(java.lang.Integer)

handleFindLocationHierarchiesByFatherId

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

Performs the core logic for findLocationHierarchiesByFatherId(java.lang.Integer)

Throws:

Exception

transformEntity

protected 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 fr.ifremer.adagio.core.dao.technical.optimization.location.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.

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:

transformEntities(int,java.util.Collection)

transformEntities

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

Transforms a collection of entities using the transformEntity(int,fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy) method. This method does not instantiate a new collection.

This method is to be used internally only.

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:

transformEntity(int,fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchy)

toEntity

protected LocationHierarchy toEntity(Object[] row)

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)

Description copied from interface: LocationHierarchyDao

Does the same thing as {@link #search(int, fr.ifremer.adagio.core.dao.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.

See Also:

LocationHierarchyDao.search(int, int, int, fr.ifremer.adagio.core.dao.Search)

search

public PaginationResult search(int pageNumber,
                      int pageSize,
                      Search search)

Description copied from interface: LocationHierarchyDao

Does the same thing as {@link #search(fr.ifremer.adagio.core.dao.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.

See Also:

LocationHierarchyDao.search(int, int, fr.ifremer.adagio.core.dao.Search)

search

public Set<?> search(int transform,
            Search search)

Description copied from interface: LocationHierarchyDao

Does the same thing as LocationHierarchyDao.search(fr.ifremer.adagio.core.dao.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.

See Also:

LocationHierarchyDao.search(int, fr.ifremer.adagio.core.dao.Search)

search

public Set<LocationHierarchy> search(Search search)

Description copied from interface: LocationHierarchyDao

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.

See Also:

LocationHierarchyDao.search(fr.ifremer.adagio.core.dao.Search)