org.corpus_tools.salt.core.impl

Class SGraphImpl

java.lang.Object

org.corpus_tools.salt.graph.impl.LabelableElementImpl

org.corpus_tools.salt.graph.impl.IdentifiableElementImpl

org.corpus_tools.salt.graph.impl.GraphImpl<SNode,SRelation<SNode,SNode>,SLayer>

org.corpus_tools.salt.core.impl.SGraphImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

SCorpusGraphImpl, SDocumentGraphImpl

public class SGraphImpl
extends GraphImpl<SNode,SRelation<SNode,SNode>,SLayer>
implements SGraph

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.corpus_tools.salt.core.SGraph

SGraph.GRAPH_TRAVERSE_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
protected SFeature	name The feature object containing the name of the node

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

approximatedNodeDegree, expectedNodes, expectedRelations, indexMgr

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

EXPECTED_NUMBER_OF_LABELS

Constructor Summary

Constructors

Constructor and Description
SGraphImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAnnotation(SAnnotation annotation) Adds the passed annotation to this container.
void	addFeature(SFeature feature) Adds the passed feature to this container.
void	addLayer(SLayer layer) Adds the passed layer to this graph.
void	addMetaAnnotation(SMetaAnnotation metaAnnotation) Adds the passed meta annotation to this container.
void	addProcessingAnnotation(SProcessingAnnotation annotation) Adds the passed processing-annotation to this container.
SAnnotation	createAnnotation(String namespace, String name, Object value) Creates and returns an annotation having the passed namespace, name and value.
Set<SAnnotation>	createAnnotations(String annotationString) This method parses the given annotation String and adds an SAnnotation object for each annotation being contained in that string to the given SAnnotationContainer object.
SFeature	createFeature(String namespace, String name, Object value) Creates and returns an feature having the passed namespace, name and value.
Set<SFeature>	createFeatures(String featureString) This method parses the given feature String and adds an SFeature object for each feature being contained in that string to the given SAnnotationContainer object.
SMetaAnnotation	createMetaAnnotation(String namespace, String name, Object value) Creates and returns a meta annotation having the passed namespace, name and value.
Set<SMetaAnnotation>	createMetaAnnotations(String annotationString) This method parses the given meta annotation String and adds an SMetaAnnotation object for each meta annotation being contained in that string to the given SAnnotationContainer object.
SProcessingAnnotation	createProcessingAnnotation(String namespace, String name, Object value) Creates and returns a processing-annotation having the passed namespace, name and value.
Set<SProcessingAnnotation>	createProcessingAnnotations(String annotationString) This method parses the given processing-annotation String and adds an SProcessingAnnotation object for each processing-annotation being contained in that string to the given SAnnotationContainer object.
SAnnotation	getAnnotation(String qName) Returns an annotation having the passed qualified name, if this container contains such an annotation.
SAnnotation	getAnnotation(String namespace, String name) Returns an annotation having the passed qualified name, if this container contains such an annotation.
<A extends SAnnotation> Set<A>	getAnnotations() Returns all annotations contained by this object.
SFeature	getFeature(String qName) Returns an feature having the passed qualified name, if this container contains such an feature.
SFeature	getFeature(String namespace, String name) Returns an feature having the passed qualified name, if this container contains such an feature.
<A extends SFeature> Set<A>	getFeatures() Returns all features contained by this object.
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.
SMetaAnnotation	getMetaAnnotation(String qName) Returns a meta annotation having the passed qualified name, if this container contains such a meta annotation.
<A extends SMetaAnnotation> Set<A>	getMetaAnnotations() Returns all meta annotations contained by this object.
String	getName() Returns the name of this element.
List<SNode>	getNodesByName(String nodeName) Searches for a node or a set of nodes having the given node name.
org.eclipse.emf.common.util.URI	getPath() Returns the id of this object as a URI path If no Id exists, null is returned.
SProcessingAnnotation	getProcessingAnnotation(String qName) Returns a processing-annotation having the passed qualified name, if this container contains such a processing-annotation.
<A extends SProcessingAnnotation> Set<A>	getProcessingAnnotations() Returns all processing-annotations contained by this object.
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.
Iterator<SAnnotation>	iterator_SAnnotation() Returns an iterator to iterate over the SAnnotation objects contained by this container.
Iterator<SFeature>	iterator_SFeature() Returns an iterator to iterate over the SFeature objects contained by this container.
Iterator<SMetaAnnotation>	iterator_SMetaAnnotation() Returns an iterator to iterate over the SMetaAnnotation objects contained by this container.
Iterator<SProcessingAnnotation>	iterator_SProcessingAnnotation() Returns an iterator to iterate over the SProcessingAnnotation objects contained by this container.
void	removeLabel(String qName) Removes the label having the passed qName.
void	setName(String name) Sets the name of the element.
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 class org.corpus_tools.salt.graph.impl.GraphImpl

addNode, addRelation, basicAddLayer, basicAddNode, basicAddRelation, basicRemoveLayer, basicRemoveNode, basicRemoveRelation, containsLayer, containsNode, containsRelation, getIndexMgr, getInRelations, getLayer, getLayers, getNode, getNodes, getOutRelations, getRelation, getRelations, getRelations, init, removeLayer, removeNode, removeRelation, removeRelations, update

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

getId, getIdentifier, 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.Graph

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, sizeLabels

Field Detail

name

protected SFeature name

The feature object containing the name of the node

Constructor Detail

SGraphImpl

public SGraphImpl()

Method Detail

addLayer

public void addLayer(SLayer layer)

Adds the passed layer to this graph. If layer is null or layer is already contained nothing is inserted. The passed layer and this graph will be double chained, which means the method Layer.getGraph() will return this graph. If the passed layer contains nodes or relations, which are not already contained by the graph, they will be added.

Specified by:

addLayer in interface Graph<SNode,SRelation<SNode,SNode>,SLayer>

Overrides:

addLayer in class GraphImpl<SNode,SRelation<SNode,SNode>,SLayer>

Parameters:

layer - layer to be inserted

getNodesByName

public List<SNode> getNodesByName(String nodeName)

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

Specified by:

getNodesByName in interface SGraph

Parameters:

nodeName - Name of the node to search for

Returns:

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

getRelationsByName

public List<SRelation> getRelationsByName(String relationName)

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

Specified by:

getRelationsByName in interface SGraph

Parameters:

relationName - Name of the relation to search for

Returns:

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

getLayerByName

public List<SLayer> getLayerByName(String layerName)

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

Specified by:

getLayerByName in interface SGraph

Parameters:

layerName - Name of the layer to search for

Returns:

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

getRoots

public List<SNode> getRoots()

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

Specified by:

getRoots in interface SGraph

Returns:

list of nodes being roots in the given graph.

getLeafs

public List<SNode> getLeafs()

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

Specified by:

getLeafs in interface SGraph

Returns:

list of nodes being leafs in the given graph.

traverse

public 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.

Specified by:

traverse in interface SGraph

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

public 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.

Specified by:

traverse in interface SGraph

removeLabel

public void removeLabel(String qName)

Description copied from class: IdentifiableElementImpl

Removes the label having the passed qName. In case the passed qualified name is equal to SaltUtil.LABEL_ID_QNAME the internal reference to IdentifiableElementImpl.identifier is set to null.

Specified by:

removeLabel in interface LabelableElement

Overrides:

removeLabel in class IdentifiableElementImpl

Parameters:

qName - qualified name of the Label to be removed

getName

public String getName()

Returns the name of this element. The name of the element is not the identifier of the element. The identifier is given by the graph and constructed as a URI, where the name is used as fragment. If this is not unique, the graph will add a number to the fragment to make it unique.

Specified by:

getName in interface SNamedElement

Returns:

name of the element.

setName

public void setName(String name)

Sets the name of the element. The name of the element is not the identifier of the element. The identifier is given by the graph and constructed as a URI, where the name is used as fragment. If this is not unique, the graph will add a number to the fragment to make it unique.

Specified by:

setName in interface SNamedElement

Parameters:

name - name of the element.

createAnnotation

public SAnnotation createAnnotation(String namespace,
                           String name,
                           Object value)

Creates and returns an annotation having the passed namespace, name and value.

Specified by:

createAnnotation in interface SAnnotationContainer

Parameters:

namespace - namespace of the annotation

name - name of the annotation

value - value of the annotation

Returns:

the created annotation

createAnnotations

public Set<SAnnotation> createAnnotations(String annotationString)

This method parses the given annotation String and adds an SAnnotation object for each annotation being contained in that string to the given SAnnotationContainer object. The syntax for Annotations is:
(SNS::)?SNAME(=SVALUE)?(;SNS::SNAME=SVALUE)+
where SNS is the namespace of the annotation, SNAME is its name and SVALUE is the value of the annotation

Specified by:

createAnnotations in interface SAnnotationContainer

Parameters:

annotationString - String containing the annotations

addAnnotation

public void addAnnotation(SAnnotation annotation)

Adds the passed annotation to this container.

Specified by:

addAnnotation in interface SAnnotationContainer

Parameters:

annotation - annotation to be added

getAnnotations

public <A extends SAnnotation> Set<A> getAnnotations()

Returns all annotations contained by this object.

Attention: This method is slow, since it iterates over all contained labels and creates a new list of all SAnnotation objects. Use SAnnotationContainer.iterator_SAnnotation() instead.

Specified by:

getAnnotations in interface SAnnotationContainer

Returns:

a list of all annotations

getAnnotation

public SAnnotation getAnnotation(String qName)

Returns an annotation having the passed qualified name, if this container contains such an annotation.

Specified by:

getAnnotation in interface SAnnotationContainer

Parameters:

qName - the qualified of the annotation. A qualified name consists of: namespace+'::'+name

Returns:

an annotation having the qualified name, if such an annotation exists, null otherwise

getAnnotation

public SAnnotation getAnnotation(String namespace,
                        String name)

Returns an annotation having the passed qualified name, if this container contains such an annotation.

Specified by:

getAnnotation in interface SAnnotationContainer

Parameters:

namespace - the namespace of the annotation.

name - the name of the annotation.

Returns:

an annotation having the qualified name, if such an annotation exists, null otherwise

iterator_SAnnotation

public Iterator<SAnnotation> iterator_SAnnotation()

Returns an iterator to iterate over the SAnnotation objects contained by this container. Using an iterator is slightly faster than SAnnotationContainer.getAnnotations().

Specified by:

iterator_SAnnotation in interface SAnnotationContainer

Returns:

an iterator of SAnnotation objects

addMetaAnnotation

public void addMetaAnnotation(SMetaAnnotation metaAnnotation)

Adds the passed meta annotation to this container.

Specified by:

addMetaAnnotation in interface SAnnotationContainer

Parameters:

metaAnnotation - meta annotation to be added

createMetaAnnotation

public SMetaAnnotation createMetaAnnotation(String namespace,
                                   String name,
                                   Object value)

Creates and returns a meta annotation having the passed namespace, name and value.

Specified by:

createMetaAnnotation in interface SAnnotationContainer

Parameters:

namespace - namespace of the meta annotation

name - name of the meta annotation

value - value of the meta annotation

Returns:

the created meta annotation

createMetaAnnotations

public Set<SMetaAnnotation> createMetaAnnotations(String annotationString)

This method parses the given meta annotation String and adds an SMetaAnnotation object for each meta annotation being contained in that string to the given SAnnotationContainer object. The syntax for meta annotations is:
(SNS::)?SNAME(=SVALUE)?(;SNS::SNAME=SVALUE)+
where SNS is the namespace of the meta annotation, SNAME is its name and SVALUE is the value of the meta annotation

Specified by:

createMetaAnnotations in interface SAnnotationContainer

Parameters:

annotationString - String containing the meta annotations

getMetaAnnotations

public <A extends SMetaAnnotation> Set<A> getMetaAnnotations()

Description copied from interface: SAnnotationContainer

Returns all meta annotations contained by this object.

Attention: This method is slow, since it iterates over all contained labels and creates a new list of all SAnnotation objects. Use SAnnotationContainer.iterator_SAnnotation() instead.

Specified by:

getMetaAnnotations in interface SAnnotationContainer

Returns:

a list of all meta annotations

getMetaAnnotation

public SMetaAnnotation getMetaAnnotation(String qName)

Description copied from interface: SAnnotationContainer

Returns a meta annotation having the passed qualified name, if this container contains such a meta annotation.

Specified by:

getMetaAnnotation in interface SAnnotationContainer

Parameters:

qName - the qualified of the meta annotation. A qualified name consists of: namespace+'::'+name

Returns:

a meta annotation having the qualified name, if such a meta annotation exists, null otherwise

iterator_SMetaAnnotation

public Iterator<SMetaAnnotation> iterator_SMetaAnnotation()

Description copied from interface: SAnnotationContainer

Returns an iterator to iterate over the SMetaAnnotation objects contained by this container. Using an iterator is slightly faster than SAnnotationContainer.getMetaAnnotations().

Specified by:

iterator_SMetaAnnotation in interface SAnnotationContainer

Returns:

an iterator of SAnnotation objects

createProcessingAnnotation

public SProcessingAnnotation createProcessingAnnotation(String namespace,
                                               String name,
                                               Object value)

Creates and returns a processing-annotation having the passed namespace, name and value.

Specified by:

createProcessingAnnotation in interface SAnnotationContainer

Parameters:

namespace - namespace of the processing-annotation

name - name of the processing-annotation

value - value of the processing-annotation

Returns:

the created processing-annotation

createProcessingAnnotations

public Set<SProcessingAnnotation> createProcessingAnnotations(String annotationString)

This method parses the given processing-annotation String and adds an SProcessingAnnotation object for each processing-annotation being contained in that string to the given SAnnotationContainer object. The syntax for processing-annotations is:
(SNS::)?SNAME(=SVALUE)?(;SNS::SNAME=SVALUE)+
where SNS is the namespace of the processing-annotation, SNAME is its name and SVALUE is the value of the processing-annotation

Specified by:

createProcessingAnnotations in interface SAnnotationContainer

Parameters:

annotationString - String containing the processing-annotations

addProcessingAnnotation

public void addProcessingAnnotation(SProcessingAnnotation annotation)

Adds the passed processing-annotation to this container.

Specified by:

addProcessingAnnotation in interface SAnnotationContainer

Parameters:

annotation - annotation to be added

getProcessingAnnotations

public <A extends SProcessingAnnotation> Set<A> getProcessingAnnotations()

Returns all processing-annotations contained by this object.

Attention: This method is slow, since it iterates over all contained labels and creates a new list of all SProcessingAnnotation objects. Use SAnnotationContainer.iterator_SProcessingAnnotation() instead.

Specified by:

getProcessingAnnotations in interface SAnnotationContainer

Returns:

a list of all processing-annotations

getProcessingAnnotation

public SProcessingAnnotation getProcessingAnnotation(String qName)

Returns a processing-annotation having the passed qualified name, if this container contains such a processing-annotation.

Specified by:

getProcessingAnnotation in interface SAnnotationContainer

Parameters:

qName - the qualified of the processing-annotation. A qualified name consists of: namespace+'::'+name

Returns:

an processing-annotation having the qualified name, if such an processing-annotation exists, null otherwise

iterator_SProcessingAnnotation

public Iterator<SProcessingAnnotation> iterator_SProcessingAnnotation()

Returns an iterator to iterate over the SProcessingAnnotation objects contained by this container. Using an iterator is slightly faster than SAnnotationContainer.getProcessingAnnotations().

Specified by:

iterator_SProcessingAnnotation in interface SAnnotationContainer

Returns:

an iterator of SAnnotation objects

createFeature

public SFeature createFeature(String namespace,
                     String name,
                     Object value)

Creates and returns an feature having the passed namespace, name and value.

Specified by:

createFeature in interface SAnnotationContainer

Parameters:

namespace - namespace of the feature

name - name of the feature

value - value of the feature

Returns:

the created feature

createFeatures

public Set<SFeature> createFeatures(String featureString)

This method parses the given feature String and adds an SFeature object for each feature being contained in that string to the given SAnnotationContainer object. The syntax for Features is:
(SNS::)?SNAME(=SVALUE)?(;SNS::SNAME=SVALUE)+
where SNS is the namespace of the feature, SNAME is its name and SVALUE is the value of the feature

Specified by:

createFeatures in interface SAnnotationContainer

Parameters:

featureString - String containing the features

addFeature

public void addFeature(SFeature feature)

Adds the passed feature to this container.

Specified by:

addFeature in interface SAnnotationContainer

Parameters:

feature - feature to be added

getFeatures

public <A extends SFeature> Set<A> getFeatures()

Returns all features contained by this object.

Attention: This method is slow, since it iterates over all contained labels and creates a new list of all SFeature objects. Use SAnnotationContainer.iterator_SFeature() instead.

Specified by:

getFeatures in interface SAnnotationContainer

Returns:

a list of all features

getFeature

public SFeature getFeature(String qName)

Returns an feature having the passed qualified name, if this container contains such an feature.

Specified by:

getFeature in interface SAnnotationContainer

Parameters:

qName - the qualified of the feature. A qualified name consists of: namespace+'::'+name

Returns:

an feature having the qualified name, if such an feature exists, null otherwise

getFeature

public SFeature getFeature(String namespace,
                  String name)

Returns an feature having the passed qualified name, if this container contains such an feature.

Specified by:

getFeature in interface SAnnotationContainer

Parameters:

namespace - the namespace of the feature.

name - the name of the feature.

Returns:

an feature having the qualified name, if such an feature exists, null otherwise

iterator_SFeature

public Iterator<SFeature> iterator_SFeature()

Returns an iterator to iterate over the SFeature objects contained by this container. Using an iterator is slightly faster than SAnnotationContainer.getFeatures().

Specified by:

iterator_SFeature in interface SAnnotationContainer

Returns:

an iterator of SFeature objects

getPath

public org.eclipse.emf.common.util.URI getPath()

Returns the id of this object as a URI path If no Id exists, null is returned.

Specified by:

getPath in interface SPathElement

Returns:

uri path corresponding to the id of this object