org.corpus_tools.salt.graph

Interface Relation<S extends Node,T extends Node>

Type Parameters:

S - source node of the relation

T - target node of the relation

All Superinterfaces:

IdentifiableElement, LabelableElement, Serializable

All Known Subinterfaces:

SCorpusDocumentRelation, SCorpusRelation, SDominanceRelation, SMedialRelation, SOrderRelation, SPointingRelation, SRelation<S,T>, SSequentialRelation<S,T,P>, SSpanningRelation, STextOverlappingRelation<S,T>, STextualRelation, STimelineRelation, STimeOverlappingRelation<S,T>

All Known Implementing Classes:

RelationImpl, SCorpusDocumentRelationImpl, SCorpusRelationImpl, SDominanceRelationImpl, SMedialRelationImpl, SOrderRelationImpl, SPointingRelationImpl, SRelationImpl, SSequentialRelationImpl, SSpanningRelationImpl, STextualRelationImpl, STimelineRelationImpl

public interface Relation<S extends Node,T extends Node>
extends IdentifiableElement

In graph theory an relation is a relation between two nodes, often an relation is realized as a pair of nodes. This interface defines a directed and labeled relation. A directed relation is a not symmetric relation. For instance if an relation relates a node a with a node b, it is not the case for the way around. A labeled relation is an relation, which can contain labels as defined in Label. An relation always belong to 0..1 Graphs and can also be contained in one or more Layer s.

Author:

florian

Method Summary

Modifier and Type	Method and Description
void	addLayer(Layer layer) Adds this relation to the passed layer.
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 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

Method Detail

getDelegate

Relation<S,T> getDelegate()

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

Returns:

the delegate object

getSource

S getSource()

Returns the source node of this relation object.

Returns:

source node

setSource

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.

Parameters:

source - source node

getTarget

T getTarget()

Returns the target node of this relation object.

Returns:

target node

setTarget

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.

Parameters:

target - target node

getGraph

Graph getGraph()

Returns the container graph of this relation.

Returns:

graph object which contains this relation.

setGraph

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.

Parameters:

graph - graph which contains this relation

getLayers

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.

Returns:

a set of layers containing this relation

addLayer

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.

Parameters:

layer - to which this node should be added

removeLayer

void removeLayer(Layer layer)

Removes this relation from the passed layer.

Parameters:

layer - from which this node should be removed