Salt  3.4.2
A powerful, tagset-independent and theory-neutral meta model and API for storing, manipulating, and representing nearly all types of linguistic data .
org.corpus_tools.salt.common.impl.SDominanceRelationImpl Class Reference

Inherits org.corpus_tools.salt.core.impl.SRelationImpl< S extends SNode, T extends SNode >, and org.corpus_tools.salt.common.SDominanceRelation.

Public Member Functions

 SDominanceRelationImpl ()
 Initializes an object of type SDominanceRelationImpl.
 
 SDominanceRelationImpl (Relation delegate)
 Initializes an object of type SDominanceRelationImpl. More...
 
SDocumentGraph getGraph ()
 Returns the document structure object which contains this element.
Returns
document structure

 
void setGraph (@SuppressWarnings("rawtypes") Graph graph)
 
- Public Member Functions inherited from org.corpus_tools.salt.core.impl.SRelationImpl< S extends SNode, T extends SNode >
 SRelationImpl ()
 Initializes an object of type SRelationImpl.
 
 SRelationImpl (Relation delegate)
 Initializes an object of type SRelationImpl. More...
 
SAnnotation createAnnotation (String namespace, String name, Object value)
 Creates and returns an annotation having the passed namespace, name and value.
Parameters
namespacenamespace of the annotation
namename of the annotation
valuevalue of the annotation
Returns
the created annotation

 
Set< SAnnotationcreateAnnotations (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
Parameters
annotationStringString containing the annotations

 
void addAnnotation (SAnnotation annotation)
 Adds the passed annotation to this container.
Parameters
annotationannotation to be added

 
SAnnotation getAnnotation (String qName)
 Returns an annotation having the passed qualified name, if this container contains such an annotation.
Parameters
qNamethe 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

 
SAnnotation getAnnotation (String namespace, String name)
 Returns an annotation having the passed qualified name, if this container contains such an annotation.
Parameters
namespacethe namespace of the annotation.
namethe name of the annotation.
Returns
an annotation having the qualified name, if such an annotation exists, null otherwise

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

 
void addMetaAnnotation (SMetaAnnotation metaAnnotation)
 Adds the passed meta annotation to this container.
Parameters
metaAnnotationmeta annotation to be added

 
SMetaAnnotation createMetaAnnotation (String namespace, String name, Object value)
 Creates and returns a meta annotation having the passed namespace, name and value.
Parameters
namespacenamespace of the meta annotation
namename of the meta annotation
valuevalue of the meta annotation
Returns
the created meta annotation

 
Set< SMetaAnnotationcreateMetaAnnotations (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
Parameters
metaAnnotationStringString containing the meta annotations

 
SMetaAnnotation getMetaAnnotation (String qName)
 Returns a meta annotation having the passed qualified name, if this container contains such a meta annotation. More...
 
Iterator< SMetaAnnotationiterator_SMetaAnnotation ()
 Returns an iterator to iterate over the SMetaAnnotation objects contained by this container. More...
 
SProcessingAnnotation createProcessingAnnotation (String namespace, String name, Object value)
 Creates and returns a processing-annotation having the passed namespace, name and value.
Parameters
namespacenamespace of the processing-annotation
namename of the processing-annotation
valuevalue of the processing-annotation
Returns
the created processing-annotation

 
Set< SProcessingAnnotationcreateProcessingAnnotations (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
Parameters
annotationStringString containing the processing-annotations

 
void addProcessingAnnotation (SProcessingAnnotation annotation)
 Adds the passed processing-annotation to this container.
Parameters
processingAnnotationannotation to be added

 
SProcessingAnnotation getProcessingAnnotation (String qName)
 Returns a processing-annotation having the passed qualified name, if this container contains such a processing-annotation.
Parameters
qNamethe 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< SProcessingAnnotationiterator_SProcessingAnnotation ()
 Returns an iterator to iterate over the SProcessingAnnotation objects contained by this container.Using an iterator is slightly faster than getProcessingAnnotations().
Returns
an iterator of SAnnotation objects

 
SFeature createFeature (String namespace, String name, Object value)
 Creates and returns an feature having the passed namespace, name and value.
Parameters
namespacenamespace of the feature
namename of the feature
valuevalue of the feature
Returns
the created feature

 
Set< SFeaturecreateFeatures (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
Parameters
featureStringString containing the features

 
void addFeature (SFeature feature)
 Adds the passed feature to this container.
Parameters
featurefeature to be added

 
SFeature getFeature (String qName)
 Returns an feature having the passed qualified name, if this container contains such an feature.
Parameters
qNamethe 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

 
SFeature getFeature (String namespace, String name)
 Returns an feature having the passed qualified name, if this container contains such an feature.
Parameters
namespacethe namespace of the feature.
namethe name of the feature.
Returns
an feature having the qualified name, if such an feature exists, null otherwise

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

 
void removeLabel (String qName)
 {@inheritDoc LabelableElement::removeLabel(String)} In case the passed qualified name is equal to SaltUtil#LABEL_ID_QNAME the internal reference to identifier is set to null. In case the passed qualified name is equal to SaltUtil#LABEL_ID_QNAME the internal reference to identifier is set to null.
 
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.
Returns
name of the element.

 
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.
Parameters
namename of the element.

 
String getType ()
 Returns the type of this element.
Returns

 
void setType (String type)
 Sets the type of this element.
Parameters
nametype of this element

 
URI getPath ()
 Returns the id of this object as a URI path If no Id exists, null is returned.
Returns
uri path corresponding to the id of this object

 
Set< SLayergetLayers ()
 Returns all layers containing this relation. More...
 
- Public Member Functions inherited from org.corpus_tools.salt.graph.impl.RelationImpl< S extends Node, T extends Node >
 RelationImpl ()
 Initializes an object of type Relation.
 
 RelationImpl (Relation< S, T > delegate)
 Initializes an object of type Relation. More...
 
Relation< S, T > getDelegate ()
 {@inheritDoc Relation::getDelegate()}
 
getSource ()
 {@inheritDoc Relation::getSource()}
 
void setSource (S source)
 {@inheritDoc Relation::setSource(Node)} Notifies the graph, about the change of the source.
 
getTarget ()
 {@inheritDoc Relation::getTarget()}
 
void setTarget (T target)
 {@inheritDoc Relation::setTarget(Node)} Notifies the graph, about the change of the target.
 
void setGraph (Graph graph)
 {@inheritDoc Relation::setGraph(Graph)}
 
void basicSetGraph_WithoutRemoving (Graph graph)
 Same as basicSetGraph(Graph) but does not remove this relation from old graph, if it was not equal to the passed graph. More...
 
void addLayer (Layer layer)
 Adds this relation to the passed layer.If this relation is not already contained in the layer's graph, it will be added to the graph.
Parameters
layerto which this node should be added

Since the method getLayers() retrieves all layers by accessing the layers in graph, this class does not contain an own collection of layers.
 
void removeLayer (Layer layer)
 Removes this relation from the passed layer.
Parameters
layerfrom which this node should be removed

Since the method getLayers() retrieves all layers by accessing the layers in graph, this class does not contain an own collection of layers.
 
- Public Member Functions inherited from org.corpus_tools.salt.graph.impl.IdentifiableElementImpl
 IdentifiableElementImpl (IdentifiableElement delegate)
 
Identifier getIdentifier ()
 {@inheritDoc IdentifiableElement::getIdentifier()}
 
void setIdentifier (Identifier identifier)
 {@inheritDoc IdentifiableElement::setIdentifier(Identifier)}
 
String getId ()
 {@inheritDoc IdentifiableElement::getId()}
 
void setId (String id)
 {@inheritDoc IdentifiableElement::setId(String)}
 
String toString ()
 
- Public Member Functions inherited from org.corpus_tools.salt.graph.impl.LabelableElementImpl
 LabelableElementImpl (LabelableElement delegatee)
 Initializes a new object and sets an internal delegate. More...
 
Collection< LabelgetLabels ()
 {@inheritDoc LabelableElement::getLabels()}
 
Label getLabel (String qName)
 {@inheritDoc LabelableElement::getLabel(String)}
 
Label getLabel (String namespace, String name)
 {@inheritedDoc LabelableElement::getLabel(String, String)}
 
Set< LabelgetLabelsByNamespace (String namespace)
 {@inheritDoc LabelableElement::getLabelsByNamespace(String)}
 
void addLabel (Label label)
 Adds the given Label object to the list of labels.
Parameters
labelthe Label object to be added

 
void basicAddLabel (Label label)
 This is an internally used method. More...
 
void basicRemoveLabel (String qName)
 This is an internally used method. More...
 
void removeLabel (String namespace, String name)
 {@inheritDoc LabelableElement::removeLabel(String, String))}
 
void removeAll ()
 {@inheritDoc LabelableElement::removeAll()}
 
boolean containsLabel (String qName)
 {@inheritDoc LabelableElement::containsLabel(String)}
 
Integer sizeLabels ()
 {@inheritDoc LabelableElement::sizeLabels()}
 

Additional Inherited Members

- Static Public Attributes inherited from org.corpus_tools.salt.graph.impl.LabelableElementImpl
static final int EXPECTED_NUMBER_OF_LABELS = 5
 Determines the expected number of labels.
 
- Protected Member Functions inherited from org.corpus_tools.salt.graph.impl.RelationImpl< S extends Node, T extends Node >
void basicSetGraph (Graph graph)
 This is an internally used method. More...
 
- Protected Attributes inherited from org.corpus_tools.salt.core.impl.SRelationImpl< S extends SNode, T extends SNode >
SFeature name = null
 The feature object containing the name of the node.
 
SFeature type = null
 The feature object containing the type of the node.
 
- Protected Attributes inherited from org.corpus_tools.salt.graph.impl.RelationImpl< S extends Node, T extends Node >
source = null
 source node of this relation.
 
Graph graph = null
 container graph
 
- Protected Attributes inherited from org.corpus_tools.salt.graph.impl.LabelableElementImpl
LabelableElement delegate = null
 A delegate object of the same type. More...
 

Constructor & Destructor Documentation

◆ SDominanceRelationImpl()

org.corpus_tools.salt.common.impl.SDominanceRelationImpl.SDominanceRelationImpl ( Relation  delegate)

Initializes an object of type SDominanceRelationImpl.

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

Parameters
adelegate object of the same type.