fr.ifremer.adagio.core.dao.referential.location

Class Location

Object

Location

All Implemented Interfaces:

Serializable, Comparable<Location>

Direct Known Subclasses:

LocationImpl

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Location()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Location o)
boolean	equals(Object object) Returns true if the argument is an Location instance and all identifiers for this entity equal the identifiers of the argument entity.
Float	getBathymetry() Valeur de la bathymétrie sur le lieu (optionnel).
String	getComments()
Boolean	getDaylightSavingTime() Indique s'il faut opérer le changement d'heure hiver-été, vrai par défaut.
Integer	getId() Identifiant unique du lieu.
String	getLabel() Code du lieuExemple : pour les ports : BR, SB
LocationClassification	getLocationClassification() Classification de lieu duquel dépend le lieu (doit être identique à celle du niveau de lieu)
LocationLevel	getLocationLevel() Niveau de lieu, ou catégorie.
String	getName() Libellé du lieu
Status	getStatus() Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire
Timestamp	getUpdateDate()
Short	getUtFormat() Format UT (Universal Time) de l'heure pour le lieu (0, +1, -4...).
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.
void	setBathymetry(Float bathymetryIn) Valeur de la bathymétrie sur le lieu (optionnel).
void	setComments(String commentsIn)
void	setDaylightSavingTime(Boolean daylightSavingTimeIn) Indique s'il faut opérer le changement d'heure hiver-été, vrai par défaut.
void	setId(Integer idIn) Identifiant unique du lieu.
void	setLabel(String labelIn) Code du lieuExemple : pour les ports : BR, SB
void	setLocationClassification(LocationClassification locationClassificationIn) Classification de lieu duquel dépend le lieu (doit être identique à celle du niveau de lieu)
void	setLocationLevel(LocationLevel locationLevelIn) Niveau de lieu, ou catégorie.
void	setName(String nameIn) Libellé du lieu
void	setStatus(Status statusIn) Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire
void	setUpdateDate(Timestamp updateDateIn)
void	setUtFormat(Short utFormatIn) Format UT (Universal Time) de l'heure pour le lieu (0, +1, -4...).
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

Location

public Location()

Method Detail

getId

public Integer getId()

Identifiant unique du lieu. Généré par le système.

Returns:

this.id Integer

setId

public void setId(Integer idIn)

Identifiant unique du lieu. Généré par le système.

Parameters:

idIn - Integer

getLabel

public String getLabel()

Code du lieuExemple : pour les ports : BR, SB

Returns:

this.label String

setLabel

public void setLabel(String labelIn)

Code du lieuExemple : pour les ports : BR, SB

Parameters:

labelIn - String

getName

public String getName()

Libellé du lieu

Returns:

this.name String

setName

public void setName(String nameIn)

Libellé du lieu

Parameters:

nameIn - String

getBathymetry

public Float getBathymetry()

Valeur de la bathymétrie sur le lieu (optionnel). La bathymétrie peut être positive ou négative.

Returns:

this.bathymetry Float

setBathymetry

public void setBathymetry(Float bathymetryIn)

Valeur de la bathymétrie sur le lieu (optionnel). La bathymétrie peut être positive ou négative.

Parameters:

bathymetryIn - Float

getUtFormat

public Short getUtFormat()

Format UT (Universal Time) de l'heure pour le lieu (0, +1, -4...). En France métropolitaine, par exemple : +1 (= heure Europe/Paris)

Returns:

this.utFormat Short

setUtFormat

public void setUtFormat(Short utFormatIn)

Format UT (Universal Time) de l'heure pour le lieu (0, +1, -4...). En France métropolitaine, par exemple : +1 (= heure Europe/Paris)

Parameters:

utFormatIn - Short

getDaylightSavingTime

public Boolean getDaylightSavingTime()

Indique s'il faut opérer le changement d'heure hiver-été, vrai par défaut. En France métropolitaine, par exemple : Vrai.

Returns:

this.daylightSavingTime Boolean

setDaylightSavingTime

public void setDaylightSavingTime(Boolean daylightSavingTimeIn)

Indique s'il faut opérer le changement d'heure hiver-été, vrai par défaut. En France métropolitaine, par exemple : Vrai.

Parameters:

daylightSavingTimeIn - Boolean

getComments

public String getComments()

Returns:

this.comments String

setComments

public void setComments(String commentsIn)

Parameters:

commentsIn - String

getUpdateDate

public Timestamp getUpdateDate()

Returns:

this.updateDate Timestamp

setUpdateDate

public void setUpdateDate(Timestamp updateDateIn)

Parameters:

updateDateIn - Timestamp

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

getLocationClassification

public LocationClassification getLocationClassification()

Classification de lieu duquel dépend le lieu (doit être identique à celle du niveau de lieu)

Returns:

this.locationClassification LocationClassification

setLocationClassification

public void setLocationClassification(LocationClassification locationClassificationIn)

Classification de lieu duquel dépend le lieu (doit être identique à celle du niveau de lieu)

Parameters:

locationClassificationIn - LocationClassification

getLocationLevel

public LocationLevel getLocationLevel()

Niveau de lieu, ou catégorie. Il s'agit d'un regroupement de haut niveau d'un ensemble de lieux de meme nature géographique. Par exemple, pour la classification de lieu "Secteur maritime", on aura : - Zone FAO, - Sous-Zone FAO, - Division CIEM, - Sous-division CIEM - etc. Pour la classification de lieu "lieux territoriaux", on aura : - Pays - Region, - Département, - Quartier Maritme, - Port - ... On pourra trouver d'autre niveau de lieu, comme : - implantation Ifremer - laboratoire côtier, ...

Returns:

this.locationLevel LocationLevel

setLocationLevel

public void setLocationLevel(LocationLevel locationLevelIn)

Niveau de lieu, ou catégorie. Il s'agit d'un regroupement de haut niveau d'un ensemble de lieux de meme nature géographique. Par exemple, pour la classification de lieu "Secteur maritime", on aura : - Zone FAO, - Sous-Zone FAO, - Division CIEM, - Sous-division CIEM - etc. Pour la classification de lieu "lieux territoriaux", on aura : - Pays - Region, - Département, - Quartier Maritme, - Port - ... On pourra trouver d'autre niveau de lieu, comme : - implantation Ifremer - laboratoire côtier, ...

Parameters:

locationLevelIn - LocationLevel

getStatus

public Status getStatus()

Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire. - obsolète (=inactif) : '0' - valide (=actif) : '1' - temporaire : '2' - en cours de suppression : '3' - : '4' note : on a préfère ici 'valide' au terme 'actif' (utilisé dans Harmonie), pour ne pas confondre avec par exemple l'activité d'un navire sur un mois.

Returns:

this.status Status

setStatus

public void setStatus(Status statusIn)

Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire. - obsolète (=inactif) : '0' - valide (=actif) : '1' - temporaire : '2' - en cours de suppression : '3' - : '4' note : on a préfère ici 'valide' au terme 'actif' (utilisé dans Harmonie), pour ne pas confondre avec par exemple l'activité d'un navire sur un mois.

Parameters:

statusIn - Status

equals

public boolean equals(Object object)

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

Specified by:

compareTo in interface Comparable<Location>

See Also:

Comparable.compareTo(T)