fr.ifremer.adagio.core.dao.data.vessel.position

Class VesselPositionDaoBase

Object

HibernateDaoSupport

VesselPositionDaoBase

All Implemented Interfaces:

VesselPositionDao

Direct Known Subclasses:

VesselPositionDaoImpl

public abstract class VesselPositionDaoBase
extends HibernateDaoSupport
implements VesselPositionDao

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

See Also:

VesselPosition

Field Summary

Fields inherited from class HibernateDaoSupport

debugEntityLoad, logger

Fields inherited from interface VesselPositionDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
VesselPositionDaoBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateFirstResult(int pageNumber, int pageSize) firstResult = (pageNumber - 1) * pageSize
Collection<VesselPosition>	create(Collection<VesselPosition> entities) Creates a new instance of VesselPosition and adds from the passed in entities collection
VesselPosition	create(Date dateTime, Float latitude, Float longitude, BigDecimal vesselSpeed, BigDecimal vesselDirection, Date controlDate, Date validationDate, Date qualificationDate, Timestamp updateDate, Point position) Creates a new VesselPosition instance from all attributes and adds it to the persistent store.
VesselPosition	create(Date dateTime, Float latitude, Float longitude, Program program, QualityFlag qualityFlag, Department recorderDepartment, Timestamp updateDate, Vessel vessel) Creates a new VesselPosition instance from only required properties (attributes and association ends) and adds it to the persistent store.
Collection<?>	create(int transform, Collection<VesselPosition> entities) Does the same thing as VesselPositionDao.create(VesselPosition) with an additional flag called transform.
Object	create(int transform, Date dateTime, Float latitude, Float longitude, BigDecimal vesselSpeed, BigDecimal vesselDirection, Date controlDate, Date validationDate, Date qualificationDate, Timestamp updateDate, Point position) Does the same thing as VesselPositionDao.create(Date, Float, Float, BigDecimal, BigDecimal, Date, Date, Date, Timestamp, Point) with an additional flag called transform.
Object	create(int transform, Date dateTime, Float latitude, Float longitude, Program program, QualityFlag qualityFlag, Department recorderDepartment, Timestamp updateDate, Vessel vessel) Does the same thing as #create(Date, Float, Float, Timestamp) with an additional flag called transform.
Object	create(int transform, VesselPosition vesselPosition) Does the same thing as VesselPositionDao.create(VesselPosition) with an additional flag called transform.
VesselPosition	create(VesselPosition vesselPosition) Creates an instance of VesselPosition and adds it to the persistent store.
VesselPosition	get(BigInteger id) Gets an instance of VesselPosition from the persistent store.
Object	get(int transform, BigInteger id) Does the same thing as VesselPositionDao.get(BigInteger) 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.
VesselPosition	load(BigInteger id) Loads an instance of VesselPosition from the persistent store.
Object	load(int transform, BigInteger id) Does the same thing as VesselPositionDao.load(BigInteger) with an additional flag called transform.
Collection<VesselPosition>	loadAll() Loads all entities of type VesselPosition.
Collection<?>	loadAll(int transform) Does the same thing as VesselPositionDao.loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as VesselPositionDao.loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as VesselPositionDao.loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(BigInteger id) Removes the instance of VesselPosition having the given identifier from the persistent store.
void	remove(Collection<VesselPosition> entities) Removes all entities in the given entities collection.
void	remove(VesselPosition vesselPosition) Removes the instance of VesselPosition from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as VesselPositionDao.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 VesselPositionDao.search(Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as VesselPositionDao.search(Search) but with an additional flag called transform.
Set<VesselPosition>	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 VesselPosition instances (this is useful when the returned results contains a row of data and you want just entities only).
protected VesselPosition	toEntity(Object[] row)
void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the VesselPositionDao.transformEntity(int,VesselPosition) method.
Object	transformEntity(int transform, VesselPosition 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 VesselPositionDao, please note that the VesselPositionDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<VesselPosition> entities) Updates all instances in the entities collection in the persistent store.
void	update(VesselPosition vesselPosition) Updates the vesselPosition 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

VesselPositionDaoBase

public VesselPositionDaoBase()

Method Detail

get

public Object get(int transform,
         BigInteger id)

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

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 VesselPosition get(BigInteger id)

Gets an instance of VesselPosition from the persistent store.

Specified by:

get in interface VesselPositionDao

Returns:

VesselPosition

load

public Object load(int transform,
          BigInteger id)

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

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 VesselPosition load(BigInteger id)

Loads an instance of VesselPosition from the persistent store.

Specified by:

load in interface VesselPositionDao

Returns:

VesselPosition

loadAll

public Collection<VesselPosition> loadAll()

Loads all entities of type VesselPosition.

Specified by:

loadAll in interface VesselPositionDao

Returns:

the loaded entities.

loadAll

public Collection<?> loadAll(int transform)

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

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

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

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 VesselPosition create(VesselPosition vesselPosition)

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

Specified by:

create in interface VesselPositionDao

Returns:

VesselPosition

create

public Object create(int transform,
            VesselPosition vesselPosition)

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

Returns:

Object

create

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

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

Specified by:

create in interface VesselPositionDao

Parameters:

entities - the collection of VesselPosition instances to create.

Returns:

the created instances.

create

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

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

Returns:

Collection

create

public VesselPosition create(Date dateTime,
                    Float latitude,
                    Float longitude,
                    BigDecimal vesselSpeed,
                    BigDecimal vesselDirection,
                    Date controlDate,
                    Date validationDate,
                    Date qualificationDate,
                    Timestamp updateDate,
                    Point position)

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

Specified by:

create in interface VesselPositionDao

vesselSpeed - Vitesse du navire

vesselDirection - Cap du navire (0-360°)

position - Géomtrie ponctuelle de la position (en WGS84)

Returns:

VesselPosition

create

public Object create(int transform,
            Date dateTime,
            Float latitude,
            Float longitude,
            BigDecimal vesselSpeed,
            BigDecimal vesselDirection,
            Date controlDate,
            Date validationDate,
            Date qualificationDate,
            Timestamp updateDate,
            Point position)

Does the same thing as VesselPositionDao.create(Date, Float, Float, BigDecimal, BigDecimal, Date, Date, Date, Timestamp, Point) 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 VesselPositionDao

vesselSpeed - Vitesse du navire

vesselDirection - Cap du navire (0-360°)

position - Géomtrie ponctuelle de la position (en WGS84)

Returns:

VesselPosition

create

public VesselPosition create(Date dateTime,
                    Float latitude,
                    Float longitude,
                    Program program,
                    QualityFlag qualityFlag,
                    Department recorderDepartment,
                    Timestamp updateDate,
                    Vessel vessel)

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

Specified by:

create in interface VesselPositionDao

Returns:

VesselPosition

create

public Object create(int transform,
            Date dateTime,
            Float latitude,
            Float longitude,
            Program program,
            QualityFlag qualityFlag,
            Department recorderDepartment,
            Timestamp updateDate,
            Vessel vessel)

Does the same thing as #create(Date, Float, Float, 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 VesselPositionDao

Parameters:

transform - flag to determine transformation type.

Returns:

Object

update

public void update(VesselPosition vesselPosition)

Updates the vesselPosition instance in the persistent store.

Specified by:

update in interface VesselPositionDao

update

public void update(Collection<VesselPosition> entities)

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

Specified by:

update in interface VesselPositionDao

remove

public void remove(VesselPosition vesselPosition)

Removes the instance of VesselPosition from the persistent store.

Specified by:

remove in interface VesselPositionDao

remove

public void remove(BigInteger id)

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

Specified by:

remove in interface VesselPositionDao

remove

public void remove(Collection<VesselPosition> entities)

Removes all entities in the given entities collection.

Specified by:

remove in interface VesselPositionDao

transformEntity

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

Specified by:

transformEntity in interface VesselPositionDao

Parameters:

transform - one of the constants declared in VesselPositionDao

entity - an entity that was found

Returns:

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

See Also:

VesselPositionDao.transformEntity(int, VesselPosition)

transformEntities

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

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

This method is to be used internally only.

Specified by:

transformEntities in interface VesselPositionDao

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.data.vessel.position.VesselPositionDao

entities - the collection of entities to transform

See Also:

VesselPositionDao.transformEntity(int,VesselPosition)

toEntities

public void toEntities(Collection<?> results)

Description copied from interface: VesselPositionDao

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

Specified by:

toEntities in interface VesselPositionDao

Parameters:

results - the query results.

See Also:

VesselPositionDao.toEntities(Collection)

toEntity

protected VesselPosition toEntity(Object[] row)

Parameters:

row -

Returns:

VesselPosition

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

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

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

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

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

Specified by:

search in interface VesselPositionDao

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