fr.ifremer.adagio.core.dao.referential.metier

Interface MetierDao

All Known Implementing Classes:

MetierDaoBase, MetierDaoImpl

public interface MetierDao

Métier, qui peut etre un métier de peche ou non.

Un métier de peche a obligatoirement une espèce cible (TaxonGroup) de défini, et éventuellement un engin (Gear).

Dans ce cas, le nom (name) et le mnémonique (label) pourront etre déterminé par la concaténation de l'engin et de l'espèce cible.

V2.1 : modification de la gestion des métiers : suppression des classes FishingMetierGearType et MetierSpecies : un métier est maintenant défini directement par Gear et TaxonGroup.

=> Le référentiel des engin du métier (FishingMetierGearType) est maintenent intégré au référentiel générique des engins

=> Le référentiel des espèces métier (MetierSpecies) est maintenent intégré au référentiel générique des groupes de taxon

V3 :
- Le métier de peche n'a pas forcément d'engin (optionnel) Ex : AQUNEP

(Aquaculture)
- le mnémonique et le libellé ne sont plus calculés à la volée par concaténation, pour permettre l'utilisation de libellé plus court..

See Also:

Metier

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<Metier>	create(Collection<Metier> entities) Creates a new instance of Metier and adds from the passed in entities collection
Collection<?>	create(int transform, Collection<Metier> entities) Does the same thing as create(Metier) with an additional flag called transform.
Object	create(int transform, Metier metier) Does the same thing as create(Metier) with an additional flag called transform.
Object	create(int transform, String name, Status status, Timestamp updateDate, ValidityStatus validityStatus) Does the same thing as #create(String, Timestamp) with an additional flag called transform.
Object	create(int transform, String label, String name, String description, String comments, Timestamp updateDate) Does the same thing as create(String, String, String, String, Timestamp) with an additional flag called transform.
Metier	create(Metier metier) Creates an instance of Metier and adds it to the persistent store.
Metier	create(String name, Status status, Timestamp updateDate, ValidityStatus validityStatus) Creates a new Metier instance from only required properties (attributes and association ends) and adds it to the persistent store.
Metier	create(String label, String name, String description, String comments, Timestamp updateDate) Creates a new Metier instance from all attributes and adds it to the persistent store.
Metier	get(Integer id) Gets an instance of Metier from the persistent store.
Object	get(int transform, Integer id) Does the same thing as get(Integer) with an additional flag called transform.
Metier	load(Integer id) Loads an instance of Metier from the persistent store.
Object	load(int transform, Integer id) Does the same thing as load(Integer) with an additional flag called transform.
Collection<Metier>	loadAll() Loads all entities of type Metier.
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<Metier> entities) Removes all entities in the given entities collection.
void	remove(Integer id) Removes the instance of Metier having the given identifier from the persistent store.
void	remove(Metier metier) Removes the instance of Metier 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<Metier>	search(Search search) Performs a search using the parameters specified in the given search object.
Object	searchUniqueLabel(int transform, String label) Searches for a single instance of Metier.
Metier	searchUniqueLabel(String label) Searches for a single instance of Metier.
void	toEntities(Collection<?> results) Transforms the given results to a collection of Metier 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,Metier) method.
Object	transformEntity(int transform, Metier 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.metier.MetierDao, please note that the TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<Metier> entities) Updates all instances in the entities collection in the persistent store.
void	update(Metier metier) Updates the metier 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 Metier 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

Metier get(Integer id)

Gets an instance of Metier from the persistent store.

Parameters:

id -

Returns:

Metier

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

Metier load(Integer id)

Loads an instance of Metier from the persistent store.

Parameters:

id -

Returns:

Metier

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<Metier> loadAll()

Loads all entities of type Metier.

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

Metier create(Metier metier)

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

Parameters:

metier -

Returns:

Metier

create

Object create(int transform,
            Metier metier)

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

metier -

Returns:

Object

create

Collection<Metier> create(Collection<Metier> entities)

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

Parameters:

entities - the collection of Metier instances to create.

Returns:

the created instances.

create

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

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

Metier create(String label,
            String name,
            String description,
            String comments,
            Timestamp updateDate)

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

Parameters:

label - Pour un métier de peche, le mnémonique est généralement la concaténation du mnémonique de l'engin et de celui du groupe de taxon (si un le groupe de taxon en a un).

name - Libellé du métier. Pour un métier de peche, déterminé généralement à partir de la concaténation du libellé de l'engin, de la chaine " à ", puis du libellé du groupe de taxon.

description - Description longue du métier

comments -

updateDate -

Returns:

Metier

create

Object create(int transform,
            String label,
            String name,
            String description,
            String comments,
            Timestamp updateDate)

Does the same thing as create(String, String, String, String, 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 - Pour un métier de peche, le mnémonique est généralement la concaténation du mnémonique de l'engin et de celui du groupe de taxon (si un le groupe de taxon en a un).

name - Libellé du métier. Pour un métier de peche, déterminé généralement à partir de la concaténation du libellé de l'engin, de la chaine " à ", puis du libellé du groupe de taxon.

description - Description longue du métier

comments -

updateDate -

Returns:

Metier

create

Metier create(String name,
            Status status,
            Timestamp updateDate,
            ValidityStatus validityStatus)

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

Parameters:

name -

status -

updateDate -

validityStatus -

Returns:

Metier

create

Object create(int transform,
            String name,
            Status status,
            Timestamp updateDate,
            ValidityStatus validityStatus)

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

name -

status -

updateDate -

validityStatus -

Returns:

Object

update

void update(Metier metier)

Updates the metier instance in the persistent store.

Parameters:

metier -

update

void update(Collection<Metier> entities)

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

Parameters:

entities -

remove

void remove(Metier metier)

Removes the instance of Metier from the persistent store.

Parameters:

metier -

remove

void remove(Integer id)

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

Parameters:

id -

remove

void remove(Collection<Metier> 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<Metier> 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,
                     Metier 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.metier.MetierDao, 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 MetierDao

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,Metier) 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.metier.MetierDao

entities - the collection of entities to transform

See Also:

transformEntity(int,Metier)

searchUniqueLabel

Metier searchUniqueLabel(String label)

Searches for a single instance of Metier.

Parameters:

label - the unique label to be used in the search.'

Returns:

a single instance of Metier.

searchUniqueLabel

Object searchUniqueLabel(int transform,
                       String label)

Searches for a single instance of Metier.

Parameters:

transform - the transformation flag.

label - the unique label to be used in the search.

Returns:

a value object according the transformation flag.