org.corpus_tools.salt.graph.impl

Class RelationImpl<S extends Node,T extends Node>

java.lang.Object

org.corpus_tools.salt.graph.impl.LabelableElementImpl

org.corpus_tools.salt.graph.impl.IdentifiableElementImpl

org.corpus_tools.salt.graph.impl.RelationImpl<S,T>

All Implemented Interfaces:

Serializable, IdentifiableElement, LabelableElement, Relation<S,T>

Direct Known Subclasses:

SRelationImpl

public class RelationImpl<S extends Node,T extends Node>
extends IdentifiableElementImpl
implements Relation<S,T>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Graph	graph container graph
protected S	source source node of this relation.

Fields inherited from class org.corpus_tools.salt.graph.impl.LabelableElementImpl

delegate, EXPECTED_NUMBER_OF_LABELS

Constructor Summary

Constructors

Constructor and Description
RelationImpl() Initializes an object of type Relation.
RelationImpl(Relation<S,T> delegate) Initializes an object of type Relation.

Method Summary

Modifier and Type	Method and Description
void	addLayer(Layer layer) Adds this relation to the passed layer.
protected void	basicSetGraph_WithoutRemoving(Graph graph) Same as basicSetGraph(Graph) but does not remove this relation from old graph, if it was not equal to the passed graph.
protected void	basicSetGraph(Graph graph) This is an internally used method.
Relation<S,T>	getDelegate() Returns the delegate object.
Graph	getGraph() Returns the container graph of this relation.
Set<? extends Layer>	getLayers() Returns all layers containing this relation.
S	getSource() Returns the source node of this relation object.
T	getTarget() Returns the target node of this relation object.
void	removeLayer(Layer layer) Removes this relation from the passed layer.
void	setGraph(Graph graph) Sets the container graph of this relation.
void	setSource(S source) Returns the source node of this relation object.
void	setTarget(T target) Sets the target node of this relation object.

Methods inherited from class org.corpus_tools.salt.graph.impl.IdentifiableElementImpl

getId, getIdentifier, removeLabel, setId, setIdentifier, toString

Methods inherited from class org.corpus_tools.salt.graph.impl.LabelableElementImpl

addLabel, basicAddLabel, basicRemoveLabel, containsLabel, getLabel, getLabel, getLabels, getLabelsByNamespace, removeAll, removeLabel, sizeLabels

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.corpus_tools.salt.graph.IdentifiableElement

getId, getIdentifier, setId, setIdentifier

Methods inherited from interface org.corpus_tools.salt.graph.LabelableElement

addLabel, containsLabel, getLabel, getLabel, getLabels, getLabelsByNamespace, removeAll, removeLabel, removeLabel, sizeLabels

Field Detail

source

protected S extends Node source

source node of this relation.

graph

protected Graph graph

container graph

Constructor Detail

RelationImpl

public RelationImpl()

Initializes an object of type Relation.

RelationImpl

public RelationImpl(Relation<S,T> delegate)

Initializes an object of type Relation. If LabelableElementImpl.delegate is not null, all functions of this method are delegated to the delegate object. Setting LabelableElementImpl.delegate makes this object to a container.

Parameters:

a - delegate object of the same type.

Method Detail

getDelegate

public Relation<S,T> getDelegate()

Returns the delegate object. If LabelableElementImpl.delegate is not null, all functions of this method are delegated to the delegate object. Setting LabelableElementImpl.delegate makes this object to a container.

Specified by:

getDelegate in interface Relation<S extends Node,T extends Node>

Overrides:

getDelegate in class IdentifiableElementImpl

Returns:

the delegate object

getSource

public S getSource()

Returns the source node of this relation object.

Specified by:

getSource in interface Relation<S extends Node,T extends Node>

Returns:

source node

setSource

public void setSource(S source)

Returns the source node of this relation object. If this relation belongs to a graph, the graph's indexes will be updated automatically. Notifies the graph, about the change of the source.

Specified by:

setSource in interface Relation<S extends Node,T extends Node>

Parameters:

source - source node

getTarget

public T getTarget()

Returns the target node of this relation object.

Specified by:

getTarget in interface Relation<S extends Node,T extends Node>

Returns:

target node

setTarget

public void setTarget(T target)

Sets the target node of this relation object. If this relation belongs to a graph, the graph's indexes will be updated automatically. Notifies the graph, about the change of the target.

Specified by:

setTarget in interface Relation<S extends Node,T extends Node>

Parameters:

target - target node

getGraph

public Graph getGraph()

Returns the container graph of this relation.

Specified by:

getGraph in interface Relation<S extends Node,T extends Node>

Returns:

graph object which contains this relation.

setGraph

public void setGraph(Graph graph)

Sets the container graph of this relation. The passed graph and this relation will be double chained, which means the method Graph.getRelations() will return a list containing this relation.

Specified by:

setGraph in interface Relation<S extends Node,T extends Node>

Parameters:

graph - graph which contains this relation

basicSetGraph

protected void basicSetGraph(Graph graph)

This is an internally used method. To implement a double chaining of Graph and Relation object when an relation is inserted into this graph and to avoid an endless invocation the insertion of an relation is splited into the two methods setGraph(Graph) and basicSetGraph(Graph). The invocation of methods is implement as follows:

 Graph.addRelation(Relation)                      Relation.setGraph(Graph)
         ||             \ /                   ||
         ||              X                    ||
         \/             / \                   \/
 Graph#basicAddRelation(Relation)            Relation#basicSetGraph(Graph)
 

That means method setGraph(Graph) calls basicSetGraph(Graph) and Graph#basicAddRelation(Relation). And method setGraph(Graph) calls Graph#basicAddRelation(Relation) and Relation#basicSetGraph(Graph).

Parameters:

graph - graph which contains this relation

basicSetGraph_WithoutRemoving

protected void basicSetGraph_WithoutRemoving(Graph graph)

Same as basicSetGraph(Graph) but does not remove this relation from old graph, if it was not equal to the passed graph.

Parameters:

graph -

getLayers

public Set<? extends Layer> getLayers()

Returns all layers containing this relation. This is a computed set and only works, when this relation is contained in a graph. If this list is used multiple times, it makes sense to store that set.

Specified by:

getLayers in interface Relation<S extends Node,T extends Node>

Returns:

a set of layers containing this relation

addLayer

public void addLayer(Layer layer)

Adds this relation to the passed layer. If this relation is not already contained in the layer's graph, it will be added to the graph.
Since the method getLayers() retrieves all layers by accessing the layers in graph, this class does not contain an own collection of layers.

Specified by:

addLayer in interface Relation<S extends Node,T extends Node>

Parameters:

layer - to which this node should be added

removeLayer

public void removeLayer(Layer layer)

Removes this relation from the passed layer.
Since the method getLayers() retrieves all layers by accessing the layers in graph, this class does not contain an own collection of layers.

Specified by:

removeLayer in interface Relation<S extends Node,T extends Node>

Parameters:

layer - from which this node should be removed