fr.ign.cogit.geoxygene.semio.legend.metadata

Class SemanticRelation

Object

SemanticRelation

public class SemanticRelation
extends Object

This software is released under the licence CeCILL see Licence_CeCILL-C_fr.html see Licence_CeCILL-C_en.html see http://www.cecill.info/a>

Author:

Sébastien Mustière - IGN / Laboratoire COGIT, Charlotte Hoarau - IGN / Laboratoire COGIT Relationship between legend components.

French:
Relation entre éléments de légende (ordre, association, dissociation). Le principe des codes d'amélioration de légende est de faire que ces relations théoriques soient bien en phase avec les relations prévues entre les couleurs.

See Also:

SemanticRelationDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASSOCIATION
static int	DIFFERENCE
static int	ORDER
static int	UNKNOWN

Constructor Summary

Constructors

Constructor and Description
SemanticRelation() Empty Constructor.
SemanticRelation(List<LegendComponent> relatedComponents, int type)

Method Summary

Modifier and Type	Method and Description
void	addRelatedComponents(LegendComponent element) Add a component to the components concerned by the relationship (two or more).
List<LegendComponent>	getRelatedComponents() Returns the components concerned by the relationship (2 or more).
SemanticRelationDescriptor	getSRD() Returns the semanticRelationDescriptor to which this layer belongs to.
int	getType() Returns the type of the relationship.
boolean	isAssociation()
boolean	isDifference()
boolean	isOrder()
void	removeRelatedComponents(LegendComponent element) Remove a component from the list of components concerned by the relationship (two or more).
void	setRelatedComponents(List<LegendComponent> elementsEnRelation) Specifies the components concerned by the relationship (2 or more).
void	setSRD(SemanticRelationDescriptor srd) Specifies the semanticRelationDescriptor to which this layer belongs to.
void	setType(int type) Specifies the type of the relationship.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

ASSOCIATION

public static final int ASSOCIATION

See Also:

Constant Field Values

DIFFERENCE

public static final int DIFFERENCE

See Also:

Constant Field Values

ORDER

public static final int ORDER

See Also:

Constant Field Values

Constructor Detail

SemanticRelation

public SemanticRelation()

Empty Constructor.

SemanticRelation

public SemanticRelation(List<LegendComponent> relatedComponents,
                        int type)

Method Detail

getType

public int getType()

Returns the type of the relationship. Possible values: see static variables.

setType

public void setType(int type)

Specifies the type of the relationship. Possible values: see static variables.

isAssociation

public boolean isAssociation()

isDifference

public boolean isDifference()

isOrder

public boolean isOrder()

getRelatedComponents

public List<LegendComponent> getRelatedComponents()

Returns the components concerned by the relationship (2 or more). NB: in case of ORDER, the order of components in the list goes from the least 'important' to the most 'important'

setRelatedComponents

public void setRelatedComponents(List<LegendComponent> elementsEnRelation)

Specifies the components concerned by the relationship (2 or more). NB: in case of ORDER, the order of components in the list goes from the least 'important' to the most 'important'

addRelatedComponents

public void addRelatedComponents(LegendComponent element)

Add a component to the components concerned by the relationship (two or more). NB: in case of ORDER, the order of components in the list goes from the least 'important' to the most 'important'

removeRelatedComponents

public void removeRelatedComponents(LegendComponent element)

Remove a component from the list of components concerned by the relationship (two or more). NB: in case of ORDER, the order of components in the list goes from the least 'important' to the most 'important'

getSRD

public SemanticRelationDescriptor getSRD()

Returns the semanticRelationDescriptor to which this layer belongs to.

Returns:

The semanticRelationDescriptor to which this layer belongs to.

setSRD

public void setSRD(SemanticRelationDescriptor srd)

Specifies the semanticRelationDescriptor to which this layer belongs to.

Parameters:

srd - The semanticRelationDescriptor to which this layer belongs to.

toString

public String toString()

Overrides:

toString in class Object