org.corpus_tools.salt.graph

Interface Layer<N extends Node,R extends Relation<N,N>>

All Superinterfaces:

IdentifiableElement, LabelableElement, Serializable

All Known Subinterfaces:

SLayer

All Known Implementing Classes:

LayerImpl, SLayerImpl

public interface Layer<N extends Node,R extends Relation<N,N>>
extends IdentifiableElement

A layer is a grouping mechanism for nodes and relations, and can also contain further layers (called sub layers). The containment relation implements a recursive structure for layers, to build hierarchies. In general this mechanism enables the creation of sub graphs. But note that a layer cannot be contained by itself, so cycles of layers are not possible.

Author:

florian

Method Summary

Modifier and Type	Method and Description
void	addNode(N node) Adds the passed node to this layer.
void	addRelation(Relation<? extends N,? extends N> relation) Adds the passed relation to this layer.
Graph	getGraph() Returns the container graph of this node.
Set<N>	getNodes() Returns a set of all contained nodes, in the order how the nodes were inserted.
Set<R>	getRelations() Returns a set of all contained relations, in the order how the relations were inserted.
void	removeNode(N node) Removes the passed node from this layer.
void	removeRelation(Relation<? extends N,? extends N> relation) Removes the passed relation from this 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. For double chaining between this Layer and the passed Graph object, the real insertion is done by method #basicSetGraph(Graph).

Parameters:

graph - graph which contains this layer

addNode

void addNode(N node)

Adds the passed node to this layer. The insertion order is preserved. If this layer is contained by a graph, the passed node is also added to the graph in case it was not already contained in the graph.

Parameters:

node - node to be inserted into this layer

removeNode

void removeNode(N node)

Removes the passed node from this layer. If the passed relation is null, nothing is done.

Parameters:

node - to be removed

getNodes

Set<N> getNodes()

Returns a set of all contained nodes, in the order how the nodes were inserted.

Returns:

all contained nodes

addRelation

void addRelation(Relation<? extends N,? extends N> relation)

Adds the passed relation to this layer. The insertion order is preserved. If this layer is contained by a graph, the passed relation is also added to the graph in case it was not already contained in the graph.

Parameters:

relation - relation to be inserted into this layer

removeRelation

void removeRelation(Relation<? extends N,? extends N> relation)

Removes the passed relation from this layer. If the passed relation is null, nothing is done.

Parameters:

relation - to be removed

getRelations

Set<R> getRelations()

Returns a set of all contained relations, in the order how the relations were inserted.

Returns:

all contained relations