fr.ifremer.adagio.core.dao.referential.grouping

Interface GroupingDao

All Known Implementing Classes:

GroupingDaoBase, GroupingDaoImpl

public interface GroupingDao

Un regroupement représente un groupement d'entités (du référentiel ou bien de navires), correspondant à un niveau de regroupement donné (GroupingLevel).

Un regroupement peut faire référence à une ou plusieurs entités du référentiel (GroupingItem). Généralement, surtout les regroupements de plus bas niveau sont liés à des entités du référentiel (plus facile à maintenir), puis une table technique remplie toutes les associations possible avec les ancêtres (cf GroupingItemHierarchy).

Un regroupement peut avoir un regroupement parent.

See Also:

Grouping

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<Grouping>	create(Collection<Grouping> entities) Creates a new instance of Grouping and adds from the passed in entities collection
Grouping	create(Grouping grouping) Creates an instance of Grouping and adds it to the persistent store.
Grouping	create(GroupingClassification groupingClassification, GroupingLevel groupingLevel, String label, String name, Status status) Creates a new Grouping instance from only required properties (attributes and association ends) and adds it to the persistent store.
Collection<?>	create(int transform, Collection<Grouping> entities) Does the same thing as create(Grouping) with an additional flag called transform.
Object	create(int transform, Grouping grouping) Does the same thing as create(Grouping) with an additional flag called transform.
Object	create(int transform, GroupingClassification groupingClassification, GroupingLevel groupingLevel, String label, String name, Status status) Does the same thing as #create(String, String) with an additional flag called transform.
Object	create(int transform, String label, String name, Double minValue, Double maxValue, Timestamp updateDate) Does the same thing as create(String, String, Double, Double, Timestamp) with an additional flag called transform.
Grouping	create(String label, String name, Double minValue, Double maxValue, Timestamp updateDate) Creates a new Grouping instance from all attributes and adds it to the persistent store.
Grouping	get(Integer id) Gets an instance of Grouping from the persistent store.
Object	get(int transform, Integer id) Does the same thing as get(Integer) with an additional flag called transform.
Grouping	load(Integer id) Loads an instance of Grouping from the persistent store.
Object	load(int transform, Integer id) Does the same thing as load(Integer) with an additional flag called transform.
Collection<Grouping>	loadAll() Loads all entities of type Grouping.
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<Grouping> entities) Removes all entities in the given entities collection.
void	remove(Grouping grouping) Removes the instance of Grouping from the persistent store.
void	remove(Integer id) Removes the instance of Grouping 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<Grouping>	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 Grouping 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,Grouping) method.
Object	transformEntity(int transform, Grouping 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.referential.grouping.GroupingDao, please note that the TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<Grouping> entities) Updates all instances in the entities collection in the persistent store.
void	update(Grouping grouping) Updates the grouping 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 Grouping 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

Grouping get(Integer id)

Gets an instance of Grouping from the persistent store.

Parameters:

id -

Returns:

Grouping

get

Object get(int transform,
         Integer id)

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

Parameters:

transform - flag to determine transformation type.

id - the identifier of the entity to get.

Returns:

either the entity or the object transformed from the entity.

load

Grouping load(Integer id)

Loads an instance of Grouping from the persistent store.

Parameters:

id -

Returns:

Grouping

load

Object load(int transform,
          Integer id)

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

Parameters:

transform - flag to determine transformation type.

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

loadAll

Collection<Grouping> loadAll()

Loads all entities of type Grouping.

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

Grouping create(Grouping grouping)

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

Parameters:

grouping -

Returns:

Grouping

create

Object create(int transform,
            Grouping grouping)

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

grouping -

Returns:

Object

create

Collection<Grouping> create(Collection<Grouping> entities)

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

Parameters:

entities - the collection of Grouping instances to create.

Returns:

the created instances.

create

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

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

Grouping create(String label,
              String name,
              Double minValue,
              Double maxValue,
              Timestamp updateDate)

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

Parameters:

label -

Code mnémotechnique représentant le regroupement.

Par exemple :

- pour une classe taille de navire : "[0-10[m", "[10-20[m", etc.

- pour un regroupement de métiers, le code du regroupement, etc.

name -

minValue -

Valeur minimum de la caractéristique de regroupement.

Uniquement dans le cas où une caractéristique a été définie sur le niveau de regroupement parent (uniquement si GroupLevel.featuresPmfm est renseigné).

Exemple : Si la caractéristique est "Longueur du navire", la valeur min vaudra "10", pour une classe de taille de 10 à 20 m.

maxValue -

Valeur maximale de la caractéristique de regroupement.

Uniquement dans le cas où une caractéristique a été définie sur le niveau de regroupement parent (uniquement si GroupLevel.featuresPmfm est renseigné).

Par convention, la valeur maximale du regroupement est EXCLUE.

Exemple : Si la caractéristique est "Longueur du navire", la valeur max vaudra "20", pour une classe de taille de [10-20[m (20 étant exclu).

updateDate -

Returns:

Grouping

create

Object create(int transform,
            String label,
            String name,
            Double minValue,
            Double maxValue,
            Timestamp updateDate)

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

Parameters:

transform -

label -

Code mnémotechnique représentant le regroupement.

Par exemple :

- pour une classe taille de navire : "[0-10[m", "[10-20[m", etc.

- pour un regroupement de métiers, le code du regroupement, etc.

name -

minValue -

Valeur minimum de la caractéristique de regroupement.

Uniquement dans le cas où une caractéristique a été définie sur le niveau de regroupement parent (uniquement si GroupLevel.featuresPmfm est renseigné).

Exemple : Si la caractéristique est "Longueur du navire", la valeur min vaudra "10", pour une classe de taille de 10 à 20 m.

maxValue -

Valeur maximale de la caractéristique de regroupement.

Uniquement dans le cas où une caractéristique a été définie sur le niveau de regroupement parent (uniquement si GroupLevel.featuresPmfm est renseigné).

Par convention, la valeur maximale du regroupement est EXCLUE.

Exemple : Si la caractéristique est "Longueur du navire", la valeur max vaudra "20", pour une classe de taille de [10-20[m (20 étant exclu).

updateDate -

Returns:

Grouping

create

Grouping create(GroupingClassification groupingClassification,
              GroupingLevel groupingLevel,
              String label,
              String name,
              Status status)

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

Parameters:

groupingClassification -

groupingLevel -

label -

name -

status -

Returns:

Grouping

create

Object create(int transform,
            GroupingClassification groupingClassification,
            GroupingLevel groupingLevel,
            String label,
            String name,
            Status status)

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

groupingClassification -

groupingLevel -

label -

name -

status -

Returns:

Object

update

void update(Grouping grouping)

Updates the grouping instance in the persistent store.

Parameters:

grouping -

update

void update(Collection<Grouping> entities)

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

Parameters:

entities -

remove

void remove(Grouping grouping)

Removes the instance of Grouping from the persistent store.

Parameters:

grouping -

remove

void remove(Integer id)

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

Parameters:

id -

remove

void remove(Collection<Grouping> entities)

Removes all entities in the given entities collection.

Parameters:

entities -

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<Grouping> 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,
                     Grouping 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.referential.grouping.GroupingDao, 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 GroupingDao

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,Grouping) 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.referential.grouping.GroupingDao

entities - the collection of entities to transform

See Also:

transformEntity(int,Grouping)