fr.ifremer.adagio.core.dao.referential.location

Class LocationPointDaoBase

Object

HibernateDaoSupport

LocationPointDaoBase

All Implemented Interfaces:

LocationPointDao

Direct Known Subclasses:

LocationPointDaoImpl

public abstract class LocationPointDaoBase
extends HibernateDaoSupport
implements LocationPointDao

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

See Also:

LocationPoint

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface LocationPointDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
LocationPointDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateFirstResult(int pageNumber, int pageSize) firstResult = (pageNumber - 1) * pageSize
Collection<LocationPoint>	create(Collection<LocationPoint> entities) Creates a new instance of LocationPoint and adds from the passed in entities collection
Collection<?>	create(int transform, Collection<LocationPoint> entities) Does the same thing as LocationPointDao.create(LocationPoint) with an additional flag called transform.
Object	create(int transform, LocationClassification locationClassification, LocationLevel locationLevel, String name, Status status, Timestamp updateDate, ValidityStatus validityStatus, Point position) Does the same thing as #create(Point, String, Timestamp) with an additional flag called transform.
Object	create(int transform, LocationPoint locationPoint) Does the same thing as LocationPointDao.create(LocationPoint) with an additional flag called transform.
Object	create(int transform, Point position, Timestamp positionUpdateDate, String label, String name, Float bathymetry, Short utFormat, Boolean daylightSavingTime, String comments, Timestamp updateDate) Does the same thing as LocationPointDao.create(Point, Timestamp, String, String, Float, Short, Boolean, String, Timestamp) with an additional flag called transform.
LocationPoint	create(LocationClassification locationClassification, LocationLevel locationLevel, String name, Status status, Timestamp updateDate, ValidityStatus validityStatus, Point position) Creates a new LocationPoint instance from only required properties (attributes and association ends) and adds it to the persistent store.
LocationPoint	create(LocationPoint locationPoint) Creates an instance of LocationPoint and adds it to the persistent store.
LocationPoint	create(Point position, Timestamp positionUpdateDate, String label, String name, Float bathymetry, Short utFormat, Boolean daylightSavingTime, String comments, Timestamp updateDate) Creates a new LocationPoint instance from all attributes and adds it to the persistent store.
LocationPoint	get(Integer id) Gets an instance of LocationPoint from the persistent store.
Object	get(int transform, Integer id) Does the same thing as LocationPointDao.get(Integer) with an additional flag called transform.
protected PaginationResult	getPaginationResult(Query queryObject, int transform, int pageNumber, int pageSize) Executes and returns the given Hibernate queryObject as a PaginationResult instance.
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
LocationPoint	load(Integer id) Loads an instance of LocationPoint from the persistent store.
Object	load(int transform, Integer id) Does the same thing as LocationPointDao.load(Integer) with an additional flag called transform.
Collection<LocationPoint>	loadAll() Loads all entities of type LocationPoint.
Collection<?>	loadAll(int transform) Does the same thing as LocationPointDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as LocationPointDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as LocationPointDao.loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Collection<LocationPoint> entities) Removes all entities in the given entities collection.
void	remove(Integer id) Removes the instance of LocationPoint having the given identifier from the persistent store.
void	remove(LocationPoint locationPoint) Removes the instance of LocationPoint from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as LocationPointDao.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 LocationPointDao.search(Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as LocationPointDao.search(Search) but with an additional flag called transform.
Set<LocationPoint>	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 LocationPoint instances (this is useful when the returned results contains a row of data and you want just entities only).
protected LocationPoint	toEntity(Object[] row)
void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the LocationPointDao.transformEntity(int,LocationPoint) method.
Object	transformEntity(int transform, LocationPoint 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 LocationPointDao, please note that the LocationPointDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<LocationPoint> entities) Updates all instances in the entities collection in the persistent store.
void	update(LocationPoint locationPoint) Updates the locationPoint 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

LocationPointDaoBase

public LocationPointDaoBase()

Method Detail

get

public Object get(int transform,
         Integer id)

Does the same thing as LocationPointDao.get(Integer) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

get in interface LocationPointDao

Parameters:

transform - flag to determine transformation type.

id - the identifier of the entity to get.

Returns:

either the entity or the object transformed from the entity.

get

public LocationPoint get(Integer id)

Gets an instance of LocationPoint from the persistent store.

Specified by:

get in interface LocationPointDao

Returns:

LocationPoint

load

public Object load(int transform,
          Integer id)

Does the same thing as LocationPointDao.load(Integer) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

load in interface LocationPointDao

Parameters:

transform - flag to determine transformation type.

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

public LocationPoint load(Integer id)

Loads an instance of LocationPoint from the persistent store.

Specified by:

load in interface LocationPointDao

Returns:

LocationPoint

loadAll

public Collection<LocationPoint> loadAll()

Loads all entities of type LocationPoint.

Specified by:

loadAll in interface LocationPointDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 LocationPoint create(LocationPoint locationPoint)

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

Specified by:

create in interface LocationPointDao

Returns:

LocationPoint

create

public Object create(int transform,
            LocationPoint locationPoint)

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

Returns:

Object

create

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

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

Specified by:

create in interface LocationPointDao

Parameters:

entities - the collection of LocationPoint instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public LocationPoint create(Point position,
                   Timestamp positionUpdateDate,
                   String label,
                   String name,
                   Float bathymetry,
                   Short utFormat,
                   Boolean daylightSavingTime,
                   String comments,
                   Timestamp updateDate)

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

Specified by:

create in interface LocationPointDao

label - Code du lieuExemple : pour les ports : BR, SB

name - Libellé du lieu

bathymetry - Valeur de la bathymétrie sur le lieu (optionnel). La bathymétrie peut être positive ou négative.

utFormat - Format UT (Universal Time) de l'heure pour le lieu (0, +1, -4...). En France métropolitaine, par exemple : +1 (= heure Europe/Paris)

daylightSavingTime - Indique s'il faut opérer le changement d'heure hiver-été, vrai par défaut. En France métropolitaine, par exemple : Vrai.

Returns:

LocationPoint

create

public Object create(int transform,
            Point position,
            Timestamp positionUpdateDate,
            String label,
            String name,
            Float bathymetry,
            Short utFormat,
            Boolean daylightSavingTime,
            String comments,
            Timestamp updateDate)

Does the same thing as LocationPointDao.create(Point, Timestamp, String, String, Float, Short, Boolean, String, Timestamp) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

create in interface LocationPointDao

label - Code du lieuExemple : pour les ports : BR, SB

name - Libellé du lieu

bathymetry - Valeur de la bathymétrie sur le lieu (optionnel). La bathymétrie peut être positive ou négative.

utFormat - Format UT (Universal Time) de l'heure pour le lieu (0, +1, -4...). En France métropolitaine, par exemple : +1 (= heure Europe/Paris)

daylightSavingTime - Indique s'il faut opérer le changement d'heure hiver-été, vrai par défaut. En France métropolitaine, par exemple : Vrai.

Returns:

LocationPoint

create

public LocationPoint create(LocationClassification locationClassification,
                   LocationLevel locationLevel,
                   String name,
                   Status status,
                   Timestamp updateDate,
                   ValidityStatus validityStatus,
                   Point position)

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

Specified by:

create in interface LocationPointDao

Returns:

LocationPoint

create

public Object create(int transform,
            LocationClassification locationClassification,
            LocationLevel locationLevel,
            String name,
            Status status,
            Timestamp updateDate,
            ValidityStatus validityStatus,
            Point position)

Does the same thing as #create(Point, String, Timestamp) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

create in interface LocationPointDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(LocationPoint locationPoint)

Updates the locationPoint instance in the persistent store.

Specified by:

update in interface LocationPointDao

update

public void update(Collection<LocationPoint> entities)

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

Specified by:

update in interface LocationPointDao

remove

public void remove(LocationPoint locationPoint)

Removes the instance of LocationPoint from the persistent store.

Specified by:

remove in interface LocationPointDao

remove

public void remove(Integer id)

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

Specified by:

remove in interface LocationPointDao

remove

public void remove(Collection<LocationPoint> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface LocationPointDao

transformEntity

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

Specified by:

transformEntity in interface LocationPointDao

Parameters:

transform - one of the constants declared in LocationPointDao

entity - an entity that was found

Returns:

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

See Also:

LocationPointDao.transformEntity(int, LocationPoint)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface LocationPointDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.referential.location.LocationPointDao

entities - the collection of entities to transform

See Also:

LocationPointDao.transformEntity(int,LocationPoint)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: LocationPointDao

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

Specified by:

toEntities in interface LocationPointDao

Parameters:

results - the query results.

See Also:

LocationPointDao.toEntities(Collection)

toEntity

protected LocationPoint toEntity(Object[] row)

Parameters:

row -

Returns:

LocationPoint

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

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

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

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

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

Specified by:

search in interface LocationPointDao

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