fr.ifremer.adagio.core.dao.data.vessel

Class Vessel

Object

Vessel

All Implemented Interfaces:

Serializable, Comparable<Vessel>

Direct Known Subclasses:

VesselImpl

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

Navire, ou plus généralement un usager de la ressource. Peut etre un navire de peche professionnel ou non, un navire scientifique, un pêcheur à pied, un groupement de navires, etc.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Vessel()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addRightToProduces(RightToProduce elementToAdd) Un droit de produire est une autorisation administrative pour prélever de ou exploiter de la ressource.
boolean	addVesselCommissioningPeriods(VesselCommissioningPeriod elementToAdd) Période d'armement, ou de mise en service, du navire.
boolean	addVesselFeatures(VesselFeatures elementToAdd) Caractéristiques d'un navire, sur une période donnée.
boolean	addVesselFleetEvents(VesselFleetEvent elementToAdd) Evènement d'entrée ou sortie de flotte (entrée ou sortie du registre des navires).
boolean	addVesselOwnerPeriods(VesselOwnerPeriod elementToAdd) Période d'appartenance d'un navire à un armateur (période d'armement).
boolean	addVesselRegistrationPeriods(VesselRegistrationPeriod elementToAdd) Définit le lieu d'immatriculation d'un navire statistique et la période associée.
int	compareTo(Vessel o)
boolean	equals(Object object) Returns true if the argument is an Vessel instance and all identifiers for this entity equal the identifiers of the argument entity.
String	getCode() Code du navire, c'est à dire son identifiant interne unique.
Program	getProgram() Identifie le référentiel d'usagers auquel est rattaché le Vessel.
Collection<RightToProduce>	getRightToProduces() Un droit de produire est une autorisation administrative pour prélever de ou exploiter de la ressource.
Status	getStatus() Etat du navire à la date actuelle du système.
Timestamp	getUpdateDate()
Collection<VesselCommissioningPeriod>	getVesselCommissioningPeriods() Période d'armement, ou de mise en service, du navire.
Collection<VesselFeatures>	getVesselFeatures() Caractéristiques d'un navire, sur une période donnée.
Collection<VesselFleetEvent>	getVesselFleetEvents() Evènement d'entrée ou sortie de flotte (entrée ou sortie du registre des navires).
Collection<VesselOwnerPeriod>	getVesselOwnerPeriods() Période d'appartenance d'un navire à un armateur (période d'armement).
Collection<VesselRegistrationPeriod>	getVesselRegistrationPeriods() Définit le lieu d'immatriculation d'un navire statistique et la période associée.
VesselType	getVesselType() Type de navire.
int	hashCode() Returns a hash code based on this entity's identifiers.
boolean	removeRightToProduces(RightToProduce elementToRemove) Un droit de produire est une autorisation administrative pour prélever de ou exploiter de la ressource.
boolean	removeVesselCommissioningPeriods(VesselCommissioningPeriod elementToRemove) Période d'armement, ou de mise en service, du navire.
boolean	removeVesselFeatures(VesselFeatures elementToRemove) Caractéristiques d'un navire, sur une période donnée.
boolean	removeVesselFleetEvents(VesselFleetEvent elementToRemove) Evènement d'entrée ou sortie de flotte (entrée ou sortie du registre des navires).
boolean	removeVesselOwnerPeriods(VesselOwnerPeriod elementToRemove) Période d'appartenance d'un navire à un armateur (période d'armement).
boolean	removeVesselRegistrationPeriods(VesselRegistrationPeriod elementToRemove) Définit le lieu d'immatriculation d'un navire statistique et la période associée.
void	setCode(String codeIn) Code du navire, c'est à dire son identifiant interne unique.
void	setProgram(Program programIn) Identifie le référentiel d'usagers auquel est rattaché le Vessel.
void	setRightToProduces(Collection<RightToProduce> rightToProducesIn) Un droit de produire est une autorisation administrative pour prélever de ou exploiter de la ressource.
void	setStatus(Status statusIn) Etat du navire à la date actuelle du système.
void	setUpdateDate(Timestamp updateDateIn)
void	setVesselCommissioningPeriods(Collection<VesselCommissioningPeriod> vesselCommissioningPeriodsIn) Période d'armement, ou de mise en service, du navire.
void	setVesselFeatures(Collection<VesselFeatures> vesselFeaturesIn) Caractéristiques d'un navire, sur une période donnée.
void	setVesselFleetEvents(Collection<VesselFleetEvent> vesselFleetEventsIn) Evènement d'entrée ou sortie de flotte (entrée ou sortie du registre des navires).
void	setVesselOwnerPeriods(Collection<VesselOwnerPeriod> vesselOwnerPeriodsIn) Période d'appartenance d'un navire à un armateur (période d'armement).
void	setVesselRegistrationPeriods(Collection<VesselRegistrationPeriod> vesselRegistrationPeriodsIn) Définit le lieu d'immatriculation d'un navire statistique et la période associée.
void	setVesselType(VesselType vesselTypeIn) Type de navire.

Methods inherited from class Object

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

Constructor Detail

Vessel

public Vessel()

Method Detail

getCode

public String getCode()

Code du navire, c'est à dire son identifiant interne unique. Son identifiant interne ne change jamais, quelque soit son immatriculation, son lieu d'immatriculation, etc.

Le code est sur 12 caractères pour permettre de stocker les 6 caractères du code Harmonie (+ dans Allegro un prefixe en base locale : "#TEMP¿").

=> Depuis le modèle V3.1.3, une séquence VESSEL_CODE_SEQ permet de générer un identifiant unique, à convertir ensuite en alphanumérique.

Returns:

this.code String

setCode

public void setCode(String codeIn)

Code du navire, c'est à dire son identifiant interne unique. Son identifiant interne ne change jamais, quelque soit son immatriculation, son lieu d'immatriculation, etc.

Le code est sur 12 caractères pour permettre de stocker les 6 caractères du code Harmonie (+ dans Allegro un prefixe en base locale : "#TEMP¿").

=> Depuis le modèle V3.1.3, une séquence VESSEL_CODE_SEQ permet de générer un identifiant unique, à convertir ensuite en alphanumérique.

Parameters:

codeIn - String

getUpdateDate

public Timestamp getUpdateDate()

Returns:

this.updateDate Timestamp

setUpdateDate

public void setUpdateDate(Timestamp updateDateIn)

Parameters:

updateDateIn - Timestamp

getVesselFleetEvents

public Collection<VesselFleetEvent> getVesselFleetEvents()

Evènement d'entrée ou sortie de flotte (entrée ou sortie du registre des navires).

Par exemple :

• Pour le flux FPC :

IMP Importation

CHA Entrée dans le FPC

CST Construction

EXP Exportation

COR Correction

RET Retrait du FPC

DES Destruction

Returns:

this.vesselFleetEvents Collection

setVesselFleetEvents

public void setVesselFleetEvents(Collection<VesselFleetEvent> vesselFleetEventsIn)

Evènement d'entrée ou sortie de flotte (entrée ou sortie du registre des navires).

Par exemple :

• Pour le flux FPC :

IMP Importation

CHA Entrée dans le FPC

CST Construction

EXP Exportation

COR Correction

RET Retrait du FPC

DES Destruction

Parameters:

vesselFleetEventsIn - Collection

addVesselFleetEvents

public boolean addVesselFleetEvents(VesselFleetEvent elementToAdd)

Evènement d'entrée ou sortie de flotte (entrée ou sortie du registre des navires).

Par exemple :

• Pour le flux FPC :

IMP Importation

CHA Entrée dans le FPC

CST Construction

EXP Exportation

COR Correction

RET Retrait du FPC

DES Destruction

Parameters:

elementToAdd - VesselFleetEvent

Returns:

true if this collection changed as a result of the call

removeVesselFleetEvents

public boolean removeVesselFleetEvents(VesselFleetEvent elementToRemove)

Evènement d'entrée ou sortie de flotte (entrée ou sortie du registre des navires).

Par exemple :

• Pour le flux FPC :

IMP Importation

CHA Entrée dans le FPC

CST Construction

EXP Exportation

COR Correction

RET Retrait du FPC

DES Destruction

Parameters:

elementToRemove - VesselFleetEvent

Returns:

true if this collection changed as a result of the call

getStatus

public Status getStatus()

Etat du navire à la date actuelle du système. Sert notamment à déterminer si le navire est encore actif à la date du jour. Cet état sert également pour les navires temporaires, lors de leur création dans la base locale d'Allegro.

Returns:

this.status Status

setStatus

public void setStatus(Status statusIn)

Etat du navire à la date actuelle du système. Sert notamment à déterminer si le navire est encore actif à la date du jour. Cet état sert également pour les navires temporaires, lors de leur création dans la base locale d'Allegro.

Parameters:

statusIn - Status

getVesselRegistrationPeriods

public Collection<VesselRegistrationPeriod> getVesselRegistrationPeriods()

Définit le lieu d'immatriculation d'un navire statistique et la période associée. Nombre de lignes : 72700

Returns:

this.vesselRegistrationPeriods Collection

setVesselRegistrationPeriods

public void setVesselRegistrationPeriods(Collection<VesselRegistrationPeriod> vesselRegistrationPeriodsIn)

Définit le lieu d'immatriculation d'un navire statistique et la période associée. Nombre de lignes : 72700

Parameters:

vesselRegistrationPeriodsIn - Collection

addVesselRegistrationPeriods

public boolean addVesselRegistrationPeriods(VesselRegistrationPeriod elementToAdd)

Définit le lieu d'immatriculation d'un navire statistique et la période associée. Nombre de lignes : 72700

Parameters:

elementToAdd - VesselRegistrationPeriod

Returns:

true if this collection changed as a result of the call

removeVesselRegistrationPeriods

public boolean removeVesselRegistrationPeriods(VesselRegistrationPeriod elementToRemove)

Définit le lieu d'immatriculation d'un navire statistique et la période associée. Nombre de lignes : 72700

Parameters:

elementToRemove - VesselRegistrationPeriod

Returns:

true if this collection changed as a result of the call

getVesselFeatures

public Collection<VesselFeatures> getVesselFeatures()

Caractéristiques d'un navire, sur une période donnée.

Correspond à la synthèse consolidée des différents VesselPhysicalFeatures collectés.

Si le navire est inscrit au FPC, les caractéristiques FPC sont utilisées (jauge_ums et jauge_brute).

REMARQUE : les données ramenées depuis Harmonie sont fusionnées entre les caractéristiques FPC (à utiliser de préférence si présent), et les caractéristiques d'autres sources.

Nombre de lignes : 67375

Returns:

this.vesselFeatures Collection

setVesselFeatures

public void setVesselFeatures(Collection<VesselFeatures> vesselFeaturesIn)

Caractéristiques d'un navire, sur une période donnée.

Correspond à la synthèse consolidée des différents VesselPhysicalFeatures collectés.

Si le navire est inscrit au FPC, les caractéristiques FPC sont utilisées (jauge_ums et jauge_brute).

REMARQUE : les données ramenées depuis Harmonie sont fusionnées entre les caractéristiques FPC (à utiliser de préférence si présent), et les caractéristiques d'autres sources.

Nombre de lignes : 67375

Parameters:

vesselFeaturesIn - Collection

addVesselFeatures

public boolean addVesselFeatures(VesselFeatures elementToAdd)

Caractéristiques d'un navire, sur une période donnée.

Correspond à la synthèse consolidée des différents VesselPhysicalFeatures collectés.

Si le navire est inscrit au FPC, les caractéristiques FPC sont utilisées (jauge_ums et jauge_brute).

REMARQUE : les données ramenées depuis Harmonie sont fusionnées entre les caractéristiques FPC (à utiliser de préférence si présent), et les caractéristiques d'autres sources.

Nombre de lignes : 67375

Parameters:

elementToAdd - VesselFeatures

Returns:

true if this collection changed as a result of the call

removeVesselFeatures

public boolean removeVesselFeatures(VesselFeatures elementToRemove)

Caractéristiques d'un navire, sur une période donnée.

Correspond à la synthèse consolidée des différents VesselPhysicalFeatures collectés.

Si le navire est inscrit au FPC, les caractéristiques FPC sont utilisées (jauge_ums et jauge_brute).

REMARQUE : les données ramenées depuis Harmonie sont fusionnées entre les caractéristiques FPC (à utiliser de préférence si présent), et les caractéristiques d'autres sources.

Nombre de lignes : 67375

Parameters:

elementToRemove - VesselFeatures

Returns:

true if this collection changed as a result of the call

getRightToProduces

public Collection<RightToProduce> getRightToProduces()

Un droit de produire est une autorisation administrative pour prélever de ou exploiter de la ressource. Il peut concerner un ensemble de navires de peche, ou un seul navire ou pecheur à pied. L'autorisation peut etre relative à une espèce, ou bien à un couple engin/espèce (=métier) il peut etre défini dans le cadre d'un corpus ou non (ex : droit de produire défini par les autorités locales).

Returns:

this.rightToProduces Collection

setRightToProduces

public void setRightToProduces(Collection<RightToProduce> rightToProducesIn)

Un droit de produire est une autorisation administrative pour prélever de ou exploiter de la ressource. Il peut concerner un ensemble de navires de peche, ou un seul navire ou pecheur à pied. L'autorisation peut etre relative à une espèce, ou bien à un couple engin/espèce (=métier) il peut etre défini dans le cadre d'un corpus ou non (ex : droit de produire défini par les autorités locales).

Parameters:

rightToProducesIn - Collection

addRightToProduces

public boolean addRightToProduces(RightToProduce elementToAdd)

Un droit de produire est une autorisation administrative pour prélever de ou exploiter de la ressource. Il peut concerner un ensemble de navires de peche, ou un seul navire ou pecheur à pied. L'autorisation peut etre relative à une espèce, ou bien à un couple engin/espèce (=métier) il peut etre défini dans le cadre d'un corpus ou non (ex : droit de produire défini par les autorités locales).

Parameters:

elementToAdd - RightToProduce

Returns:

true if this collection changed as a result of the call

removeRightToProduces

public boolean removeRightToProduces(RightToProduce elementToRemove)

Un droit de produire est une autorisation administrative pour prélever de ou exploiter de la ressource. Il peut concerner un ensemble de navires de peche, ou un seul navire ou pecheur à pied. L'autorisation peut etre relative à une espèce, ou bien à un couple engin/espèce (=métier) il peut etre défini dans le cadre d'un corpus ou non (ex : droit de produire défini par les autorités locales).

Parameters:

elementToRemove - RightToProduce

Returns:

true if this collection changed as a result of the call

getProgram

public Program getProgram()

Identifie le référentiel d'usagers auquel est rattaché le Vessel. Il peut s'agir du référentiel consolidé SIH, ou d'une autre référentiel (UE, FPC, VMS, etc).

Par exemple, lors de l'importation des données VMS, un Vessel est crée, rattaché au programme de collecte VMS. Cela permet de ne pas perdre d'informationssur le navire, même si celui-ci n'était pas dans le référentiel consolidé.

Returns:

this.program Program

setProgram

public void setProgram(Program programIn)

Identifie le référentiel d'usagers auquel est rattaché le Vessel. Il peut s'agir du référentiel consolidé SIH, ou d'une autre référentiel (UE, FPC, VMS, etc).

Par exemple, lors de l'importation des données VMS, un Vessel est crée, rattaché au programme de collecte VMS. Cela permet de ne pas perdre d'informationssur le navire, même si celui-ci n'était pas dans le référentiel consolidé.

Parameters:

programIn - Program

getVesselOwnerPeriods

public Collection<VesselOwnerPeriod> getVesselOwnerPeriods()

Période d'appartenance d'un navire à un armateur (période d'armement). Nombre de lignes : 25600

Returns:

this.vesselOwnerPeriods Collection

setVesselOwnerPeriods

public void setVesselOwnerPeriods(Collection<VesselOwnerPeriod> vesselOwnerPeriodsIn)

Période d'appartenance d'un navire à un armateur (période d'armement). Nombre de lignes : 25600

Parameters:

vesselOwnerPeriodsIn - Collection

addVesselOwnerPeriods

public boolean addVesselOwnerPeriods(VesselOwnerPeriod elementToAdd)

Période d'appartenance d'un navire à un armateur (période d'armement). Nombre de lignes : 25600

Parameters:

elementToAdd - VesselOwnerPeriod

Returns:

true if this collection changed as a result of the call

removeVesselOwnerPeriods

public boolean removeVesselOwnerPeriods(VesselOwnerPeriod elementToRemove)

Période d'appartenance d'un navire à un armateur (période d'armement). Nombre de lignes : 25600

Parameters:

elementToRemove - VesselOwnerPeriod

Returns:

true if this collection changed as a result of the call

getVesselType

public VesselType getVesselType()

Type de navire. Exemple : 1 pour les navires professionnels, 2 pour les pecheurs à pied, 3 pour les navires scientifiques

Returns:

this.vesselType VesselType

setVesselType

public void setVesselType(VesselType vesselTypeIn)

Type de navire. Exemple : 1 pour les navires professionnels, 2 pour les pecheurs à pied, 3 pour les navires scientifiques

Parameters:

vesselTypeIn - VesselType

getVesselCommissioningPeriods

public Collection<VesselCommissioningPeriod> getVesselCommissioningPeriods()

Période d'armement, ou de mise en service, du navire. La mise en service est rattaché à un lieu terrestre de mise en service. Cela peut etre le pays d'armement ou le quartier d'armement.

Returns:

this.vesselCommissioningPeriods Collection

setVesselCommissioningPeriods

public void setVesselCommissioningPeriods(Collection<VesselCommissioningPeriod> vesselCommissioningPeriodsIn)

Période d'armement, ou de mise en service, du navire. La mise en service est rattaché à un lieu terrestre de mise en service. Cela peut etre le pays d'armement ou le quartier d'armement.

Parameters:

vesselCommissioningPeriodsIn - Collection

addVesselCommissioningPeriods

public boolean addVesselCommissioningPeriods(VesselCommissioningPeriod elementToAdd)

Période d'armement, ou de mise en service, du navire. La mise en service est rattaché à un lieu terrestre de mise en service. Cela peut etre le pays d'armement ou le quartier d'armement.

Parameters:

elementToAdd - VesselCommissioningPeriod

Returns:

true if this collection changed as a result of the call

removeVesselCommissioningPeriods

public boolean removeVesselCommissioningPeriods(VesselCommissioningPeriod elementToRemove)

Période d'armement, ou de mise en service, du navire. La mise en service est rattaché à un lieu terrestre de mise en service. Cela peut etre le pays d'armement ou le quartier d'armement.

Parameters:

elementToRemove - VesselCommissioningPeriod

Returns:

true if this collection changed as a result of the call

equals

public boolean equals(Object object)

Returns true if the argument is an Vessel 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(Vessel o)

Specified by:

compareTo in interface Comparable<Vessel>

See Also:

Comparable.compareTo(T)