FishingArea (SIH-Adagio :: Core 3.5.6 API)

Object
- FishingArea

All Implemented Interfaces:

Serializable, Comparable<FishingArea>

Direct Known Subclasses:

FishingAreaImpl
```
public abstract class FishingArea
extends Object
implements Serializable, Comparable<FishingArea>
```
Zone de peche ou d'activité effective d'un navire.

Contient une entrée pour chaque zone de peche d'un navire.

ATTENTION : ne pas réutiliser une zone de peche effective dèjà existante, à cause des liens de composition (et des contraintes "delete cascade") depuis les autres tables.

Votre enregistrement pourrait etre supprimée par quelqu'un d'autre !

Cas particulier des campagnes scientifiques (F.Coppin) : Dans le cas des campagnes scientifiques, ce concept correspond à une "station". La notion exacte de Fishing Area est définie suivant le protocole spatiale mise en place. En effet, la notion la plus fine d'aire de travail est la localité (stockée FishingArea2RegulationLocation). L'ordre de réalisation des prélèvements pouvant changer d'une année sur l'autre, la localité permet de disposer d'un code unique pour une zone de prélèvement donnée. Cette localité peut s'inscrire ou non selon le protocole dans une strate (stcokée dans FishingArea2RegulationLocation) définie dans le cadre du programme lié à la série (ce paramétrage est stocké dans les Program et Strategy). Il s'agit alors d'un 2ème niveau géographique pouvant contenir une ou plusieurs localités.

Toutes les situations peuvent être envisagées :
- Localités + strates
- Localités sans strate
- Strates sans localité
- ni localité ni strate
En plus de ces options la notion de strate bathymétrique peut exister.

Dans tous les cas de figure ces divers éléments géographiques doivent s'inscrivent dans la notion officielle de rectangle ou sous rectangle statistique (stcoké dans FishingArea.location).
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FishingArea.Factory
Constructs new instances of FishingArea.

Nested Classes
Modifier and Type	Class and Description
`static class`	`FishingArea.Factory` Constructs new instances of `FishingArea`.

Constructor Summary

Constructors
Constructor and Description

FishingArea()

Constructors
Constructor and Description
`FishingArea()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addFishingArea2ManagedLocations(FishingArea2ManagedLocation elementToAdd)`
`boolean`	`addRegulationLocations(FishingArea2RegulationLocation elementToAdd)` Zones réglementaires particulières (ex : ZEE, zone d'effort, etc.)
`int`	`compareTo(FishingArea o)`
`boolean`	`equals(Object object)` Returns `true` if the argument is an FishingArea instance and all identifiers for this entity equal the identifiers of the argument entity.
`DepthGradient`	`getDepthGradient()` Type de gradient de profondeur de la zone de pêche.
`DistanceToCoastGradient`	`getDistanceToCoastGradient()` Gradient de distance à la cote.
`Collection<FishingArea2ManagedLocation>`	`getFishingArea2ManagedLocations()`
`GearUseFeatures`	`getGearUseFeatures()` Paramètre de mise en oeuvre de l'engin durant une opération.
`Integer`	`getId()` Idenfiant interne.
`Location`	`getLocation()` Représente un lieu au sens général du terme.
`NearbySpecificArea`	`getNearbySpecificArea()` Type de zone de proximité particulière.
`Produce`	`getProduce()` Un produit est identifié par une espèce commerciale, un état, une qualité, présentation et catégorie commerciale.
`String`	`getQualificationComments()`
`Date`	`getQualificationDate()`
`QualityFlag`	`getQualityFlag()`
`Collection<FishingArea2RegulationLocation>`	`getRegulationLocations()` Zones réglementaires particulières (ex : ZEE, zone d'effort, etc.)
`Sale`	`getSale()` Lien vers la vente rattachée.
`Sample`	`getSample()` Un prélèvement représente un (et un seul) support, prélevé au cours d'une opération de peche, d'un échantillonnage au débarquement ou d'une vente.
`VesselUseFeatures`	`getVesselUseFeatures()` Paramètres de mise en oeuvre du navire.
`int`	`hashCode()` Returns a hash code based on this entity's identifiers.
`boolean`	`removeFishingArea2ManagedLocations(FishingArea2ManagedLocation elementToRemove)`
`boolean`	`removeRegulationLocations(FishingArea2RegulationLocation elementToRemove)` Zones réglementaires particulières (ex : ZEE, zone d'effort, etc.)
`void`	`setDepthGradient(DepthGradient depthGradientIn)` Type de gradient de profondeur de la zone de pêche.
`void`	`setDistanceToCoastGradient(DistanceToCoastGradient distanceToCoastGradientIn)` Gradient de distance à la cote.
`void`	`setFishingArea2ManagedLocations(Collection<FishingArea2ManagedLocation> fishingArea2ManagedLocationsIn)`
`void`	`setGearUseFeatures(GearUseFeatures gearUseFeaturesIn)` Paramètre de mise en oeuvre de l'engin durant une opération.
`void`	`setId(Integer idIn)` Idenfiant interne.
`void`	`setLocation(Location locationIn)` Représente un lieu au sens général du terme.
`void`	`setNearbySpecificArea(NearbySpecificArea nearbySpecificAreaIn)` Type de zone de proximité particulière.
`void`	`setProduce(Produce produceIn)` Un produit est identifié par une espèce commerciale, un état, une qualité, présentation et catégorie commerciale.
`void`	`setQualificationComments(String qualificationCommentsIn)`
`void`	`setQualificationDate(Date qualificationDateIn)`
`void`	`setQualityFlag(QualityFlag qualityFlagIn)`
`void`	`setRegulationLocations(Collection<FishingArea2RegulationLocation> regulationLocationsIn)` Zones réglementaires particulières (ex : ZEE, zone d'effort, etc.)
`void`	`setSale(Sale saleIn)` Lien vers la vente rattachée.
`void`	`setSample(Sample sampleIn)` Un prélèvement représente un (et un seul) support, prélevé au cours d'une opération de peche, d'un échantillonnage au débarquement ou d'une vente.
`void`	`setVesselUseFeatures(VesselUseFeatures vesselUseFeaturesIn)` Paramètres de mise en oeuvre du navire.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FishingArea
```
public FishingArea()
```
- Method Detail
  - getId
```
public Integer getId()
```
    Idenfiant interne. Généré par le système.
    
    Returns:
    this.id Integer
  - setId
```
public void setId(Integer idIn)
```
    Idenfiant interne. Généré par le système.
    
    Parameters:
    idIn - Integer
  - getQualificationDate
```
public Date getQualificationDate()
```
    Returns:
    this.qualificationDate Date
    Since:
    
    3.5.0
  - setQualificationDate
```
public void setQualificationDate(Date qualificationDateIn)
```
    Parameters:
    qualificationDateIn - Date
    Since:
    
    3.5.0
  - getQualificationComments
```
public String getQualificationComments()
```
    Returns:
    this.qualificationComments String
    Since:
    
    3.5.0
  - setQualificationComments
```
public void setQualificationComments(String qualificationCommentsIn)
```
    Parameters:
    qualificationCommentsIn - String
    Since:
    
    3.5.0
  - getFishingArea2ManagedLocations
```
public Collection<FishingArea2ManagedLocation> getFishingArea2ManagedLocations()
```
    Returns:
    this.fishingArea2ManagedLocations Collection
  - setFishingArea2ManagedLocations
```
public void setFishingArea2ManagedLocations(Collection<FishingArea2ManagedLocation> fishingArea2ManagedLocationsIn)
```
    Parameters:
    fishingArea2ManagedLocationsIn - Collection
  - addFishingArea2ManagedLocations
```
public boolean addFishingArea2ManagedLocations(FishingArea2ManagedLocation elementToAdd)
```
    Parameters:
    elementToAdd - FishingArea2ManagedLocation
    
    Returns:
    true if this collection changed as a result of the call
  - removeFishingArea2ManagedLocations
```
public boolean removeFishingArea2ManagedLocations(FishingArea2ManagedLocation elementToRemove)
```
    Parameters:
    elementToRemove - FishingArea2ManagedLocation
    
    Returns:
    true if this collection changed as a result of the call
  - getRegulationLocations
```
public Collection<FishingArea2RegulationLocation> getRegulationLocations()
```
    Zones réglementaires particulières (ex : ZEE, zone d'effort, etc.)
    
    Returns:
    this.regulationLocations Collection
  - setRegulationLocations
```
public void setRegulationLocations(Collection<FishingArea2RegulationLocation> regulationLocationsIn)
```
    Zones réglementaires particulières (ex : ZEE, zone d'effort, etc.)
    
    Parameters:
    regulationLocationsIn - Collection
  - addRegulationLocations
```
public boolean addRegulationLocations(FishingArea2RegulationLocation elementToAdd)
```
    Zones réglementaires particulières (ex : ZEE, zone d'effort, etc.)
    
    Parameters:
    elementToAdd - FishingArea2RegulationLocation
    
    Returns:
    true if this collection changed as a result of the call
  - removeRegulationLocations
```
public boolean removeRegulationLocations(FishingArea2RegulationLocation elementToRemove)
```
    Zones réglementaires particulières (ex : ZEE, zone d'effort, etc.)
    
    Parameters:
    elementToRemove - FishingArea2RegulationLocation
    
    Returns:
    true if this collection changed as a result of the call
  - getProduce
```
public Produce getProduce()
```
    Un produit est identifié par une espèce commerciale, un état, une qualité, présentation et catégorie commerciale.
    
    Si le produit est un "produit vendu" :
    
    On pourra allors utiliser SortingMeasurement pour stocker des données économiques, comme par exemple :
    
    - Le prix du produit. Il peut y avoir plusieurds prix (plusieurs PSFMs), par exemple : prix au kilo, et prix total en euros.
    
    - Valorisation de la commercialisation : Label rouge, Eco Label, marque collective controlée par un organisme tier. (cf SACROIS)
    
    - Destination commerciale : consommation humaine, consommation animale, etc .
    
    Returns:
    this.produce Produce
  - setProduce
```
public void setProduce(Produce produceIn)
```
    Un produit est identifié par une espèce commerciale, un état, une qualité, présentation et catégorie commerciale.
    
    Si le produit est un "produit vendu" :
    
    On pourra allors utiliser SortingMeasurement pour stocker des données économiques, comme par exemple :
    
    - Le prix du produit. Il peut y avoir plusieurds prix (plusieurs PSFMs), par exemple : prix au kilo, et prix total en euros.
    
    - Valorisation de la commercialisation : Label rouge, Eco Label, marque collective controlée par un organisme tier. (cf SACROIS)
    
    - Destination commerciale : consommation humaine, consommation animale, etc .
    
    Parameters:
    produceIn - Produce
  - getGearUseFeatures
```
public GearUseFeatures getGearUseFeatures()
```
    Paramètre de mise en oeuvre de l'engin durant une opération. Exemple de paramètre de mise en oeuvre: • nombre de boués, • type de panneau, • présence d'un racasseur, • nombre de casier. mais aussi : • profondeur moyenne de l'engin, • vitesse de traine moyenne • ouverture du chalut
    
    Returns:
    this.gearUseFeatures GearUseFeatures
  - setGearUseFeatures
```
public void setGearUseFeatures(GearUseFeatures gearUseFeaturesIn)
```
    Paramètre de mise en oeuvre de l'engin durant une opération. Exemple de paramètre de mise en oeuvre: • nombre de boués, • type de panneau, • présence d'un racasseur, • nombre de casier. mais aussi : • profondeur moyenne de l'engin, • vitesse de traine moyenne • ouverture du chalut
    
    Parameters:
    gearUseFeaturesIn - GearUseFeatures
  - getVesselUseFeatures
```
public VesselUseFeatures getVesselUseFeatures()
```
    Paramètres de mise en oeuvre du navire. Il peut s'agir de données d'observation comme de données de déclaration, mais liée à comment est utilisé le navire et dans quelles conditions. Par exemple, pour les donénes d'observation : • profondeur de mer au début de l'opération, en mètre, • profondeur de mer à la fin de l'opération, en mètre, • déroulement de l'opération (normal, anormal, etc.) • état de la mer lors durant l'opération : échelle de 0 à 9 (4=agitée, etc) • trait rectiligne (oui/non) • cout en gazoil, • nombre d'engin perdu, • cout des pertes, • etc. Par exemple, pour les données de déclaration : • temps de pêche, • temps de route (qui peut aussi etre calculé à l'exploitation), • nombre d'opérations, • etc.
    
    Returns:
    this.vesselUseFeatures VesselUseFeatures
  - setVesselUseFeatures
```
public void setVesselUseFeatures(VesselUseFeatures vesselUseFeaturesIn)
```
    Paramètres de mise en oeuvre du navire. Il peut s'agir de données d'observation comme de données de déclaration, mais liée à comment est utilisé le navire et dans quelles conditions. Par exemple, pour les donénes d'observation : • profondeur de mer au début de l'opération, en mètre, • profondeur de mer à la fin de l'opération, en mètre, • déroulement de l'opération (normal, anormal, etc.) • état de la mer lors durant l'opération : échelle de 0 à 9 (4=agitée, etc) • trait rectiligne (oui/non) • cout en gazoil, • nombre d'engin perdu, • cout des pertes, • etc. Par exemple, pour les données de déclaration : • temps de pêche, • temps de route (qui peut aussi etre calculé à l'exploitation), • nombre d'opérations, • etc.
    
    Parameters:
    vesselUseFeaturesIn - VesselUseFeatures
  - getNearbySpecificArea
```
public NearbySpecificArea getNearbySpecificArea()
```
    Type de zone de proximité particulière. Par exemple : - DCP (Dispositif de Concentration de Poison) - Filière aquacole - ... (liste non exhaustive) Nombre de lignes : 10
    
    Returns:
    this.nearbySpecificArea NearbySpecificArea
  - setNearbySpecificArea
```
public void setNearbySpecificArea(NearbySpecificArea nearbySpecificAreaIn)
```
    Type de zone de proximité particulière. Par exemple : - DCP (Dispositif de Concentration de Poison) - Filière aquacole - ... (liste non exhaustive) Nombre de lignes : 10
    
    Parameters:
    nearbySpecificAreaIn - NearbySpecificArea
  - getDepthGradient
```
public DepthGradient getDepthGradient()
```
    Type de gradient de profondeur de la zone de pêche.
    
    Returns:
    this.depthGradient DepthGradient
  - setDepthGradient
```
public void setDepthGradient(DepthGradient depthGradientIn)
```
    Type de gradient de profondeur de la zone de pêche.
    
    Parameters:
    depthGradientIn - DepthGradient
  - getDistanceToCoastGradient
```
public DistanceToCoastGradient getDistanceToCoastGradient()
```
    Gradient de distance à la cote. passage en optionel nécessaire pour SACROIS.
    
    Returns:
    this.distanceToCoastGradient DistanceToCoastGradient
  - setDistanceToCoastGradient
```
public void setDistanceToCoastGradient(DistanceToCoastGradient distanceToCoastGradientIn)
```
    Gradient de distance à la cote. passage en optionel nécessaire pour SACROIS.
    
    Parameters:
    distanceToCoastGradientIn - DistanceToCoastGradient
  - getLocation
```
public Location getLocation()
```
    Représente un lieu au sens général du terme. Il peut s'agir d'un lieu ponctuel, linéaire ou surfacique. Suivant sa classification et son niveau, il peut s'agir d'un secteur FAO, un port de pêche, un quartier maritime, une criée, etc. Nombre de lignes : lieux terrestre : 4500 + secteurs : 11210 + strates : 1000 + localités : 200
    
    Returns:
    this.location Location
  - setLocation
```
public void setLocation(Location locationIn)
```
    Représente un lieu au sens général du terme. Il peut s'agir d'un lieu ponctuel, linéaire ou surfacique. Suivant sa classification et son niveau, il peut s'agir d'un secteur FAO, un port de pêche, un quartier maritime, une criée, etc. Nombre de lignes : lieux terrestre : 4500 + secteurs : 11210 + strates : 1000 + localités : 200
    
    Parameters:
    locationIn - Location
  - getSale
```
public Sale getSale()
```
    Lien vers la vente rattachée. Nécessaire pour Allegro ObsVente (v3.1), qui nécessite qu'une vente soit liée à des zones en mer. Ceci pour le calcul des RTP dans l'échantillonnage biologique. Ces zones en mer sont récupérées à partir de la ligne du plan d'echantillonnage, depuis WAO.
    
    Returns:
    this.sale Sale
  - setSale
```
public void setSale(Sale saleIn)
```
    Lien vers la vente rattachée. Nécessaire pour Allegro ObsVente (v3.1), qui nécessite qu'une vente soit liée à des zones en mer. Ceci pour le calcul des RTP dans l'échantillonnage biologique. Ces zones en mer sont récupérées à partir de la ligne du plan d'echantillonnage, depuis WAO.
    
    Parameters:
    saleIn - Sale
  - getQualityFlag
```
public QualityFlag getQualityFlag()
```
    Returns:
    this.qualityFlag QualityFlag
    Since:
    
    3.5.0
  - setQualityFlag
```
public void setQualityFlag(QualityFlag qualityFlagIn)
```
    Parameters:
    qualityFlagIn - QualityFlag
    Since:
    
    3.5.0
  - getSample
```
public Sample getSample()
```
    Un prélèvement représente un (et un seul) support, prélevé au cours d'une opération de peche, d'un échantillonnage au débarquement ou d'une vente. Il s'agit de la partie qui est recueillie pour analyse ou dénombrement. Un prélèvement est rattaché à une opération de peche ou un groupe d'opérations, un débarquement ou à une vente. Il peut être en plus rattaché à un des lots échantillonnés (le lot de provenance). Dans le cas des marées observées en mer, un prlèvement correspond à un individu, dont le support est, par exemple : - crustacé (crevette...) - poisson (merlu, sardine...) - gastéropode (bigorneau, littorine...) - echinoderme (oursin...) - etc. Le nombre d'individu, généralement égal à 1, permet de constituer des prélèvement de plusieurs individu (dès lors qu'il sont ne meme anture). Chaque résultat de mesure (SampleMeasurement) pourra identifié l'individu concerné par la mesure, par une numéro din'dividu. Un mnémonique, représentant généralement l'étiquette collée sur le sachet contenant le prélèvement, permet d"identifier le prélèvement de manière simple, notamment en laboratoire pour la saisie des lectures d'age, etc.. Par exemple de prélèvement : - un poisson, d'une espèce donnée, sur lequel est prélevé un otholithe, et/ou des écailes afin de réaliser une lecture d'age. - un cétacé, issu d'un lot, sur lesquels doit être effectué des analyses d'age, de taille, - etc.
    
    Returns:
    this.sample Sample
  - setSample
```
public void setSample(Sample sampleIn)
```
    Un prélèvement représente un (et un seul) support, prélevé au cours d'une opération de peche, d'un échantillonnage au débarquement ou d'une vente. Il s'agit de la partie qui est recueillie pour analyse ou dénombrement. Un prélèvement est rattaché à une opération de peche ou un groupe d'opérations, un débarquement ou à une vente. Il peut être en plus rattaché à un des lots échantillonnés (le lot de provenance). Dans le cas des marées observées en mer, un prlèvement correspond à un individu, dont le support est, par exemple : - crustacé (crevette...) - poisson (merlu, sardine...) - gastéropode (bigorneau, littorine...) - echinoderme (oursin...) - etc. Le nombre d'individu, généralement égal à 1, permet de constituer des prélèvement de plusieurs individu (dès lors qu'il sont ne meme anture). Chaque résultat de mesure (SampleMeasurement) pourra identifié l'individu concerné par la mesure, par une numéro din'dividu. Un mnémonique, représentant généralement l'étiquette collée sur le sachet contenant le prélèvement, permet d"identifier le prélèvement de manière simple, notamment en laboratoire pour la saisie des lectures d'age, etc.. Par exemple de prélèvement : - un poisson, d'une espèce donnée, sur lequel est prélevé un otholithe, et/ou des écailes afin de réaliser une lecture d'age. - un cétacé, issu d'un lot, sur lesquels doit être effectué des analyses d'age, de taille, - etc.
    
    Parameters:
    sampleIn - Sample
  - equals
```
public boolean equals(Object object)
```
    Returns true if the argument is an FishingArea 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(FishingArea o)
```
    Specified by:
    
    compareTo in interface Comparable<FishingArea>
    
    See Also:
    Comparable.compareTo(T)

Class FishingArea

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

FishingArea

Method Detail

getId

setId

getQualificationDate

setQualificationDate

getQualificationComments

setQualificationComments

getFishingArea2ManagedLocations

setFishingArea2ManagedLocations

addFishingArea2ManagedLocations

removeFishingArea2ManagedLocations

getRegulationLocations

setRegulationLocations

addRegulationLocations

removeRegulationLocations

getProduce

setProduce

getGearUseFeatures

setGearUseFeatures

getVesselUseFeatures

setVesselUseFeatures

getNearbySpecificArea

setNearbySpecificArea

getDepthGradient

setDepthGradient

getDistanceToCoastGradient

setDistanceToCoastGradient

getLocation

setLocation

getSale

setSale

getQualityFlag

setQualityFlag

getSample

setSample

equals

hashCode

compareTo