org.corpus_tools.salt.graph

Interface Node

All Superinterfaces:

IdentifiableElement, LabelableElement, Serializable

All Known Subinterfaces:

SCorpus, SDocument, SMedialDS, SNode, SSequentialDS<D,P>, SSpan, SStructure, SStructuredNode, STextualDS, STimeline, SToken

All Known Implementing Classes:

NodeImpl, SCorpusImpl, SDocumentImpl, SMedialDSImpl, SNodeImpl, SSequentialDSImpl, SSpanImpl, SStructureImpl, STextualDSImpl, STimelineImpl, STokenImpl

public interface Node
extends IdentifiableElement

In graph theory a node is a placeholder, which can be related with other nodes via an relation. The here defined node, is a labeled node, which means, it can contain a set of Labels. Am node always belong to 0..1 Graphs and can also be contained in one or more Layers.

Author:

florian

Method Summary

Modifier and Type	Method and Description
void	addLayer(Layer layer) Adds this node to the passed layer.
Graph	getGraph() Returns the container graph of this node.
Set<? extends Layer>	getLayers() Returns all layers containing this node.
void	removeLayer(Layer layer) Removes this node from the passed layer.
void	setGraph(Graph graph) Sets the container graph of this node.

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

getGraph

Graph getGraph()

Returns the container graph of this node.

Returns:

graph object which contains this node.

setGraph

void setGraph(Graph graph)

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

Parameters:

graph - graph which contains this node

getLayers

Set<? extends Layer> getLayers()

Returns all layers containing this node. This is a computed set and only works, when this node 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 node

addLayer

void addLayer(Layer layer)

Adds this node to the passed layer. If this node 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 node from the passed layer.

Parameters:

layer - from which this node should be removed