org.corpus_tools.salt.core.impl

Class SRelationImpl<S extends SNode,T extends SNode>

java.lang.Object

org.corpus_tools.salt.graph.impl.LabelableElementImpl

org.corpus_tools.salt.graph.impl.IdentifiableElementImpl

org.corpus_tools.salt.graph.impl.RelationImpl<S,T>

org.corpus_tools.salt.core.impl.SRelationImpl<S,T>

All Implemented Interfaces:

Serializable, SAnnotationContainer, SNamedElement, SPathElement, SRelation<S,T>, STypedElement, IdentifiableElement, LabelableElement, Relation<S,T>

Direct Known Subclasses:

SCorpusDocumentRelationImpl, SCorpusRelationImpl, SDominanceRelationImpl, SOrderRelationImpl, SPointingRelationImpl, SSequentialRelationImpl, SSpanningRelationImpl

public class SRelationImpl<S extends SNode,T extends SNode>
extends RelationImpl<S,T>
implements SRelation<S,T>

See Also:

Serialized Form

Field Summary

Fields

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

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

graph, source

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

delegate, EXPECTED_NUMBER_OF_LABELS

Constructor Summary

Constructors

Constructor and Description
SRelationImpl() Initializes an object of type SRelationImpl.
SRelationImpl(Relation delegate) Initializes an object of type SRelationImpl.

Method Summary

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	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.
Set<SLayer>	getLayers() Returns all layers containing this relation.
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.
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.
String	getType() Returns the type of this element
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	setType(String type) Sets the type of this element.

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

addLayer, basicSetGraph_WithoutRemoving, basicSetGraph, getDelegate, getGraph, getSource, getTarget, removeLayer, setGraph, setSource, setTarget

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

addLayer, getDelegate, getGraph, getSource, getTarget, removeLayer, setGraph, setSource, setTarget

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

type

protected SFeature type

The feature object containing the type of the node

Constructor Detail

SRelationImpl

public SRelationImpl()

Initializes an object of type SRelationImpl.

SRelationImpl

public SRelationImpl(Relation delegate)

Initializes an object of type SRelationImpl. If LabelableElementImpl.delegate is not null, all functions of this method are delegated to the delegate object. Setting LabelableElementImpl.delegate makes this object to a container.

Parameters:

a - delegate object of the same type.

Method Detail

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

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.

getType

public String getType()

Returns the type of this element

Specified by:

getType in interface STypedElement

Returns:

setType

public void setType(String type)

Sets the type of this element.

Specified by:

setType in interface STypedElement

Parameters:

type - type of this element

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

getLayers

public Set<SLayer> getLayers()

Description copied from class: RelationImpl

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.

Specified by:

getLayers in interface SRelation<S extends SNode,T extends SNode>

Specified by:

getLayers in interface Relation<S extends SNode,T extends SNode>

Overrides:

getLayers in class RelationImpl<S extends SNode,T extends SNode>

Returns:

a set of layers containing this relation