fr.ifremer.adagio.core.dao.technical.optimization.location

Class LocationHierarchy

Object

LocationHierarchy

All Implemented Interfaces:

Serializable, Comparable<LocationHierarchy>

Direct Known Subclasses:

LocationHierarchyImpl

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
LocationHierarchy()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(LocationHierarchy o)
boolean	equals(Object object) This entity does not have any identifiers and is not extending any other entity, so this method will only return true if the argument reference and this refer to the same object.
Float	getChildSurfaceRatio() Ratio de couverture (en surface) du lieu fils par rapport au lieu père.
Location	getLocation() Représente un lieu au sens général du terme.
LocationHierarchyPK	getLocationHierarchyPk() Get the composite primary key identifier class
Location	getParent() Représente un lieu au sens général du terme.
int	hashCode() This entity does not have any identifiers and is not extending any other entity, so this method will only take the identifiers of this entity into account when calculating the hash code.
Boolean	isIsMainAssociation() Indique si l'association est considérée comme la principale.
void	setChildSurfaceRatio(Float childSurfaceRatioIn) Ratio de couverture (en surface) du lieu fils par rapport au lieu père.
void	setIsMainAssociation(Boolean isMainAssociationIn) Indique si l'association est considérée comme la principale.
void	setLocation(Location locationIn) Représente un lieu au sens général du terme.
void	setLocationHierarchyPk(LocationHierarchyPK locationHierarchyPkIn) Set the composite primary key identifier class
void	setParent(Location parentIn) Représente un lieu au sens général du terme.

Methods inherited from class Object

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

Constructor Detail

LocationHierarchy

public LocationHierarchy()

Method Detail

getLocationHierarchyPk

public LocationHierarchyPK getLocationHierarchyPk()

Get the composite primary key identifier class

Returns:

locationHierarchyPk

setLocationHierarchyPk

public void setLocationHierarchyPk(LocationHierarchyPK locationHierarchyPkIn)

Set the composite primary key identifier class

Parameters:

locationHierarchyPkIn -

getChildSurfaceRatio

public Float getChildSurfaceRatio()

Ratio de couverture (en surface) du lieu fils par rapport au lieu père. La valeur doit etre supérieure strictement à 0 et inférieur ou égale à 1. Déduit à partir de la valeur de LocationAssociation.childSurfaceRatio, selon un algorithme de parcours d'arbre (cf procedure stockée P_FILL_LOCATION_HIERARCHY)

Returns:

this.childSurfaceRatio Float

setChildSurfaceRatio

public void setChildSurfaceRatio(Float childSurfaceRatioIn)

Ratio de couverture (en surface) du lieu fils par rapport au lieu père. La valeur doit etre supérieure strictement à 0 et inférieur ou égale à 1. Déduit à partir de la valeur de LocationAssociation.childSurfaceRatio, selon un algorithme de parcours d'arbre (cf procedure stockée P_FILL_LOCATION_HIERARCHY)

Parameters:

childSurfaceRatioIn - Float

isIsMainAssociation

public Boolean isIsMainAssociation()

Indique si l'association est considérée comme la principale.

Dans le cas d'une zone en mer rattachée à plusieurs zones parente, cela permet de de récupérer qu'une seule zone (utiliser notamment pour le SIG SIH)

Returns:

this.isMainAssociation Boolean

setIsMainAssociation

public void setIsMainAssociation(Boolean isMainAssociationIn)

Indique si l'association est considérée comme la principale.

Dans le cas d'une zone en mer rattachée à plusieurs zones parente, cela permet de de récupérer qu'une seule zone (utiliser notamment pour le SIG SIH)

Parameters:

isMainAssociationIn - Boolean

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

getParent

public Location getParent()

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.parent Location

setParent

public void setParent(Location parentIn)

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:

parentIn - Location

equals

public boolean equals(Object object)

This entity does not have any identifiers and is not extending any other entity, so this method will only return true if the argument reference and this refer to the same object.

Overrides:

equals in class Object

hashCode

public int hashCode()

This entity does not have any identifiers and is not extending any other entity, so this method will only take the identifiers of this entity into account when calculating the hash code.

Overrides:

hashCode in class Object

compareTo

public int compareTo(LocationHierarchy o)

Specified by:

compareTo in interface Comparable<LocationHierarchy>

See Also:

Comparable.compareTo(T)