fr.ifremer.allegro.technical.optimization.location
Interface LocationHierarchyDao

All Known Implementing Classes:
LocationHierarchyDaoBase, LocationHierarchyDaoImpl

public interface LocationHierarchyDao

See Also:
LocationHierarchy

Field Summary
static int TRANSFORM_CLUSTERLOCATIONHIERARCHY
          This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.
static int TRANSFORM_NONE
          This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.
static int TRANSFORM_REMOTELOCATIONHIERARCHYFULLVO
          This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.
static int TRANSFORM_REMOTELOCATIONHIERARCHYNATURALID
          This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.
 
Method Summary
 LocationHierarchy clusterLocationHierarchyToEntity(ClusterLocationHierarchy clusterLocationHierarchy)
          Converts an instance of type ClusterLocationHierarchy to this DAO's entity.
 void clusterLocationHierarchyToEntity(ClusterLocationHierarchy source, LocationHierarchy target, boolean copyIfNull)
          Copies the fields of ClusterLocationHierarchy to the specified entity.
 void clusterLocationHierarchyToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type ClusterLocationHierarchy to this DAO's entity.
 java.util.Collection create(java.util.Collection entities)
          Creates a new instance of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy and adds from the passed in entities collection
 LocationHierarchy create(java.lang.Float childSurfaceRatio, Location location, Location parent)
           Creates a new fr.ifremer.allegro.technical.optimization.location.LocationHierarchy instance from all attributes and properties and adds it to the persistent store.
 java.util.Collection create(int transform, java.util.Collection entities)
           Does the same thing as create(fr.ifremer.allegro.technical.optimization.location.LocationHierarchy) with an additional flag called transform.
 java.lang.Object create(int transform, java.lang.Float childSurfaceRatio, Location location, Location parent)
           Does the same thing as create(java.lang.Float,fr.ifremer.allegro.referential.location.Location,fr.ifremer.allegro.referential.location.Location) with an additional flag called transform.
 java.lang.Object create(int transform, LocationHierarchy locationHierarchy)
           Does the same thing as create(fr.ifremer.allegro.technical.optimization.location.LocationHierarchy) with an additional flag called transform.
 LocationHierarchy create(LocationHierarchy locationHierarchy)
          Creates an instance of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy and adds it to the persistent store.
 LocationHierarchy createFromClusterLocationHierarchy(ClusterLocationHierarchy clusterLocationHierarchy)
           
 java.util.Collection findLocationHierarchiesByFatherId(java.lang.Integer fatherId)
           
 java.util.Collection findLocationHierarchiesByFatherId(int transform, java.lang.Integer fatherId)
           Does the same thing as findLocationHierarchiesByFatherId(java.lang.Integer) with an additional flag called transform.
 java.util.Collection findLocationHierarchiesByFatherId(int pageNumber, int pageSize, java.lang.Integer fatherId)
           Does the same thing as findLocationHierarchiesByFatherId(java.lang.Integer) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchiesByFatherId(int transform, int pageNumber, int pageSize, java.lang.Integer fatherId)
           Does the same thing as findLocationHierarchiesByFatherId(int, java.lang.Integer) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchiesByFatherId(int transform, java.lang.String queryString, java.lang.Integer fatherId)
           Does the same thing as findLocationHierarchiesByFatherId(int, java.lang.Integer) with an additional argument called queryString.
 java.util.Collection findLocationHierarchiesByFatherId(int transform, java.lang.String queryString, int pageNumber, int pageSize, java.lang.Integer fatherId)
           Does the same thing as findLocationHierarchiesByFatherId(int, String, java.lang.Integer) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchiesByFatherId(java.lang.String queryString, java.lang.Integer fatherId)
           Does the same thing as findLocationHierarchiesByFatherId(java.lang.Integer) with an additional argument called queryString.
 java.util.Collection findLocationHierarchiesByFatherId(java.lang.String queryString, int pageNumber, int pageSize, java.lang.Integer fatherId)
           Does the same thing as findLocationHierarchiesByFatherId(String, java.lang.Integer) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchiesById(java.lang.Integer id)
           
 java.util.Collection findLocationHierarchiesById(int transform, java.lang.Integer id)
           Does the same thing as findLocationHierarchiesById(java.lang.Integer) with an additional flag called transform.
 java.util.Collection findLocationHierarchiesById(int pageNumber, int pageSize, java.lang.Integer id)
           Does the same thing as findLocationHierarchiesById(java.lang.Integer) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchiesById(int transform, int pageNumber, int pageSize, java.lang.Integer id)
           Does the same thing as findLocationHierarchiesById(int, java.lang.Integer) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchiesById(int transform, java.lang.String queryString, java.lang.Integer id)
           Does the same thing as findLocationHierarchiesById(int, java.lang.Integer) with an additional argument called queryString.
 java.util.Collection findLocationHierarchiesById(int transform, java.lang.String queryString, int pageNumber, int pageSize, java.lang.Integer id)
           Does the same thing as findLocationHierarchiesById(int, String, java.lang.Integer) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchiesById(java.lang.String queryString, java.lang.Integer id)
           Does the same thing as findLocationHierarchiesById(java.lang.Integer) with an additional argument called queryString.
 java.util.Collection findLocationHierarchiesById(java.lang.String queryString, int pageNumber, int pageSize, java.lang.Integer id)
           Does the same thing as findLocationHierarchiesById(String, java.lang.Integer) with an additional two arguments called pageNumber and pageSize.
 LocationHierarchy findLocationHierarchyByIdentifiers(java.lang.Integer id, java.lang.Integer fatherId)
           
 java.lang.Object findLocationHierarchyByIdentifiers(int transform, java.lang.Integer id, java.lang.Integer fatherId)
           Does the same thing as findLocationHierarchyByIdentifiers(java.lang.Integer, java.lang.Integer) with an additional flag called transform.
 java.lang.Object findLocationHierarchyByIdentifiers(int transform, Location location, Location parent)
           Does the same thing as findLocationHierarchyByIdentifiers(fr.ifremer.allegro.referential.location.Location, fr.ifremer.allegro.referential.location.Location) with an additional flag called transform.
 java.lang.Object findLocationHierarchyByIdentifiers(int transform, java.lang.String queryString, java.lang.Integer id, java.lang.Integer fatherId)
           Does the same thing as findLocationHierarchyByIdentifiers(int, java.lang.Integer, java.lang.Integer) with an additional argument called queryString.
 java.lang.Object findLocationHierarchyByIdentifiers(int transform, java.lang.String queryString, Location location, Location parent)
           Does the same thing as findLocationHierarchyByIdentifiers(int, fr.ifremer.allegro.referential.location.Location, fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString.
 LocationHierarchy findLocationHierarchyByIdentifiers(Location location, Location parent)
           
 LocationHierarchy findLocationHierarchyByIdentifiers(java.lang.String queryString, java.lang.Integer id, java.lang.Integer fatherId)
           Does the same thing as findLocationHierarchyByIdentifiers(java.lang.Integer, java.lang.Integer) with an additional argument called queryString.
 LocationHierarchy findLocationHierarchyByIdentifiers(java.lang.String queryString, Location location, Location parent)
           Does the same thing as findLocationHierarchyByIdentifiers(fr.ifremer.allegro.referential.location.Location, fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString.
 java.util.Collection findLocationHierarchyByLocation(int transform, int pageNumber, int pageSize, Location location)
           Does the same thing as findLocationHierarchyByLocation(int, fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchyByLocation(int pageNumber, int pageSize, Location location)
           Does the same thing as findLocationHierarchyByLocation(fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchyByLocation(int transform, Location location)
           Does the same thing as findLocationHierarchyByLocation(fr.ifremer.allegro.referential.location.Location) with an additional flag called transform.
 java.util.Collection findLocationHierarchyByLocation(int transform, java.lang.String queryString, int pageNumber, int pageSize, Location location)
           Does the same thing as findLocationHierarchyByLocation(int, String, fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchyByLocation(int transform, java.lang.String queryString, Location location)
           Does the same thing as findLocationHierarchyByLocation(int, fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString.
 java.util.Collection findLocationHierarchyByLocation(Location location)
           
 java.util.Collection findLocationHierarchyByLocation(java.lang.String queryString, int pageNumber, int pageSize, Location location)
           Does the same thing as findLocationHierarchyByLocation(String, fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationHierarchyByLocation(java.lang.String queryString, Location location)
           Does the same thing as findLocationHierarchyByLocation(fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString.
 java.lang.Object findLocationHierarchyByNaturalId(int transform, Location location, Location parent)
           Does the same thing as findLocationHierarchyByNaturalId(fr.ifremer.allegro.referential.location.Location, fr.ifremer.allegro.referential.location.Location) with an additional flag called transform.
 java.lang.Object findLocationHierarchyByNaturalId(int transform, java.lang.String queryString, Location location, Location parent)
           Does the same thing as findLocationHierarchyByNaturalId(int, fr.ifremer.allegro.referential.location.Location, fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString.
 LocationHierarchy findLocationHierarchyByNaturalId(Location location, Location parent)
           
 LocationHierarchy findLocationHierarchyByNaturalId(java.lang.String queryString, Location location, Location parent)
           Does the same thing as findLocationHierarchyByNaturalId(fr.ifremer.allegro.referential.location.Location, fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString.
 java.util.Collection getAllLocationHierarchy()
           
 java.util.Collection getAllLocationHierarchy(int transform)
           Does the same thing as getAllLocationHierarchy() with an additional flag called transform.
 java.util.Collection getAllLocationHierarchy(int pageNumber, int pageSize)
           Does the same thing as getAllLocationHierarchy() with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllLocationHierarchy(int transform, int pageNumber, int pageSize)
           Does the same thing as getAllLocationHierarchy(int) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllLocationHierarchy(int transform, java.lang.String queryString)
           Does the same thing as getAllLocationHierarchy(int) with an additional argument called queryString.
 java.util.Collection getAllLocationHierarchy(int transform, java.lang.String queryString, int pageNumber, int pageSize)
           Does the same thing as getAllLocationHierarchy(int, String) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllLocationHierarchy(java.lang.String queryString)
           Does the same thing as getAllLocationHierarchy() with an additional argument called queryString.
 java.util.Collection getAllLocationHierarchy(java.lang.String queryString, int pageNumber, int pageSize)
           Does the same thing as getAllLocationHierarchy(String) with an additional two arguments called pageNumber and pageSize.
 java.lang.Object load(int transform, Location location, Location parent)
           Does the same thing as load(fr.ifremer.allegro.referential.location.Location,fr.ifremer.allegro.referential.location.Location) with an additional flag called transform.
 LocationHierarchy load(Location location, Location parent)
          Loads an instance of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy from the persistent store.
 java.util.Collection loadAll()
          Loads all entities of type LocationHierarchy.
 java.util.Collection loadAll(int transform)
           Does the same thing as loadAll() with an additional flag called transform.
 java.util.Collection loadAll(int pageNumber, int pageSize)
           Does the same thing as 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 loadAll(int) with an additional two arguments called pageNumber and pageSize.
 LocationHierarchy remoteLocationHierarchyFullVOToEntity(RemoteLocationHierarchyFullVO remoteLocationHierarchyFullVO)
          Converts an instance of type RemoteLocationHierarchyFullVO to this DAO's entity.
 void remoteLocationHierarchyFullVOToEntity(RemoteLocationHierarchyFullVO source, LocationHierarchy target, boolean copyIfNull)
          Copies the fields of RemoteLocationHierarchyFullVO to the specified entity.
 void remoteLocationHierarchyFullVOToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type RemoteLocationHierarchyFullVO to this DAO's entity.
 LocationHierarchy remoteLocationHierarchyNaturalIdToEntity(RemoteLocationHierarchyNaturalId remoteLocationHierarchyNaturalId)
          Converts an instance of type RemoteLocationHierarchyNaturalId to this DAO's entity.
 void remoteLocationHierarchyNaturalIdToEntity(RemoteLocationHierarchyNaturalId source, LocationHierarchy target, boolean copyIfNull)
          Copies the fields of RemoteLocationHierarchyNaturalId to the specified entity.
 void remoteLocationHierarchyNaturalIdToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type RemoteLocationHierarchyNaturalId to this DAO's entity.
 void remove(java.util.Collection entities)
          Removes all entities in the given entities collection.
 void remove(LocationHierarchy locationHierarchy)
          Removes the instance of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy from the persistent store.
 void remove(Location location, Location parent)
          Removes the instance of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy having the given identifiers from the persistent store.
 PaginationResult search(int transform, int pageNumber, int pageSize, Search search)
          Does the same thing as {@link #search(int, fr.ifremer.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 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.
 ClusterLocationHierarchy toClusterLocationHierarchy(LocationHierarchy entity)
          Converts this DAO's entity to an object of type ClusterLocationHierarchy.
 void toClusterLocationHierarchy(LocationHierarchy source, ClusterLocationHierarchy target)
          Copies the fields of the specified entity to the target value object.
 ClusterLocationHierarchy[] toClusterLocationHierarchyArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type ClusterLocationHierarchy.
 void toClusterLocationHierarchyCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type ClusterLocationHierarchy.
 RemoteLocationHierarchyFullVO toRemoteLocationHierarchyFullVO(LocationHierarchy entity)
          Converts this DAO's entity to an object of type RemoteLocationHierarchyFullVO.
 void toRemoteLocationHierarchyFullVO(LocationHierarchy source, RemoteLocationHierarchyFullVO target)
          Copies the fields of the specified entity to the target value object.
 RemoteLocationHierarchyFullVO[] toRemoteLocationHierarchyFullVOArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type RemoteLocationHierarchyFullVO.
 void toRemoteLocationHierarchyFullVOCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type RemoteLocationHierarchyFullVO.
 RemoteLocationHierarchyNaturalId toRemoteLocationHierarchyNaturalId(LocationHierarchy entity)
          Converts this DAO's entity to an object of type RemoteLocationHierarchyNaturalId.
 void toRemoteLocationHierarchyNaturalId(LocationHierarchy source, RemoteLocationHierarchyNaturalId target)
          Copies the fields of the specified entity to the target value object.
 RemoteLocationHierarchyNaturalId[] toRemoteLocationHierarchyNaturalIdArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type RemoteLocationHierarchyNaturalId.
 void toRemoteLocationHierarchyNaturalIdCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type RemoteLocationHierarchyNaturalId.
 void update(java.util.Collection entities)
          Updates all instances in the entities collection in the persistent store.
 void update(LocationHierarchy locationHierarchy)
          Updates the locationHierarchy instance in the persistent store.
 

Field Detail

TRANSFORM_NONE

static final int TRANSFORM_NONE
This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes no transformation will occur.

See Also:
Constant Field Values

TRANSFORM_REMOTELOCATIONHIERARCHYFULLVO

static final int TRANSFORM_REMOTELOCATIONHIERARCHYFULLVO
This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes entities must be transformed into objects of type RemoteLocationHierarchyFullVO.

See Also:
Constant Field Values

TRANSFORM_REMOTELOCATIONHIERARCHYNATURALID

static final int TRANSFORM_REMOTELOCATIONHIERARCHYNATURALID
This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes entities must be transformed into objects of type RemoteLocationHierarchyNaturalId.

See Also:
Constant Field Values

TRANSFORM_CLUSTERLOCATIONHIERARCHY

static final int TRANSFORM_CLUSTERLOCATIONHIERARCHY
This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes entities must be transformed into objects of type ClusterLocationHierarchy.

See Also:
Constant Field Values
Method Detail

toRemoteLocationHierarchyFullVO

void toRemoteLocationHierarchyFullVO(LocationHierarchy source,
                                     RemoteLocationHierarchyFullVO target)
Copies the fields of the specified entity to the target value object. This method is similar to toRemoteLocationHierarchyFullVO(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).


toRemoteLocationHierarchyFullVO

RemoteLocationHierarchyFullVO toRemoteLocationHierarchyFullVO(LocationHierarchy entity)
Converts this DAO's entity to an object of type RemoteLocationHierarchyFullVO.


toRemoteLocationHierarchyFullVOCollection

void toRemoteLocationHierarchyFullVOCollection(java.util.Collection entities)
Converts this DAO's entity to a Collection of instances of type RemoteLocationHierarchyFullVO.


toRemoteLocationHierarchyFullVOArray

RemoteLocationHierarchyFullVO[] toRemoteLocationHierarchyFullVOArray(java.util.Collection entities)
Converts this DAO's entity to an array of instances of type RemoteLocationHierarchyFullVO.


remoteLocationHierarchyFullVOToEntity

void remoteLocationHierarchyFullVOToEntity(RemoteLocationHierarchyFullVO source,
                                           LocationHierarchy target,
                                           boolean copyIfNull)
Copies the fields of RemoteLocationHierarchyFullVO to the specified entity.

Parameters:
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.

remoteLocationHierarchyFullVOToEntity

LocationHierarchy remoteLocationHierarchyFullVOToEntity(RemoteLocationHierarchyFullVO remoteLocationHierarchyFullVO)
Converts an instance of type RemoteLocationHierarchyFullVO to this DAO's entity.


remoteLocationHierarchyFullVOToEntityCollection

void remoteLocationHierarchyFullVOToEntityCollection(java.util.Collection instances)
Converts a Collection of instances of type RemoteLocationHierarchyFullVO to this DAO's entity.


toRemoteLocationHierarchyNaturalId

void toRemoteLocationHierarchyNaturalId(LocationHierarchy source,
                                        RemoteLocationHierarchyNaturalId target)
Copies the fields of the specified entity to the target value object. This method is similar to toRemoteLocationHierarchyNaturalId(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).


toRemoteLocationHierarchyNaturalId

RemoteLocationHierarchyNaturalId toRemoteLocationHierarchyNaturalId(LocationHierarchy entity)
Converts this DAO's entity to an object of type RemoteLocationHierarchyNaturalId.


toRemoteLocationHierarchyNaturalIdCollection

void toRemoteLocationHierarchyNaturalIdCollection(java.util.Collection entities)
Converts this DAO's entity to a Collection of instances of type RemoteLocationHierarchyNaturalId.


toRemoteLocationHierarchyNaturalIdArray

RemoteLocationHierarchyNaturalId[] toRemoteLocationHierarchyNaturalIdArray(java.util.Collection entities)
Converts this DAO's entity to an array of instances of type RemoteLocationHierarchyNaturalId.


remoteLocationHierarchyNaturalIdToEntity

void remoteLocationHierarchyNaturalIdToEntity(RemoteLocationHierarchyNaturalId source,
                                              LocationHierarchy target,
                                              boolean copyIfNull)
Copies the fields of RemoteLocationHierarchyNaturalId to the specified entity.

Parameters:
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.

remoteLocationHierarchyNaturalIdToEntity

LocationHierarchy remoteLocationHierarchyNaturalIdToEntity(RemoteLocationHierarchyNaturalId remoteLocationHierarchyNaturalId)
Converts an instance of type RemoteLocationHierarchyNaturalId to this DAO's entity.


remoteLocationHierarchyNaturalIdToEntityCollection

void remoteLocationHierarchyNaturalIdToEntityCollection(java.util.Collection instances)
Converts a Collection of instances of type RemoteLocationHierarchyNaturalId to this DAO's entity.


toClusterLocationHierarchy

void toClusterLocationHierarchy(LocationHierarchy source,
                                ClusterLocationHierarchy target)
Copies the fields of the specified entity to the target value object. This method is similar to toClusterLocationHierarchy(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).


toClusterLocationHierarchy

ClusterLocationHierarchy toClusterLocationHierarchy(LocationHierarchy entity)
Converts this DAO's entity to an object of type ClusterLocationHierarchy.


toClusterLocationHierarchyCollection

void toClusterLocationHierarchyCollection(java.util.Collection entities)
Converts this DAO's entity to a Collection of instances of type ClusterLocationHierarchy.


toClusterLocationHierarchyArray

ClusterLocationHierarchy[] toClusterLocationHierarchyArray(java.util.Collection entities)
Converts this DAO's entity to an array of instances of type ClusterLocationHierarchy.


clusterLocationHierarchyToEntity

void clusterLocationHierarchyToEntity(ClusterLocationHierarchy source,
                                      LocationHierarchy target,
                                      boolean copyIfNull)
Copies the fields of ClusterLocationHierarchy to the specified entity.

Parameters:
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.

clusterLocationHierarchyToEntity

LocationHierarchy clusterLocationHierarchyToEntity(ClusterLocationHierarchy clusterLocationHierarchy)
Converts an instance of type ClusterLocationHierarchy to this DAO's entity.


clusterLocationHierarchyToEntityCollection

void clusterLocationHierarchyToEntityCollection(java.util.Collection instances)
Converts a Collection of instances of type ClusterLocationHierarchy to this DAO's entity.


load

LocationHierarchy load(Location location,
                       Location parent)
Loads an instance of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy from the persistent store.


load

java.lang.Object load(int transform,
                      Location location,
                      Location parent)

Does the same thing as load(fr.ifremer.allegro.referential.location.Location,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 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.

Parameters:
location - identifier of the entity to load
parent - identifier of the entity to load
Returns:
either the entity or the object transformed from the entity.

loadAll

java.util.Collection loadAll()
Loads all entities of type LocationHierarchy.

Returns:
the loaded entities.

loadAll

java.util.Collection loadAll(int transform)

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

Parameters:
transform - the flag indicating what transformation to use.
Returns:
the loaded entities.

loadAll

java.util.Collection loadAll(int pageNumber,
                             int pageSize)

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

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

java.util.Collection loadAll(int transform,
                             int pageNumber,
                             int pageSize)

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

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.

create

LocationHierarchy create(LocationHierarchy locationHierarchy)
Creates an instance of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy and adds it to the persistent store.


create

java.lang.Object create(int transform,
                        LocationHierarchy locationHierarchy)

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


create

java.util.Collection create(java.util.Collection entities)
Creates a new instance of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy and adds from the passed in entities collection

Parameters:
entities - the collection of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy instances to create.
Returns:
the created instances.

create

java.util.Collection create(int transform,
                            java.util.Collection entities)

Does the same thing as create(fr.ifremer.allegro.technical.optimization.location.LocationHierarchy) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.


create

LocationHierarchy create(java.lang.Float childSurfaceRatio,
                         Location location,
                         Location parent)

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


create

java.lang.Object create(int transform,
                        java.lang.Float childSurfaceRatio,
                        Location location,
                        Location parent)

Does the same thing as create(java.lang.Float,fr.ifremer.allegro.referential.location.Location,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.


update

void update(LocationHierarchy locationHierarchy)
Updates the locationHierarchy instance in the persistent store.


update

void update(java.util.Collection entities)
Updates all instances in the entities collection in the persistent store.


remove

void remove(LocationHierarchy locationHierarchy)
Removes the instance of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy from the persistent store.


remove

void remove(Location location,
            Location parent)
Removes the instance of fr.ifremer.allegro.technical.optimization.location.LocationHierarchy having the given identifiers from the persistent store.


remove

void remove(java.util.Collection entities)
Removes all entities in the given entities collection.


findLocationHierarchyByIdentifiers

LocationHierarchy findLocationHierarchyByIdentifiers(java.lang.Integer id,
                                                     java.lang.Integer fatherId)

findLocationHierarchyByIdentifiers

LocationHierarchy findLocationHierarchyByIdentifiers(java.lang.String queryString,
                                                     java.lang.Integer id,
                                                     java.lang.Integer fatherId)

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


findLocationHierarchyByIdentifiers

java.lang.Object findLocationHierarchyByIdentifiers(int transform,
                                                    java.lang.Integer id,
                                                    java.lang.Integer fatherId)

Does the same thing as findLocationHierarchyByIdentifiers(java.lang.Integer, 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.


findLocationHierarchyByIdentifiers

java.lang.Object findLocationHierarchyByIdentifiers(int transform,
                                                    java.lang.String queryString,
                                                    java.lang.Integer id,
                                                    java.lang.Integer fatherId)

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


findLocationHierarchiesById

java.util.Collection findLocationHierarchiesById(java.lang.Integer id)

findLocationHierarchiesById

java.util.Collection findLocationHierarchiesById(java.lang.String queryString,
                                                 java.lang.Integer id)

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


findLocationHierarchiesById

java.util.Collection findLocationHierarchiesById(int pageNumber,
                                                 int pageSize,
                                                 java.lang.Integer id)

Does the same thing as findLocationHierarchiesById(java.lang.Integer) 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.


findLocationHierarchiesById

java.util.Collection findLocationHierarchiesById(java.lang.String queryString,
                                                 int pageNumber,
                                                 int pageSize,
                                                 java.lang.Integer id)

Does the same thing as findLocationHierarchiesById(String, java.lang.Integer) 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.


findLocationHierarchiesById

java.util.Collection findLocationHierarchiesById(int transform,
                                                 java.lang.Integer id)

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


findLocationHierarchiesById

java.util.Collection findLocationHierarchiesById(int transform,
                                                 int pageNumber,
                                                 int pageSize,
                                                 java.lang.Integer id)

Does the same thing as findLocationHierarchiesById(int, java.lang.Integer) 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.


findLocationHierarchiesById

java.util.Collection findLocationHierarchiesById(int transform,
                                                 java.lang.String queryString,
                                                 java.lang.Integer id)

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


findLocationHierarchiesById

java.util.Collection findLocationHierarchiesById(int transform,
                                                 java.lang.String queryString,
                                                 int pageNumber,
                                                 int pageSize,
                                                 java.lang.Integer id)

Does the same thing as findLocationHierarchiesById(int, String, java.lang.Integer) 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.


findLocationHierarchiesByFatherId

java.util.Collection findLocationHierarchiesByFatherId(java.lang.Integer fatherId)

findLocationHierarchiesByFatherId

java.util.Collection findLocationHierarchiesByFatherId(java.lang.String queryString,
                                                       java.lang.Integer fatherId)

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


findLocationHierarchiesByFatherId

java.util.Collection findLocationHierarchiesByFatherId(int pageNumber,
                                                       int pageSize,
                                                       java.lang.Integer fatherId)

Does the same thing as findLocationHierarchiesByFatherId(java.lang.Integer) 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.


findLocationHierarchiesByFatherId

java.util.Collection findLocationHierarchiesByFatherId(java.lang.String queryString,
                                                       int pageNumber,
                                                       int pageSize,
                                                       java.lang.Integer fatherId)

Does the same thing as findLocationHierarchiesByFatherId(String, java.lang.Integer) 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.


findLocationHierarchiesByFatherId

java.util.Collection findLocationHierarchiesByFatherId(int transform,
                                                       java.lang.Integer fatherId)

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


findLocationHierarchiesByFatherId

java.util.Collection findLocationHierarchiesByFatherId(int transform,
                                                       int pageNumber,
                                                       int pageSize,
                                                       java.lang.Integer fatherId)

Does the same thing as findLocationHierarchiesByFatherId(int, java.lang.Integer) 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.


findLocationHierarchiesByFatherId

java.util.Collection findLocationHierarchiesByFatherId(int transform,
                                                       java.lang.String queryString,
                                                       java.lang.Integer fatherId)

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


findLocationHierarchiesByFatherId

java.util.Collection findLocationHierarchiesByFatherId(int transform,
                                                       java.lang.String queryString,
                                                       int pageNumber,
                                                       int pageSize,
                                                       java.lang.Integer fatherId)

Does the same thing as findLocationHierarchiesByFatherId(int, String, java.lang.Integer) 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.


getAllLocationHierarchy

java.util.Collection getAllLocationHierarchy()

getAllLocationHierarchy

java.util.Collection getAllLocationHierarchy(java.lang.String queryString)

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


getAllLocationHierarchy

java.util.Collection getAllLocationHierarchy(int pageNumber,
                                             int pageSize)

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


getAllLocationHierarchy

java.util.Collection getAllLocationHierarchy(java.lang.String queryString,
                                             int pageNumber,
                                             int pageSize)

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


getAllLocationHierarchy

java.util.Collection getAllLocationHierarchy(int transform)

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


getAllLocationHierarchy

java.util.Collection getAllLocationHierarchy(int transform,
                                             int pageNumber,
                                             int pageSize)

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


getAllLocationHierarchy

java.util.Collection getAllLocationHierarchy(int transform,
                                             java.lang.String queryString)

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


getAllLocationHierarchy

java.util.Collection getAllLocationHierarchy(int transform,
                                             java.lang.String queryString,
                                             int pageNumber,
                                             int pageSize)

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


findLocationHierarchyByLocation

java.util.Collection findLocationHierarchyByLocation(Location location)

findLocationHierarchyByLocation

java.util.Collection findLocationHierarchyByLocation(java.lang.String queryString,
                                                     Location location)

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


findLocationHierarchyByLocation

java.util.Collection findLocationHierarchyByLocation(int pageNumber,
                                                     int pageSize,
                                                     Location location)

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


findLocationHierarchyByLocation

java.util.Collection findLocationHierarchyByLocation(java.lang.String queryString,
                                                     int pageNumber,
                                                     int pageSize,
                                                     Location location)

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


findLocationHierarchyByLocation

java.util.Collection findLocationHierarchyByLocation(int transform,
                                                     Location location)

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


findLocationHierarchyByLocation

java.util.Collection findLocationHierarchyByLocation(int transform,
                                                     int pageNumber,
                                                     int pageSize,
                                                     Location location)

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


findLocationHierarchyByLocation

java.util.Collection findLocationHierarchyByLocation(int transform,
                                                     java.lang.String queryString,
                                                     Location location)

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


findLocationHierarchyByLocation

java.util.Collection findLocationHierarchyByLocation(int transform,
                                                     java.lang.String queryString,
                                                     int pageNumber,
                                                     int pageSize,
                                                     Location location)

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


findLocationHierarchyByIdentifiers

LocationHierarchy findLocationHierarchyByIdentifiers(Location location,
                                                     Location parent)

findLocationHierarchyByIdentifiers

LocationHierarchy findLocationHierarchyByIdentifiers(java.lang.String queryString,
                                                     Location location,
                                                     Location parent)

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


findLocationHierarchyByIdentifiers

java.lang.Object findLocationHierarchyByIdentifiers(int transform,
                                                    Location location,
                                                    Location parent)

Does the same thing as findLocationHierarchyByIdentifiers(fr.ifremer.allegro.referential.location.Location, 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.


findLocationHierarchyByIdentifiers

java.lang.Object findLocationHierarchyByIdentifiers(int transform,
                                                    java.lang.String queryString,
                                                    Location location,
                                                    Location parent)

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


findLocationHierarchyByNaturalId

LocationHierarchy findLocationHierarchyByNaturalId(Location location,
                                                   Location parent)

findLocationHierarchyByNaturalId

LocationHierarchy findLocationHierarchyByNaturalId(java.lang.String queryString,
                                                   Location location,
                                                   Location parent)

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


findLocationHierarchyByNaturalId

java.lang.Object findLocationHierarchyByNaturalId(int transform,
                                                  Location location,
                                                  Location parent)

Does the same thing as findLocationHierarchyByNaturalId(fr.ifremer.allegro.referential.location.Location, 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.


findLocationHierarchyByNaturalId

java.lang.Object findLocationHierarchyByNaturalId(int transform,
                                                  java.lang.String queryString,
                                                  Location location,
                                                  Location parent)

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


createFromClusterLocationHierarchy

LocationHierarchy createFromClusterLocationHierarchy(ClusterLocationHierarchy clusterLocationHierarchy)

search

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. These flags allow you to limit your data to a specified page number and size.

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

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. These flags allow you to limit your data to a specified page number and size.

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

java.util.Set search(int transform,
                     Search search)
Does the same thing as 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.

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

java.util.Set search(Search search)
Performs a search using the parameters specified in the given search object.

Parameters:
search - the search object which provides the search parameters and pagination specification.
Returns:
any found results from the search.


Copyright © 2008-2010 IFREMER. All Rights Reserved.