org.corpus_tools.salt.core

Interface SGraph

All Superinterfaces:

Graph<SNode,SRelation<SNode,SNode>,SLayer>, IdentifiableElement, LabelableElement, SAnnotationContainer, Serializable, SNamedElement, SPathElement

All Known Subinterfaces:

SCorpusGraph, SDocumentGraph

All Known Implementing Classes:

SCorpusGraphImpl, SDocumentGraphImpl, SGraphImpl

public interface SGraph
extends Graph<SNode,SRelation<SNode,SNode>,SLayer>, SAnnotationContainer, SNamedElement, SPathElement

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SGraph.GRAPH_TRAVERSE_TYPE The SGraph.GRAPH_TRAVERSE_TYPE determines the the traversal order.

Method Summary

Methods

Modifier and Type	Method and Description
List<SLayer>	getLayerByName(String layerName) Searches for a layer or a set of layers having the given layer name.
List<SNode>	getLeafs() Returns all leaf nodes, if exist.
List<SNode>	getNodesByName(String nodeName) Searches for a node or a set of nodes having the given node name.
List<SRelation>	getRelationsByName(String relationName) Searches for a relation or a set of relations having the given relation name.
List<SNode>	getRoots() Returns all root nodes, if exist.
void	traverse(List<? extends SNode> startNodes, SGraph.GRAPH_TRAVERSE_TYPE traverseType, String traverseId, GraphTraverseHandler traverseHandler, boolean isCycleSafe) Attention: When isCycleSafe is set to false, this method does not take care about cycles, and it eventually runs into endless loops.
void	traverse(List<SNode> startNodes, SGraph.GRAPH_TRAVERSE_TYPE traverseType, String traverseId, GraphTraverseHandler traverseHandler) Traverses a graph in the given order traverseType and starts traversing with the given startNodes.

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

addLayer, addNode, addRelation, containsLayer, containsNode, containsRelation, getIndexMgr, getInRelations, getLayer, getLayers, getNode, getNodes, getOutRelations, getRelation, getRelations, getRelations, removeLayer, removeNode, removeRelation, removeRelations

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

Methods inherited from interface org.corpus_tools.salt.core.SAnnotationContainer

addAnnotation, addFeature, addMetaAnnotation, addProcessingAnnotation, createAnnotation, createAnnotations, createFeature, createFeatures, createMetaAnnotation, createMetaAnnotations, createProcessingAnnotation, createProcessingAnnotations, getAnnotation, getAnnotation, getAnnotations, getFeature, getFeature, getFeatures, getMetaAnnotation, getMetaAnnotations, getProcessingAnnotation, getProcessingAnnotations, iterator_SAnnotation, iterator_SFeature, iterator_SMetaAnnotation, iterator_SProcessingAnnotation

Methods inherited from interface org.corpus_tools.salt.core.SNamedElement

getName, setName

Methods inherited from interface org.corpus_tools.salt.core.SPathElement

getPath

Method Detail

getRoots

List<SNode> getRoots()

Returns all root nodes, if exist. A root node is a node, which has no incoming relations.

Returns:

list of nodes being roots in the given graph.

getLeafs

List<SNode> getLeafs()

Returns all leaf nodes, if exist. A leaf node is a node, which has no outgoing relations.

Returns:

list of nodes being leafs in the given graph.

traverse

void traverse(List<SNode> startNodes,
            SGraph.GRAPH_TRAVERSE_TYPE traverseType,
            String traverseId,
            GraphTraverseHandler traverseHandler)

Traverses a graph in the given order traverseType and starts traversing with the given startNodes. When a node is reached, first this method will invoke the method GraphTraverseHandler#checkConstraint(GRAPH_TRAVERSE_MODE, String, Edge, Node, long) of the given callback handler traverseHandler, second the method GraphTraverseHandler#nodeReached(GRAPH_TRAVERSE_MODE, String, Node, Edge, Node, long) is invoked. When a node was left, the method GraphTraverseHandler#nodeLeft(GRAPH_TRAVERSE_MODE, String, Node, Edge, Node, long) is invoked. When calling these methods, the traverseId will be passed, so that the callback handler knows which traversal is meant. This is helpful, in case of a single callback handler is used for more than one traversal at the same time. This method throws a GraphTraverserException in case of the graph contains a cycle. A cycle means a path containing the same node twice.

Parameters:

startNodes - list of nodes at which the traversal shall start

traverseType - type of traversing

traverseId - identification for callback handler, in case of more than one traversal is running at the same time with the same callback handler

traverseHandler - callback handler, on which the three methods will be invoked

traverse

void traverse(List<? extends SNode> startNodes,
            SGraph.GRAPH_TRAVERSE_TYPE traverseType,
            String traverseId,
            GraphTraverseHandler traverseHandler,
            boolean isCycleSafe)

Attention: When isCycleSafe is set to false, this method does not take care about cycles, and it eventually runs into endless loops.

getNodesByName

List<SNode> getNodesByName(String nodeName)

Searches for a node or a set of nodes having the given node name.

Parameters:

nodeName - Name of the node to search for

Returns:

A complete list of all matching nodes. Is never null.

getRelationsByName

List<SRelation> getRelationsByName(String relationName)

Searches for a relation or a set of relations having the given relation name.

Parameters:

relationName - Name of the relation to search for

Returns:

A complete list of all matching relations. Is never null.

getLayerByName

List<SLayer> getLayerByName(String layerName)

Searches for a layer or a set of layers having the given layer name.

Parameters:

layerName - Name of the layer to search for

Returns:

A complete list of all matching layers. Is never null.