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

Interface LocationHierarchyDao

All Known Implementing Classes:

LocationHierarchyDaoBase, LocationHierarchyDaoImpl

public interface LocationHierarchyDao

See Also:

LocationHierarchy

Field Summary

Fields

Modifier and Type	Field and Description
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.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<LocationHierarchy>	create(Collection<LocationHierarchy> entities) Creates a new instance of LocationHierarchy and adds from the passed in entities collection
LocationHierarchy	create(Float childSurfaceRatio, Boolean isMainAssociation) Creates a new LocationHierarchy instance from all attributes and adds it to the persistent store.
LocationHierarchy	create(Float childSurfaceRatio, Boolean isMainAssociation, Location location, Location parent) Creates a new LocationHierarchy instance from only required properties (attributes and association ends) and adds it to the persistent store.
Collection<?>	create(int transform, Collection<LocationHierarchy> entities) Does the same thing as create(LocationHierarchy) with an additional flag called transform.
Object	create(int transform, Float childSurfaceRatio, Boolean isMainAssociation) Does the same thing as create(Float, Boolean) with an additional flag called transform.
Object	create(int transform, Float childSurfaceRatio, Boolean isMainAssociation, Location location, Location parent) Does the same thing as create(Float, Boolean) with an additional flag called transform.
Object	create(int transform, LocationHierarchy locationHierarchy) Does the same thing as create(LocationHierarchy) with an additional flag called transform.
LocationHierarchy	create(LocationHierarchy locationHierarchy) Creates an instance of LocationHierarchy and adds it to the persistent store.
Collection	findLocationHierarchiesByFatherId(Integer fatherId)
Collection	findLocationHierarchiesById(Integer id)
LocationHierarchy	findLocationHierarchyByIdentifiers(Integer id, Integer fatherId)
Object	get(int transform, LocationHierarchyPK locationHierarchyPk) Does the same thing as get(LocationHierarchyPK) with an additional flag called transform.
LocationHierarchy	get(LocationHierarchyPK locationHierarchyPk) Gets an instance of LocationHierarchy from the persistent store.
Object	load(int transform, LocationHierarchyPK locationHierarchyPk) Does the same thing as load(LocationHierarchyPK) with an additional flag called transform.
LocationHierarchy	load(LocationHierarchyPK locationHierarchyPk) Loads an instance of LocationHierarchy from the persistent store.
Collection<LocationHierarchy>	loadAll() Loads all entities of type LocationHierarchy.
Collection<?>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Collection<LocationHierarchy> entities) Removes all entities in the given entities collection.
void	remove(LocationHierarchy locationHierarchy) Removes the instance of LocationHierarchy from the persistent store.
void	remove(LocationHierarchyPK locationHierarchyPk) Removes the instance of LocationHierarchy having the given identifier from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as search(int, Search) but with an additional two flags called pageNumber and pageSize.
PaginationResult	search(int pageNumber, int pageSize, Search search) Does the same thing as search(Search) but with an additional two flags called pageNumber and pageSize.
Set<?>	search(int transform, Search search) Does the same thing as search(Search) but with an additional flag called transform.
Set<LocationHierarchy>	search(Search search) Performs a search using the parameters specified in the given search object.
void	toEntities(Collection<?> results) Transforms the given results to a collection of LocationHierarchy instances (this is useful when the returned results contains a row of data and you want just entities only).
void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,LocationHierarchy) method.
Object	transformEntity(int transform, LocationHierarchy entity) Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchyDao, please note that the TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<LocationHierarchy> entities) Updates all instances in the entities collection in the persistent store.
void	update(LocationHierarchy locationHierarchy) Updates the locationHierarchy instance in the persistent store.

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

Method Detail

toEntities

void toEntities(Collection<?> results)

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

Parameters:

results - the query results.

get

LocationHierarchy get(LocationHierarchyPK locationHierarchyPk)

Gets an instance of LocationHierarchy from the persistent store.

Parameters:

locationHierarchyPk -

Returns:

LocationHierarchy

get

Object get(int transform,
         LocationHierarchyPK locationHierarchyPk)

Does the same thing as get(LocationHierarchyPK) 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:

transform - flag to determine transformation type.

locationHierarchyPk - the identifier of the entity to get.

Returns:

either the entity or the object transformed from the entity.

load

LocationHierarchy load(LocationHierarchyPK locationHierarchyPk)

Loads an instance of LocationHierarchy from the persistent store.

Parameters:

locationHierarchyPk -

Returns:

LocationHierarchy

load

Object load(int transform,
          LocationHierarchyPK locationHierarchyPk)

Does the same thing as load(LocationHierarchyPK) 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:

transform - flag to determine transformation type.

locationHierarchyPk - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

loadAll

Collection<LocationHierarchy> loadAll()

Loads all entities of type LocationHierarchy.

Returns:

the loaded entities.

loadAll

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

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

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 LocationHierarchy and adds it to the persistent store.

Parameters:

locationHierarchy -

Returns:

LocationHierarchy

create

Object create(int transform,
            LocationHierarchy locationHierarchy)

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

Parameters:

transform -

locationHierarchy -

Returns:

Object

create

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

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

Parameters:

entities - the collection of LocationHierarchy instances to create.

Returns:

the created instances.

create

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

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

Parameters:

transform -

entities -

Returns:

Collection

create

LocationHierarchy create(Float childSurfaceRatio,
                       Boolean isMainAssociation)

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

Parameters:

childSurfaceRatio - Ratio de couverture (en surface) du lieu fils par rapport au lieu père. La valeur doit etre supérieure strictement à 0 et inférieur ou égale à 1. Déduit à partir de la valeur de LocationAssociation.childSurfaceRatio, selon un algorithme de parcours d'arbre (cf procedure stockée P_FILL_LOCATION_HIERARCHY)

isMainAssociation -

Indique si l'association est considérée comme la principale.

Dans le cas d'une zone en mer rattachée à plusieurs zones parente, cela permet de de récupérer qu'une seule zone (utiliser notamment pour le SIG SIH)

Returns:

LocationHierarchy

create

Object create(int transform,
            Float childSurfaceRatio,
            Boolean isMainAssociation)

Does the same thing as create(Float, Boolean) 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 -

childSurfaceRatio - Ratio de couverture (en surface) du lieu fils par rapport au lieu père. La valeur doit etre supérieure strictement à 0 et inférieur ou égale à 1. Déduit à partir de la valeur de LocationAssociation.childSurfaceRatio, selon un algorithme de parcours d'arbre (cf procedure stockée P_FILL_LOCATION_HIERARCHY)

isMainAssociation -

Indique si l'association est considérée comme la principale.

Dans le cas d'une zone en mer rattachée à plusieurs zones parente, cela permet de de récupérer qu'une seule zone (utiliser notamment pour le SIG SIH)

Returns:

LocationHierarchy

create

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

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

Parameters:

childSurfaceRatio -

isMainAssociation -

location -

parent -

Returns:

LocationHierarchy

create

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

Does the same thing as create(Float, Boolean) 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 - flag to determine transformation type.

childSurfaceRatio -

isMainAssociation -

location -

parent -

Returns:

Object

update

void update(LocationHierarchy locationHierarchy)

Updates the locationHierarchy instance in the persistent store.

Parameters:

locationHierarchy -

update

void update(Collection<LocationHierarchy> entities)

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

Parameters:

entities -

remove

void remove(LocationHierarchy locationHierarchy)

Removes the instance of LocationHierarchy from the persistent store.

Parameters:

locationHierarchy -

remove

void remove(LocationHierarchyPK locationHierarchyPk)

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

Parameters:

locationHierarchyPk -

remove

void remove(Collection<LocationHierarchy> entities)

Removes all entities in the given entities collection.

Parameters:

entities -

findLocationHierarchyByIdentifiers

LocationHierarchy findLocationHierarchyByIdentifiers(Integer id,
                                                   Integer fatherId)

Parameters:

id -

fatherId -

Returns:

LocationHierarchy

findLocationHierarchiesById

Collection findLocationHierarchiesById(Integer id)

Parameters:

id -

Returns:

Collection

findLocationHierarchiesByFatherId

Collection findLocationHierarchiesByFatherId(Integer fatherId)

Parameters:

fatherId -

Returns:

Collection

search

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

Does the same thing as search(int, Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size.

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 search(Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size.

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

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

Does the same thing as search(Search) but with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

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

Set<LocationHierarchy> 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.

transformEntity

Object transformEntity(int transform,
                     LocationHierarchy entity)

Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchyDao, please note that the TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown TRANSFORM_NONE is assumed.

Parameters:

transform - one of the constants declared in LocationHierarchyDao

entity - an entity that was found

Returns:

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

See Also:

transformEntities(int,Collection)

transformEntities

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

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

This method is to be used internally only.

Parameters:

transform - one of the constants declared in fr.ifremer.adagio.core.dao.technical.optimization.location.LocationHierarchyDao

entities - the collection of entities to transform

See Also:

transformEntity(int,LocationHierarchy)