fr.ifremer.allegro.referential.location
Class LocationPointDaoBase

java.lang.Object
  extended by org.springframework.orm.hibernate3.support.HibernateDaoSupport
      extended by fr.ifremer.allegro.referential.location.LocationPointDaoBase
All Implemented Interfaces:
LocationPointDao
Direct Known Subclasses:
LocationPointDaoImpl

public abstract class LocationPointDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements LocationPointDao

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

See Also:
LocationPoint

Field Summary
 
Fields inherited from interface fr.ifremer.allegro.referential.location.LocationPointDao
TRANSFORM_CLUSTERLOCATIONPOINT, TRANSFORM_NONE, TRANSFORM_REMOTELOCATIONPOINTFULLVO, TRANSFORM_REMOTELOCATIONPOINTNATURALID
 
Constructor Summary
LocationPointDaoBase()
           
 
Method Summary
 void clusterLocationPointToEntity(ClusterLocationPoint source, LocationPoint target, boolean copyIfNull)
          Copies the fields of ClusterLocationPoint to the specified entity.
 void clusterLocationPointToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type ClusterLocationPoint to this DAO's entity.
 java.util.Collection create(java.util.Collection entities)
          Creates a new instance of fr.ifremer.allegro.referential.location.LocationPoint and adds from the passed in entities collection
 java.util.Collection create(int transform, java.util.Collection entities)
           Does the same thing as LocationPointDao.create(fr.ifremer.allegro.referential.location.LocationPoint) with an additional flag called transform.
 java.lang.Object create(int transform, Location location)
           Does the same thing as LocationPointDao.create(fr.ifremer.allegro.referential.location.Location) with an additional flag called transform.
 java.lang.Object create(int transform, LocationPoint locationPoint)
           Does the same thing as LocationPointDao.create(fr.ifremer.allegro.referential.location.LocationPoint) with an additional flag called transform.
 LocationPoint create(Location location)
           Creates a new fr.ifremer.allegro.referential.location.LocationPoint instance from all attributes and properties and adds it to the persistent store.
 LocationPoint create(LocationPoint locationPoint)
          Creates an instance of fr.ifremer.allegro.referential.location.LocationPoint and adds it to the persistent store.
 LocationPoint createFromClusterLocationPoint(ClusterLocationPoint clusterLocationPoint)
           
 LocationPoint findLocationPointById(java.lang.Integer id)
           
 java.lang.Object findLocationPointById(int transform, java.lang.Integer id)
           Does the same thing as LocationPointDao.findLocationPointById(java.lang.Integer) with an additional flag called transform.
 java.lang.Object findLocationPointById(int transform, java.lang.String queryString, java.lang.Integer id)
           Does the same thing as LocationPointDao.findLocationPointById(int, java.lang.Integer) with an additional argument called queryString.
 LocationPoint findLocationPointById(java.lang.String queryString, java.lang.Integer id)
           Does the same thing as LocationPointDao.findLocationPointById(java.lang.Integer) with an additional argument called queryString.
 java.util.Collection findLocationPointByLocation(int transform, int pageNumber, int pageSize, Location location)
           Does the same thing as LocationPointDao.findLocationPointByLocation(int, fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationPointByLocation(int pageNumber, int pageSize, Location location)
           Does the same thing as LocationPointDao.findLocationPointByLocation(fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationPointByLocation(int transform, Location location)
           Does the same thing as LocationPointDao.findLocationPointByLocation(fr.ifremer.allegro.referential.location.Location) with an additional flag called transform.
 java.util.Collection findLocationPointByLocation(int transform, java.lang.String queryString, int pageNumber, int pageSize, Location location)
           Does the same thing as LocationPointDao.findLocationPointByLocation(int, String, fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationPointByLocation(int transform, java.lang.String queryString, Location location)
           Does the same thing as LocationPointDao.findLocationPointByLocation(int, fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString.
 java.util.Collection findLocationPointByLocation(Location location)
           
 java.util.Collection findLocationPointByLocation(java.lang.String queryString, int pageNumber, int pageSize, Location location)
           Does the same thing as LocationPointDao.findLocationPointByLocation(String, fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationPointByLocation(java.lang.String queryString, Location location)
           Does the same thing as LocationPointDao.findLocationPointByLocation(fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString.
 LocationPoint findLocationPointByNaturalId(java.lang.Integer id)
           
 java.lang.Object findLocationPointByNaturalId(int transform, java.lang.Integer id)
           Does the same thing as LocationPointDao.findLocationPointByNaturalId(java.lang.Integer) with an additional flag called transform.
 java.lang.Object findLocationPointByNaturalId(int transform, java.lang.String queryString, java.lang.Integer id)
           Does the same thing as LocationPointDao.findLocationPointByNaturalId(int, java.lang.Integer) with an additional argument called queryString.
 LocationPoint findLocationPointByNaturalId(java.lang.String queryString, java.lang.Integer id)
           Does the same thing as LocationPointDao.findLocationPointByNaturalId(java.lang.Integer) with an additional argument called queryString.
 java.util.Collection getAllLocationPoint()
           
 java.util.Collection getAllLocationPoint(int transform)
           Does the same thing as LocationPointDao.getAllLocationPoint() with an additional flag called transform.
 java.util.Collection getAllLocationPoint(int pageNumber, int pageSize)
           Does the same thing as LocationPointDao.getAllLocationPoint() with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllLocationPoint(int transform, int pageNumber, int pageSize)
           Does the same thing as LocationPointDao.getAllLocationPoint(int) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllLocationPoint(int transform, java.lang.String queryString)
           Does the same thing as LocationPointDao.getAllLocationPoint(int) with an additional argument called queryString.
 java.util.Collection getAllLocationPoint(int transform, java.lang.String queryString, int pageNumber, int pageSize)
           Does the same thing as LocationPointDao.getAllLocationPoint(int, String) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllLocationPoint(java.lang.String queryString)
           Does the same thing as LocationPointDao.getAllLocationPoint() with an additional argument called queryString.
 java.util.Collection getAllLocationPoint(java.lang.String queryString, int pageNumber, int pageSize)
           Does the same thing as LocationPointDao.getAllLocationPoint(String) with an additional two arguments called pageNumber and pageSize.
protected  LocationDao getLocationDao()
          Gets the reference to locationDao.
protected  java.security.Principal getPrincipal()
          Gets the current principal if one has been set, otherwise returns null.
protected abstract  LocationPoint handleCreateFromClusterLocationPoint(ClusterLocationPoint clusterLocationPoint)
          Performs the core logic for createFromClusterLocationPoint(fr.ifremer.allegro.referential.location.generic.cluster.ClusterLocationPoint)
 LocationPoint load(java.lang.Integer id)
          Loads an instance of fr.ifremer.allegro.referential.location.LocationPoint from the persistent store.
 java.lang.Object load(int transform, java.lang.Integer id)
           Does the same thing as LocationPointDao.load(java.lang.Integer) with an additional flag called transform.
 java.util.Collection loadAll()
          Loads all entities of type LocationPoint.
 java.util.Collection loadAll(int transform)
           Does the same thing as LocationPointDao.loadAll() with an additional flag called transform.
 java.util.Collection loadAll(int pageNumber, int pageSize)
           Does the same thing as LocationPointDao.loadAll() with an additional two arguments called pageNumber and pageSize.
 java.util.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 remoteLocationPointFullVOToEntity(RemoteLocationPointFullVO source, LocationPoint target, boolean copyIfNull)
          Copies the fields of RemoteLocationPointFullVO to the specified entity.
 void remoteLocationPointFullVOToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type RemoteLocationPointFullVO to this DAO's entity.
 void remoteLocationPointNaturalIdToEntity(RemoteLocationPointNaturalId source, LocationPoint target, boolean copyIfNull)
          Copies the fields of RemoteLocationPointNaturalId to the specified entity.
 void remoteLocationPointNaturalIdToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type RemoteLocationPointNaturalId to this DAO's entity.
 void remove(java.util.Collection entities)
          Removes all entities in the given entities collection.
 void remove(java.lang.Integer id)
          Removes the instance of fr.ifremer.allegro.referential.location.LocationPoint having the given identifier from the persistent store.
 void remove(LocationPoint locationPoint)
          Removes the instance of fr.ifremer.allegro.referential.location.LocationPoint from the persistent store.
 PaginationResult search(int transform, int pageNumber, int pageSize, Search search)
          Does the same thing as {@link #search(int, fr.ifremer.allegro.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.allegro.Search) but with an additional two flags called pageNumber and pageSize.
 java.util.Set search(int transform, Search search)
          Does the same thing as LocationPointDao.search(fr.ifremer.allegro.Search) but with an additional flag called transform.
 java.util.Set search(Search search)
          Performs a search using the parameters specified in the given search object.
 void setLocationDao(LocationDao locationDao)
          Sets the reference to locationDao.
 ClusterLocationPoint toClusterLocationPoint(LocationPoint entity)
          Converts this DAO's entity to an object of type ClusterLocationPoint.
 void toClusterLocationPoint(LocationPoint source, ClusterLocationPoint target)
          Copies the fields of the specified entity to the target value object.
protected  ClusterLocationPoint toClusterLocationPoint(java.lang.Object[] row)
          Default implementation for transforming the results of a report query into a value object.
 ClusterLocationPoint[] toClusterLocationPointArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type ClusterLocationPoint.
 void toClusterLocationPointCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type ClusterLocationPoint.
protected  LocationPoint toEntity(java.lang.Object[] row)
           
 RemoteLocationPointFullVO toRemoteLocationPointFullVO(LocationPoint entity)
          Converts this DAO's entity to an object of type RemoteLocationPointFullVO.
 void toRemoteLocationPointFullVO(LocationPoint source, RemoteLocationPointFullVO target)
          Copies the fields of the specified entity to the target value object.
protected  RemoteLocationPointFullVO toRemoteLocationPointFullVO(java.lang.Object[] row)
          Default implementation for transforming the results of a report query into a value object.
 RemoteLocationPointFullVO[] toRemoteLocationPointFullVOArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type RemoteLocationPointFullVO.
 void toRemoteLocationPointFullVOCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type RemoteLocationPointFullVO.
 RemoteLocationPointNaturalId toRemoteLocationPointNaturalId(LocationPoint entity)
          Converts this DAO's entity to an object of type RemoteLocationPointNaturalId.
 void toRemoteLocationPointNaturalId(LocationPoint source, RemoteLocationPointNaturalId target)
          Copies the fields of the specified entity to the target value object.
protected  RemoteLocationPointNaturalId toRemoteLocationPointNaturalId(java.lang.Object[] row)
          Default implementation for transforming the results of a report query into a value object.
 RemoteLocationPointNaturalId[] toRemoteLocationPointNaturalIdArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type RemoteLocationPointNaturalId.
 void toRemoteLocationPointNaturalIdCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type RemoteLocationPointNaturalId.
protected  void transformEntities(int transform, java.util.Collection entities)
          Transforms a collection of entities using the transformEntity(int,fr.ifremer.allegro.referential.location.LocationPoint) method.
protected  java.lang.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 fr.ifremer.allegro.referential.location.LocationPointDao, please note that the LocationPointDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
 void update(java.util.Collection 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface fr.ifremer.allegro.referential.location.LocationPointDao
clusterLocationPointToEntity, remoteLocationPointFullVOToEntity, remoteLocationPointNaturalIdToEntity
 

Constructor Detail

LocationPointDaoBase

public LocationPointDaoBase()
Method Detail

setLocationDao

public void setLocationDao(LocationDao locationDao)
Sets the reference to locationDao.


getLocationDao

protected LocationDao getLocationDao()
Gets the reference to locationDao.


load

public java.lang.Object load(int transform,
                             java.lang.Integer id)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.load(java.lang.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
id - identifier of the entity to load
Returns:
either the entity or the object transformed from the entity.
See Also:
LocationPointDao.load(int, java.lang.Integer)

load

public LocationPoint load(java.lang.Integer id)
Description copied from interface: LocationPointDao
Loads an instance of fr.ifremer.allegro.referential.location.LocationPoint from the persistent store.

Specified by:
load in interface LocationPointDao
See Also:
LocationPointDao.load(java.lang.Integer)

loadAll

public java.util.Collection loadAll()
Description copied from interface: LocationPointDao
Loads all entities of type LocationPoint.

Specified by:
loadAll in interface LocationPointDao
Returns:
the loaded entities.
See Also:
LocationPointDao.loadAll()

loadAll

public java.util.Collection loadAll(int transform)
Description copied from interface: LocationPointDao

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.
See Also:
LocationPointDao.loadAll(int)

loadAll

public java.util.Collection loadAll(int pageNumber,
                                    int pageSize)
Description copied from interface: LocationPointDao

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.
See Also:
LocationPointDao.loadAll(int, int)

loadAll

public java.util.Collection loadAll(int transform,
                                    int pageNumber,
                                    int pageSize)
Description copied from interface: LocationPointDao

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.
See Also:
LocationPointDao.loadAll(int, int, int)

create

public LocationPoint create(LocationPoint locationPoint)
Description copied from interface: LocationPointDao
Creates an instance of fr.ifremer.allegro.referential.location.LocationPoint and adds it to the persistent store.

Specified by:
create in interface LocationPointDao
See Also:
LocationPointDao.create(fr.ifremer.allegro.referential.location.LocationPoint)

create

public java.lang.Object create(int transform,
                               LocationPoint locationPoint)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.create(fr.ifremer.allegro.referential.location.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
See Also:
LocationPointDao.create(int transform, fr.ifremer.allegro.referential.location.LocationPoint)

create

public java.util.Collection create(java.util.Collection entities)
Description copied from interface: LocationPointDao
Creates a new instance of fr.ifremer.allegro.referential.location.LocationPoint and adds from the passed in entities collection

Specified by:
create in interface LocationPointDao
Parameters:
entities - the collection of fr.ifremer.allegro.referential.location.LocationPoint instances to create.
Returns:
the created instances.
See Also:
LocationPointDao.create(java.util.Collection)

create

public java.util.Collection create(int transform,
                                   java.util.Collection entities)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.create(fr.ifremer.allegro.referential.location.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
See Also:
LocationPointDao.create(int, java.util.Collection)

create

public LocationPoint create(Location location)
Description copied from interface: LocationPointDao

Creates a new fr.ifremer.allegro.referential.location.LocationPoint instance from all attributes and properties and adds it to the persistent store.

Specified by:
create in interface LocationPointDao
See Also:
LocationPointDao.create(fr.ifremer.allegro.referential.location.Location)

create

public java.lang.Object create(int transform,
                               Location location)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.create(fr.ifremer.allegro.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 LocationPointDao
See Also:
LocationPointDao.create(int, fr.ifremer.allegro.referential.location.Location)

update

public void update(LocationPoint locationPoint)
Description copied from interface: LocationPointDao
Updates the locationPoint instance in the persistent store.

Specified by:
update in interface LocationPointDao
See Also:
LocationPointDao.update(fr.ifremer.allegro.referential.location.LocationPoint)

update

public void update(java.util.Collection entities)
Description copied from interface: LocationPointDao
Updates all instances in the entities collection in the persistent store.

Specified by:
update in interface LocationPointDao
See Also:
LocationPointDao.update(java.util.Collection)

remove

public void remove(LocationPoint locationPoint)
Description copied from interface: LocationPointDao
Removes the instance of fr.ifremer.allegro.referential.location.LocationPoint from the persistent store.

Specified by:
remove in interface LocationPointDao
See Also:
LocationPointDao.remove(fr.ifremer.allegro.referential.location.LocationPoint)

remove

public void remove(java.lang.Integer id)
Description copied from interface: LocationPointDao
Removes the instance of fr.ifremer.allegro.referential.location.LocationPoint having the given identifier from the persistent store.

Specified by:
remove in interface LocationPointDao
See Also:
LocationPointDao.remove(java.lang.Integer)

remove

public void remove(java.util.Collection entities)
Description copied from interface: LocationPointDao
Removes all entities in the given entities collection.

Specified by:
remove in interface LocationPointDao
See Also:
LocationPointDao.remove(java.util.Collection)

getAllLocationPoint

public java.util.Collection getAllLocationPoint()
Specified by:
getAllLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.getAllLocationPoint()

getAllLocationPoint

public java.util.Collection getAllLocationPoint(int transform)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.getAllLocationPoint() 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 finder 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:
getAllLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.getAllLocationPoint(int)

getAllLocationPoint

public java.util.Collection getAllLocationPoint(java.lang.String queryString)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.getAllLocationPoint() with an additional argument called queryString. This queryString argument allows you to override the query string defined in LocationPointDao.getAllLocationPoint().

Specified by:
getAllLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.getAllLocationPoint(java.lang.String)

getAllLocationPoint

public java.util.Collection getAllLocationPoint(int pageNumber,
                                                int pageSize)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.getAllLocationPoint() 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:
getAllLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.getAllLocationPoint(int, int)

getAllLocationPoint

public java.util.Collection getAllLocationPoint(java.lang.String queryString,
                                                int pageNumber,
                                                int pageSize)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.getAllLocationPoint(String) 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:
getAllLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.getAllLocationPoint(String, int, int)

getAllLocationPoint

public java.util.Collection getAllLocationPoint(int transform,
                                                java.lang.String queryString)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.getAllLocationPoint(int) with an additional argument called queryString. This queryString argument allows you to override the query string defined in LocationPointDao.getAllLocationPoint(int).

Specified by:
getAllLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.getAllLocationPoint(int, String)

getAllLocationPoint

public java.util.Collection getAllLocationPoint(int transform,
                                                int pageNumber,
                                                int pageSize)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.getAllLocationPoint(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:
getAllLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.getAllLocationPoint(int, int, int)

getAllLocationPoint

public java.util.Collection getAllLocationPoint(int transform,
                                                java.lang.String queryString,
                                                int pageNumber,
                                                int pageSize)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.getAllLocationPoint(int, String) 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:
getAllLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.getAllLocationPoint(int, java.lang.String, int, int)

findLocationPointById

public LocationPoint findLocationPointById(java.lang.Integer id)
Specified by:
findLocationPointById in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointById(java.lang.Integer)

findLocationPointById

public java.lang.Object findLocationPointById(int transform,
                                              java.lang.Integer id)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointById(java.lang.Integer) 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 finder 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:
findLocationPointById in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointById(int, java.lang.Integer)

findLocationPointById

public LocationPoint findLocationPointById(java.lang.String queryString,
                                           java.lang.Integer id)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointById(java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in LocationPointDao.findLocationPointById(java.lang.Integer).

Specified by:
findLocationPointById in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointById(java.lang.String, java.lang.Integer)

findLocationPointById

public java.lang.Object findLocationPointById(int transform,
                                              java.lang.String queryString,
                                              java.lang.Integer id)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointById(int, java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in LocationPointDao.findLocationPointById(int, java.lang.Integer id).

Specified by:
findLocationPointById in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointById(int, java.lang.String, java.lang.Integer)

findLocationPointByLocation

public java.util.Collection findLocationPointByLocation(Location location)
Specified by:
findLocationPointByLocation in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByLocation(fr.ifremer.allegro.referential.location.Location)

findLocationPointByLocation

public java.util.Collection findLocationPointByLocation(int transform,
                                                        Location location)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointByLocation(fr.ifremer.allegro.referential.location.Location) 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 finder 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:
findLocationPointByLocation in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByLocation(int, fr.ifremer.allegro.referential.location.Location)

findLocationPointByLocation

public java.util.Collection findLocationPointByLocation(java.lang.String queryString,
                                                        Location location)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointByLocation(fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString. This queryString argument allows you to override the query string defined in LocationPointDao.findLocationPointByLocation(fr.ifremer.allegro.referential.location.Location).

Specified by:
findLocationPointByLocation in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByLocation(java.lang.String, fr.ifremer.allegro.referential.location.Location)

findLocationPointByLocation

public java.util.Collection findLocationPointByLocation(int pageNumber,
                                                        int pageSize,
                                                        Location location)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointByLocation(fr.ifremer.allegro.referential.location.Location) 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:
findLocationPointByLocation in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByLocation(int, int, fr.ifremer.allegro.referential.location.Location)

findLocationPointByLocation

public java.util.Collection findLocationPointByLocation(java.lang.String queryString,
                                                        int pageNumber,
                                                        int pageSize,
                                                        Location location)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointByLocation(String, fr.ifremer.allegro.referential.location.Location) 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:
findLocationPointByLocation in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByLocation(String, int, int, fr.ifremer.allegro.referential.location.Location)

findLocationPointByLocation

public java.util.Collection findLocationPointByLocation(int transform,
                                                        java.lang.String queryString,
                                                        Location location)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointByLocation(int, fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString. This queryString argument allows you to override the query string defined in LocationPointDao.findLocationPointByLocation(int, fr.ifremer.allegro.referential.location.Location location).

Specified by:
findLocationPointByLocation in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByLocation(int, String, fr.ifremer.allegro.referential.location.Location)

findLocationPointByLocation

public java.util.Collection findLocationPointByLocation(int transform,
                                                        int pageNumber,
                                                        int pageSize,
                                                        Location location)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointByLocation(int, fr.ifremer.allegro.referential.location.Location) 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:
findLocationPointByLocation in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByLocation(int, int, int, fr.ifremer.allegro.referential.location.Location)

findLocationPointByLocation

public java.util.Collection findLocationPointByLocation(int transform,
                                                        java.lang.String queryString,
                                                        int pageNumber,
                                                        int pageSize,
                                                        Location location)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointByLocation(int, String, fr.ifremer.allegro.referential.location.Location) 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:
findLocationPointByLocation in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByLocation(int, java.lang.String, int, int, fr.ifremer.allegro.referential.location.Location)

findLocationPointByNaturalId

public LocationPoint findLocationPointByNaturalId(java.lang.Integer id)
Specified by:
findLocationPointByNaturalId in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByNaturalId(java.lang.Integer)

findLocationPointByNaturalId

public java.lang.Object findLocationPointByNaturalId(int transform,
                                                     java.lang.Integer id)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointByNaturalId(java.lang.Integer) 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 finder 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:
findLocationPointByNaturalId in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByNaturalId(int, java.lang.Integer)

findLocationPointByNaturalId

public LocationPoint findLocationPointByNaturalId(java.lang.String queryString,
                                                  java.lang.Integer id)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointByNaturalId(java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in LocationPointDao.findLocationPointByNaturalId(java.lang.Integer).

Specified by:
findLocationPointByNaturalId in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByNaturalId(java.lang.String, java.lang.Integer)

findLocationPointByNaturalId

public java.lang.Object findLocationPointByNaturalId(int transform,
                                                     java.lang.String queryString,
                                                     java.lang.Integer id)
Description copied from interface: LocationPointDao

Does the same thing as LocationPointDao.findLocationPointByNaturalId(int, java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in LocationPointDao.findLocationPointByNaturalId(int, java.lang.Integer id).

Specified by:
findLocationPointByNaturalId in interface LocationPointDao
See Also:
LocationPointDao.findLocationPointByNaturalId(int, java.lang.String, java.lang.Integer)

createFromClusterLocationPoint

public LocationPoint createFromClusterLocationPoint(ClusterLocationPoint clusterLocationPoint)
Specified by:
createFromClusterLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.createFromClusterLocationPoint(fr.ifremer.allegro.referential.location.generic.cluster.ClusterLocationPoint)

handleCreateFromClusterLocationPoint

protected abstract LocationPoint handleCreateFromClusterLocationPoint(ClusterLocationPoint clusterLocationPoint)
                                                               throws java.lang.Exception
Performs the core logic for createFromClusterLocationPoint(fr.ifremer.allegro.referential.location.generic.cluster.ClusterLocationPoint)

Throws:
java.lang.Exception

transformEntity

protected java.lang.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 fr.ifremer.allegro.referential.location.LocationPointDao, please note that the LocationPointDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.

This method will return instances of these types:

If the integer argument value is unknown LocationPointDao.TRANSFORM_NONE is assumed.

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:
transformEntities(int,java.util.Collection)

transformEntities

protected void transformEntities(int transform,
                                 java.util.Collection entities)
Transforms a collection of entities using the transformEntity(int,fr.ifremer.allegro.referential.location.LocationPoint) 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.allegro.referential.location.LocationPointDao
entities - the collection of entities to transform
See Also:
transformEntity(int,fr.ifremer.allegro.referential.location.LocationPoint)

toEntity

protected LocationPoint toEntity(java.lang.Object[] row)

toRemoteLocationPointFullVOCollection

public final void toRemoteLocationPointFullVOCollection(java.util.Collection entities)
Description copied from interface: LocationPointDao
Converts this DAO's entity to a Collection of instances of type RemoteLocationPointFullVO.

Specified by:
toRemoteLocationPointFullVOCollection in interface LocationPointDao
See Also:
LocationPointDao.toRemoteLocationPointFullVOCollection(java.util.Collection)

toRemoteLocationPointFullVOArray

public final RemoteLocationPointFullVO[] toRemoteLocationPointFullVOArray(java.util.Collection entities)
Description copied from interface: LocationPointDao
Converts this DAO's entity to an array of instances of type RemoteLocationPointFullVO.

Specified by:
toRemoteLocationPointFullVOArray in interface LocationPointDao
See Also:
LocationPointDao.toRemoteLocationPointFullVOArray(java.util.Collection)

toRemoteLocationPointFullVO

protected RemoteLocationPointFullVO toRemoteLocationPointFullVO(java.lang.Object[] row)
Default implementation for transforming the results of a report query into a value object. This implementation exists for convenience reasons only. It needs only be overridden in the LocationPointDaoImpl class if you intend to use reporting queries.

See Also:
LocationPointDao.toRemoteLocationPointFullVO(fr.ifremer.allegro.referential.location.LocationPoint)

remoteLocationPointFullVOToEntityCollection

public final void remoteLocationPointFullVOToEntityCollection(java.util.Collection instances)
Description copied from interface: LocationPointDao
Converts a Collection of instances of type RemoteLocationPointFullVO to this DAO's entity.

Specified by:
remoteLocationPointFullVOToEntityCollection in interface LocationPointDao
See Also:
LocationPointDao.remoteLocationPointFullVOToEntityCollection(java.util.Collection)

toRemoteLocationPointFullVO

public void toRemoteLocationPointFullVO(LocationPoint source,
                                        RemoteLocationPointFullVO target)
Description copied from interface: LocationPointDao
Copies the fields of the specified entity to the target value object. This method is similar to toRemoteLocationPointFullVO(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

Specified by:
toRemoteLocationPointFullVO in interface LocationPointDao
See Also:
LocationPointDao.toRemoteLocationPointFullVO(fr.ifremer.allegro.referential.location.LocationPoint, fr.ifremer.allegro.referential.location.generic.vo.RemoteLocationPointFullVO)

toRemoteLocationPointFullVO

public RemoteLocationPointFullVO toRemoteLocationPointFullVO(LocationPoint entity)
Description copied from interface: LocationPointDao
Converts this DAO's entity to an object of type RemoteLocationPointFullVO.

Specified by:
toRemoteLocationPointFullVO in interface LocationPointDao
See Also:
LocationPointDao.toRemoteLocationPointFullVO(fr.ifremer.allegro.referential.location.LocationPoint)

remoteLocationPointFullVOToEntity

public void remoteLocationPointFullVOToEntity(RemoteLocationPointFullVO source,
                                              LocationPoint target,
                                              boolean copyIfNull)
Description copied from interface: LocationPointDao
Copies the fields of RemoteLocationPointFullVO to the specified entity.

Specified by:
remoteLocationPointFullVOToEntity in interface LocationPointDao
copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.
See Also:
fr.ifremer.allegro.referential.location.LocationPointDao#remoteLocationPointFullVOToEntity(fr.ifremer.allegro.referential.location.generic.vo.RemoteLocationPointFullVO, fr.ifremer.allegro.referential.location.LocationPoint)

toRemoteLocationPointNaturalIdCollection

public final void toRemoteLocationPointNaturalIdCollection(java.util.Collection entities)
Description copied from interface: LocationPointDao
Converts this DAO's entity to a Collection of instances of type RemoteLocationPointNaturalId.

Specified by:
toRemoteLocationPointNaturalIdCollection in interface LocationPointDao
See Also:
LocationPointDao.toRemoteLocationPointNaturalIdCollection(java.util.Collection)

toRemoteLocationPointNaturalIdArray

public final RemoteLocationPointNaturalId[] toRemoteLocationPointNaturalIdArray(java.util.Collection entities)
Description copied from interface: LocationPointDao
Converts this DAO's entity to an array of instances of type RemoteLocationPointNaturalId.

Specified by:
toRemoteLocationPointNaturalIdArray in interface LocationPointDao
See Also:
LocationPointDao.toRemoteLocationPointNaturalIdArray(java.util.Collection)

toRemoteLocationPointNaturalId

protected RemoteLocationPointNaturalId toRemoteLocationPointNaturalId(java.lang.Object[] row)
Default implementation for transforming the results of a report query into a value object. This implementation exists for convenience reasons only. It needs only be overridden in the LocationPointDaoImpl class if you intend to use reporting queries.

See Also:
LocationPointDao.toRemoteLocationPointNaturalId(fr.ifremer.allegro.referential.location.LocationPoint)

remoteLocationPointNaturalIdToEntityCollection

public final void remoteLocationPointNaturalIdToEntityCollection(java.util.Collection instances)
Description copied from interface: LocationPointDao
Converts a Collection of instances of type RemoteLocationPointNaturalId to this DAO's entity.

Specified by:
remoteLocationPointNaturalIdToEntityCollection in interface LocationPointDao
See Also:
LocationPointDao.remoteLocationPointNaturalIdToEntityCollection(java.util.Collection)

toRemoteLocationPointNaturalId

public void toRemoteLocationPointNaturalId(LocationPoint source,
                                           RemoteLocationPointNaturalId target)
Description copied from interface: LocationPointDao
Copies the fields of the specified entity to the target value object. This method is similar to toRemoteLocationPointNaturalId(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

Specified by:
toRemoteLocationPointNaturalId in interface LocationPointDao
See Also:
LocationPointDao.toRemoteLocationPointNaturalId(fr.ifremer.allegro.referential.location.LocationPoint, fr.ifremer.allegro.referential.location.generic.vo.RemoteLocationPointNaturalId)

toRemoteLocationPointNaturalId

public RemoteLocationPointNaturalId toRemoteLocationPointNaturalId(LocationPoint entity)
Description copied from interface: LocationPointDao
Converts this DAO's entity to an object of type RemoteLocationPointNaturalId.

Specified by:
toRemoteLocationPointNaturalId in interface LocationPointDao
See Also:
LocationPointDao.toRemoteLocationPointNaturalId(fr.ifremer.allegro.referential.location.LocationPoint)

remoteLocationPointNaturalIdToEntity

public void remoteLocationPointNaturalIdToEntity(RemoteLocationPointNaturalId source,
                                                 LocationPoint target,
                                                 boolean copyIfNull)
Description copied from interface: LocationPointDao
Copies the fields of RemoteLocationPointNaturalId to the specified entity.

Specified by:
remoteLocationPointNaturalIdToEntity in interface LocationPointDao
copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.
See Also:
fr.ifremer.allegro.referential.location.LocationPointDao#remoteLocationPointNaturalIdToEntity(fr.ifremer.allegro.referential.location.generic.vo.RemoteLocationPointNaturalId, fr.ifremer.allegro.referential.location.LocationPoint)

toClusterLocationPointCollection

public final void toClusterLocationPointCollection(java.util.Collection entities)
Description copied from interface: LocationPointDao
Converts this DAO's entity to a Collection of instances of type ClusterLocationPoint.

Specified by:
toClusterLocationPointCollection in interface LocationPointDao
See Also:
LocationPointDao.toClusterLocationPointCollection(java.util.Collection)

toClusterLocationPointArray

public final ClusterLocationPoint[] toClusterLocationPointArray(java.util.Collection entities)
Description copied from interface: LocationPointDao
Converts this DAO's entity to an array of instances of type ClusterLocationPoint.

Specified by:
toClusterLocationPointArray in interface LocationPointDao
See Also:
LocationPointDao.toClusterLocationPointArray(java.util.Collection)

toClusterLocationPoint

protected ClusterLocationPoint toClusterLocationPoint(java.lang.Object[] row)
Default implementation for transforming the results of a report query into a value object. This implementation exists for convenience reasons only. It needs only be overridden in the LocationPointDaoImpl class if you intend to use reporting queries.

See Also:
LocationPointDao.toClusterLocationPoint(fr.ifremer.allegro.referential.location.LocationPoint)

clusterLocationPointToEntityCollection

public final void clusterLocationPointToEntityCollection(java.util.Collection instances)
Description copied from interface: LocationPointDao
Converts a Collection of instances of type ClusterLocationPoint to this DAO's entity.

Specified by:
clusterLocationPointToEntityCollection in interface LocationPointDao
See Also:
LocationPointDao.clusterLocationPointToEntityCollection(java.util.Collection)

toClusterLocationPoint

public void toClusterLocationPoint(LocationPoint source,
                                   ClusterLocationPoint target)
Description copied from interface: LocationPointDao
Copies the fields of the specified entity to the target value object. This method is similar to toClusterLocationPoint(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

Specified by:
toClusterLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.toClusterLocationPoint(fr.ifremer.allegro.referential.location.LocationPoint, fr.ifremer.allegro.referential.location.generic.cluster.ClusterLocationPoint)

toClusterLocationPoint

public ClusterLocationPoint toClusterLocationPoint(LocationPoint entity)
Description copied from interface: LocationPointDao
Converts this DAO's entity to an object of type ClusterLocationPoint.

Specified by:
toClusterLocationPoint in interface LocationPointDao
See Also:
LocationPointDao.toClusterLocationPoint(fr.ifremer.allegro.referential.location.LocationPoint)

clusterLocationPointToEntity

public void clusterLocationPointToEntity(ClusterLocationPoint source,
                                         LocationPoint target,
                                         boolean copyIfNull)
Description copied from interface: LocationPointDao
Copies the fields of ClusterLocationPoint to the specified entity.

Specified by:
clusterLocationPointToEntity in interface LocationPointDao
copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.
See Also:
fr.ifremer.allegro.referential.location.LocationPointDao#clusterLocationPointToEntity(fr.ifremer.allegro.referential.location.generic.cluster.ClusterLocationPoint, fr.ifremer.allegro.referential.location.LocationPoint)

getPrincipal

protected java.security.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: LocationPointDao
Does the same thing as {@link #search(int, fr.ifremer.allegro.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.
See Also:
LocationPointDao.search(int, int, int, fr.ifremer.allegro.Search)

search

public PaginationResult search(int pageNumber,
                               int pageSize,
                               Search search)
Description copied from interface: LocationPointDao
Does the same thing as {@link #search(fr.ifremer.allegro.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.
See Also:
LocationPointDao.search(int, int, fr.ifremer.allegro.Search)

search

public java.util.Set search(int transform,
                            Search search)
Description copied from interface: LocationPointDao
Does the same thing as LocationPointDao.search(fr.ifremer.allegro.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.
See Also:
LocationPointDao.search(int, fr.ifremer.allegro.Search)

search

public java.util.Set search(Search search)
Description copied from interface: LocationPointDao
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.
See Also:
LocationPointDao.search(fr.ifremer.allegro.Search)


Copyright © 2008-2010 IFREMER. All Rights Reserved.