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

Class Grouping

Object

Grouping

All Implemented Interfaces:

Serializable, Comparable<Grouping>

Direct Known Subclasses:

GroupingImpl

public abstract class Grouping
extends Object
implements Serializable, Comparable<Grouping>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Grouping.Factory Constructs new instances of Grouping.

Constructor Summary

Constructors

Constructor and Description
Grouping()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addGroupingItems(GroupingItem elementToAdd) GroupingItem permet de lister les entités du référentiel qui appartiennent à un regroupement.
boolean	addGroupings(Grouping elementToAdd) Un regroupement représente un groupement d'entités (du référentiel ou bien de navires), correspondant à un niveau de regroupement donné (GroupingLevel).
int	compareTo(Grouping o)
boolean	equals(Object object) Returns true if the argument is an Grouping instance and all identifiers for this entity equal the identifiers of the argument entity.
String	getComments()
GroupingClassification	getGroupingClassification() Classification du regroupement.
Collection<GroupingItem>	getGroupingItems() GroupingItem permet de lister les entités du référentiel qui appartiennent à un regroupement.
GroupingLevel	getGroupingLevel() Niveau de regroupement, d'une classification donnée.
Collection<Grouping>	getGroupings() Un regroupement représente un groupement d'entités (du référentiel ou bien de navires), correspondant à un niveau de regroupement donné (GroupingLevel).
Integer	getId() Identifiant interne.
String	getLabel() Code mnémotechnique représentant le regroupement.
Double	getMaxValue() Valeur maximale de la caractéristique de regroupement.
Double	getMinValue() Valeur minimum de la caractéristique de regroupement.
String	getName()
Grouping	getParentGrouping() Le regroupement parent (optionnel).
Status	getStatus() Etat de saisie (actif/Inactif) du regroupement.
Timestamp	getUpdateDate()
ValidityStatus	getValidityStatus() Etat de validation d'une donnée du référentiel.
int	hashCode() Returns a hash code based on this entity's identifiers.
boolean	removeGroupingItems(GroupingItem elementToRemove) GroupingItem permet de lister les entités du référentiel qui appartiennent à un regroupement.
boolean	removeGroupings(Grouping elementToRemove) Un regroupement représente un groupement d'entités (du référentiel ou bien de navires), correspondant à un niveau de regroupement donné (GroupingLevel).
void	setComments(String commentsIn)
void	setGroupingClassification(GroupingClassification groupingClassificationIn) Classification du regroupement.
void	setGroupingItems(Collection<GroupingItem> groupingItemsIn) GroupingItem permet de lister les entités du référentiel qui appartiennent à un regroupement.
void	setGroupingLevel(GroupingLevel groupingLevelIn) Niveau de regroupement, d'une classification donnée.
void	setGroupings(Collection<Grouping> groupingsIn) Un regroupement représente un groupement d'entités (du référentiel ou bien de navires), correspondant à un niveau de regroupement donné (GroupingLevel).
void	setId(Integer idIn) Identifiant interne.
void	setLabel(String labelIn) Code mnémotechnique représentant le regroupement.
void	setMaxValue(Double maxValueIn) Valeur maximale de la caractéristique de regroupement.
void	setMinValue(Double minValueIn) Valeur minimum de la caractéristique de regroupement.
void	setName(String nameIn)
void	setParentGrouping(Grouping parentGroupingIn) Le regroupement parent (optionnel).
void	setStatus(Status statusIn) Etat de saisie (actif/Inactif) du regroupement.
void	setUpdateDate(Timestamp updateDateIn)
void	setValidityStatus(ValidityStatus validityStatusIn) Etat de validation d'une donnée du référentiel.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Grouping

public Grouping()

Method Detail

getId

public Integer getId()

Identifiant interne. Généré par le système.

Returns:

this.id Integer

setId

public void setId(Integer idIn)

Identifiant interne. Généré par le système.

Parameters:

idIn - Integer

getLabel

public String getLabel()

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.

Returns:

this.label String

setLabel

public void setLabel(String labelIn)

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.

Parameters:

labelIn - String

getName

public String getName()

Returns:

this.name String

setName

public void setName(String nameIn)

Parameters:

nameIn - String

getMinValue

public Double getMinValue()

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.

Returns:

this.minValue Double

setMinValue

public void setMinValue(Double minValueIn)

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.

Parameters:

minValueIn - Double

getMaxValue

public Double getMaxValue()

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).

Returns:

this.maxValue Double

setMaxValue

public void setMaxValue(Double maxValueIn)

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).

Parameters:

maxValueIn - Double

getUpdateDate

public Timestamp getUpdateDate()

Returns:

this.updateDate Timestamp

setUpdateDate

public void setUpdateDate(Timestamp updateDateIn)

Parameters:

updateDateIn - Timestamp

getComments

public String getComments()

Returns:

this.comments String

setComments

public void setComments(String commentsIn)

Parameters:

commentsIn - String

getValidityStatus

public ValidityStatus getValidityStatus()

Etat de validation d'une donnée du référentiel. Utile pour les responsables de référentiel. Validity status of a referential data.

Returns:

this.validityStatus ValidityStatus

setValidityStatus

public void setValidityStatus(ValidityStatus validityStatusIn)

Etat de validation d'une donnée du référentiel. Utile pour les responsables de référentiel. Validity status of a referential data.

Parameters:

validityStatusIn - ValidityStatus

getParentGrouping

public Grouping getParentGrouping()

Le regroupement parent (optionnel).

Returns:

this.parentGrouping Grouping

setParentGrouping

public void setParentGrouping(Grouping parentGroupingIn)

Le regroupement parent (optionnel).

Parameters:

parentGroupingIn - Grouping

getGroupings

public Collection<Grouping> getGroupings()

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.

Returns:

this.groupings Collection

setGroupings

public void setGroupings(Collection<Grouping> groupingsIn)

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.

Parameters:

groupingsIn - Collection

addGroupings

public boolean addGroupings(Grouping elementToAdd)

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.

Parameters:

elementToAdd - Grouping

Returns:

true if this collection changed as a result of the call

removeGroupings

public boolean removeGroupings(Grouping elementToRemove)

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.

Parameters:

elementToRemove - Grouping

Returns:

true if this collection changed as a result of the call

getGroupingClassification

public GroupingClassification getGroupingClassification()

Classification du regroupement.

Lien utilisé pour optimiser les performances, car déjà présent dans le GroupingLevel lié.

Doit être identique à la classification du GroupingLevel lié.

Returns:

this.groupingClassification GroupingClassification

setGroupingClassification

public void setGroupingClassification(GroupingClassification groupingClassificationIn)

Classification du regroupement.

Lien utilisé pour optimiser les performances, car déjà présent dans le GroupingLevel lié.

Doit être identique à la classification du GroupingLevel lié.

Parameters:

groupingClassificationIn - GroupingClassification

getStatus

public Status getStatus()

Etat de saisie (actif/Inactif) du regroupement.

Returns:

this.status Status

setStatus

public void setStatus(Status statusIn)

Etat de saisie (actif/Inactif) du regroupement.

Parameters:

statusIn - Status

getGroupingItems

public Collection<GroupingItem> getGroupingItems()

GroupingItem permet de lister les entités du référentiel qui appartiennent à un regroupement.

Returns:

this.groupingItems Collection

setGroupingItems

public void setGroupingItems(Collection<GroupingItem> groupingItemsIn)

GroupingItem permet de lister les entités du référentiel qui appartiennent à un regroupement.

Parameters:

groupingItemsIn - Collection

addGroupingItems

public boolean addGroupingItems(GroupingItem elementToAdd)

GroupingItem permet de lister les entités du référentiel qui appartiennent à un regroupement.

Parameters:

elementToAdd - GroupingItem

Returns:

true if this collection changed as a result of the call

removeGroupingItems

public boolean removeGroupingItems(GroupingItem elementToRemove)

GroupingItem permet de lister les entités du référentiel qui appartiennent à un regroupement.

Parameters:

elementToRemove - GroupingItem

Returns:

true if this collection changed as a result of the call

getGroupingLevel

public GroupingLevel getGroupingLevel()

Niveau de regroupement, d'une classification donnée.

Exemple : pour les métiers, on peut avoir les niveaux de regroupement suivants : arts, grandes familles d’engins, …

Un niveau de regroupement peut avoir un niveau parent.

Un niveau de regroupement contient un ou plusieurs regroupements (Grouping).

Returns:

this.groupingLevel GroupingLevel

setGroupingLevel

public void setGroupingLevel(GroupingLevel groupingLevelIn)

Niveau de regroupement, d'une classification donnée.

Exemple : pour les métiers, on peut avoir les niveaux de regroupement suivants : arts, grandes familles d’engins, …

Un niveau de regroupement peut avoir un niveau parent.

Un niveau de regroupement contient un ou plusieurs regroupements (Grouping).

Parameters:

groupingLevelIn - GroupingLevel

equals

public boolean equals(Object object)

Returns true if the argument is an Grouping instance and all identifiers for this entity equal the identifiers of the argument entity. Returns false otherwise.

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code based on this entity's identifiers.

Overrides:

hashCode in class Object

compareTo

public int compareTo(Grouping o)

Specified by:

compareTo in interface Comparable<Grouping>

See Also:

Comparable.compareTo(T)