org.corpus_tools.salt.core

Interface SAnnotationContainer

All Superinterfaces:

LabelableElement, Serializable

All Known Subinterfaces:

SAbstractAnnotation, SAnnotation, SCatAnnotation, SCorpus, SCorpusDocumentRelation, SCorpusGraph, SCorpusRelation, SDocument, SDocumentGraph, SDominanceRelation, SFeature, SGraph, SLayer, SLemmaAnnotation, SMedialDS, SMedialRelation, SMetaAnnotation, SNode, SOrderRelation, SPointingRelation, SPOSAnnotation, SProcessingAnnotation, SRelation<S,T>, SSentenceAnnotation, SSequentialDS<D,P>, SSequentialRelation<S,T,P>, SSpan, SSpanningRelation, SStructure, SStructuredNode, STextOverlappingRelation<S,T>, STextualDS, STextualRelation, STimeline, STimelineRelation, STimeOverlappingRelation<S,T>, SToken, STypeAnnotation, SWordAnnotation

All Known Implementing Classes:

SAbstractAnnotationImpl, SAnnotationImpl, SCatAnnotationImpl, SCorpusDocumentRelationImpl, SCorpusGraphImpl, SCorpusImpl, SCorpusRelationImpl, SDocumentGraphImpl, SDocumentImpl, SDominanceRelationImpl, SFeatureImpl, SGraphImpl, SLayerImpl, SLemmaAnnotationImpl, SMedialDSImpl, SMedialRelationImpl, SMetaAnnotationImpl, SNodeImpl, SOrderRelationImpl, SPointingRelationImpl, SPOSAnnotationImpl, SProcessingAnnotationImpl, SRelationImpl, SSentenceAnnotationImpl, SSequentialDSImpl, SSequentialRelationImpl, SSpanImpl, SSpanningRelationImpl, SStructureImpl, STextualDSImpl, STextualRelationImpl, STimelineImpl, STimelineRelationImpl, STokenImpl, STypeAnnotationImpl, SWordAnnotationImpl

public interface SAnnotationContainer
extends LabelableElement

This interface defines a container to hold annotations (SAnnotation), meta-annotations (SMetaAnnotation), processing annotations ( SProcessingAnnotation) and features (SFeature).

Author:

florian

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 processingAnnotation) 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.
<A extends SAnnotation> Set<A>	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.
<A extends SFeature> Set<A>	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.
<A extends SMetaAnnotation> Set<A>	createMetaAnnotations(String metaAnnotationString) 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.
<A extends SProcessingAnnotation> Set<A>	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.
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.
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.
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.

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

addLabel, containsLabel, getLabel, getLabel, getLabels, getLabelsByNamespace, removeAll, removeLabel, removeLabel, sizeLabels

Method Detail

createAnnotation

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

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

Parameters:

namespace - namespace of the annotation

name - name of the annotation

value - value of the annotation

Returns:

the created annotation

createAnnotations

<A extends SAnnotation> Set<A> 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

Parameters:

annotationString - String containing the annotations

getAnnotations

<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 iterator_SAnnotation() instead.

Returns:

a list of all annotations

addAnnotation

void addAnnotation(SAnnotation annotation)

Adds the passed annotation to this container.

Parameters:

annotation - annotation to be added

getAnnotation

SAnnotation getAnnotation(String qName)

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

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

SAnnotation getAnnotation(String namespace,
                          String name)

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

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

Iterator<SAnnotation> iterator_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

createMetaAnnotation

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

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

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

<A extends SMetaAnnotation> Set<A> createMetaAnnotations(String metaAnnotationString)

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:

metaAnnotationString - String containing the meta annotations

getMetaAnnotations

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

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 iterator_SAnnotation() instead.

Returns:

a list of all meta annotations

addMetaAnnotation

void addMetaAnnotation(SMetaAnnotation metaAnnotation)

Adds the passed meta annotation to this container.

Parameters:

metaAnnotation - meta annotation to be added

getMetaAnnotation

SMetaAnnotation getMetaAnnotation(String qName)

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

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

Iterator<SMetaAnnotation> iterator_SMetaAnnotation()

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

Returns:

an iterator of SAnnotation objects

createProcessingAnnotation

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

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

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

<A extends SProcessingAnnotation> Set<A> 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

Parameters:

annotationString - String containing the processing-annotations

getProcessingAnnotations

<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 iterator_SProcessingAnnotation() instead.

Returns:

a list of all processing-annotations

addProcessingAnnotation

void addProcessingAnnotation(SProcessingAnnotation processingAnnotation)

Adds the passed processing-annotation to this container.

Parameters:

processingAnnotation - annotation to be added

getProcessingAnnotation

SProcessingAnnotation getProcessingAnnotation(String qName)

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

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

Iterator<SProcessingAnnotation> iterator_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

createFeature

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

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

Parameters:

namespace - namespace of the feature

name - name of the feature

value - value of the feature

Returns:

the created feature

createFeatures

<A extends SFeature> Set<A> 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

Parameters:

featureString - String containing the features

getFeatures

<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 iterator_SFeature() instead.

Returns:

a list of all features

addFeature

void addFeature(SFeature feature)

Adds the passed feature to this container.

Parameters:

feature - feature to be added

getFeature

SFeature getFeature(String qName)

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

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

SFeature getFeature(String namespace,
                    String name)

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

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

Iterator<SFeature> iterator_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