org.corpus_tools.salt.graph

Interface LabelableElement

All Known Subinterfaces:

Graph<N,R,L>, IdentifiableElement, Identifier, Label, Layer<N,R>, Node, Relation<S,T>, SAbstractAnnotation, SAnnotation, SAnnotationContainer, 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:

GraphImpl, IdentifiableElementImpl, IdentifierImpl, LabelableElementImpl, LabelImpl, LayerImpl, NodeImpl, RelationImpl, 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 LabelableElement

This interface defines a container to hold Label objects and makes them accessible.

When a label is added to another container, it is removed from it's former container.

Author:

florian

Method Summary

Methods

Modifier and Type	Method and Description
void	addLabel(Label label) Adds the given Label object to the list of labels.
boolean	containsLabel(String qName) Checks if this object has a Label object in its list having the given qualified name.
Label	getLabel(String qName) Returns a label having the passed qualified name.
Label	getLabel(String namespace, String name) Returns a label having the passed namespace and name, if such a label is contained by this object
Collection<Label>	getLabels() Returns all labels being contained by this object.
Set<Label>	getLabelsByNamespace(String namespace) Returns a set containing all Label objects having the given namespace.
void	removeAll() Removes all Label objects.
void	removeLabel(String qName) Removes the label having the passed qName.
void	removeLabel(String namespace, String name) Removes a Label object from the list of labels of this object.
Integer	sizeLabels() returns the number of Label objects contained by this object.

Method Detail

getLabels

Collection<Label> getLabels()

Returns all labels being contained by this object.

Returns:

set of all Label objects

addLabel

void addLabel(Label label)

Adds the given Label object to the list of labels.

Parameters:

label - the Label object to be added

getLabel

Label getLabel(String namespace,
             String name)

Returns a label having the passed namespace and name, if such a label is contained by this object

Parameters:

namespace - namespace of the Label to be searched for

name - name of the Label to be searched for

Returns:

Label object

getLabel

Label getLabel(String qName)

Returns a label having the passed qualified name. Therefore the qName is splitted into namespace and name.

Parameters:

qName - the qualified name to be splitted

Returns:

Label object

removeLabel

void removeLabel(String qName)

Removes the label having the passed qName.

Parameters:

qName - qualified name of the Label to be removed

removeLabel

void removeLabel(String namespace,
               String name)

Removes a Label object from the list of labels of this object. The Label object to be removed is identified by given namespace and name.

Parameters:

namespace - the namespace of the object to be removed

name - the name of the object to be removed

removeAll

void removeAll()

Removes all Label objects.

getLabelsByNamespace

Set<Label> getLabelsByNamespace(String namespace)

Returns a set containing all Label objects having the given namespace. If no such Label was found or the passed namespace was empty, an empty list is returned.

Parameters:

ns - the namespace of Label objects to be looked for.

Returns:

a list of Label objects if this object contains Label objects having the given namespace, null otherwise.

containsLabel

boolean containsLabel(String qName)

Checks if this object has a Label object in its list having the given qualified name.

Parameters:

fullName - the full qualified name of the label to be looked for

Returns:

true, if this object contains such a Label object, false otherwise

sizeLabels

Integer sizeLabels()

returns the number of Label objects contained by this object.

Returns:

number of Label objects