org.corpus_tools.salt.graph

Interface Label

Type Parameters:

V - this parameter determines the type of the value of this label.

All Superinterfaces:

Copyable<Label>, LabelableElement

All Known Subinterfaces:

Identifier, SAbstractAnnotation, SAnnotation, SCatAnnotation, SFeature, SLemmaAnnotation, SMetaAnnotation, SPOSAnnotation, SProcessingAnnotation, SSentenceAnnotation, STypeAnnotation, SWordAnnotation

All Known Implementing Classes:

IdentifierImpl, LabelImpl, SAbstractAnnotationImpl, SAnnotationImpl, SCatAnnotationImpl, SFeatureImpl, SLemmaAnnotationImpl, SMetaAnnotationImpl, SPOSAnnotationImpl, SProcessingAnnotationImpl, SSentenceAnnotationImpl, STypeAnnotationImpl, SWordAnnotationImpl

public interface Label
extends LabelableElement, Copyable<Label>

A label is an attribute-value-pair and can belong to either a Node, an Relation, a Graph, a Layer or another Label as shown in . An attribute-value-pair is a triple which consists of a namespace, a name and a value (namespace::name=value). The combination of name and namespace is used to identify a label and therefore must be unique. The namespace is an optional value, to distinguish in case of there are two labels having the same name.

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

Author:

florian

Field Summary

Fields

Modifier and Type	Field and Description
static String	NS_SEPERATOR Separator between namespace and name: qname= NAMESPACE "::" NAME.

Method Summary

Methods

Modifier and Type	Method and Description
<C extends LabelableElement> C	getContainer() Returns the container element, which contains this label.
String	getName() Returns the name of the label.
String	getNamespace() Returns the optional namespace of the label.
String	getQName() Returns the qName of this label, which is the combination of namespace and name must be unique in the containing object.
Object	getValue() Returns the value of this label.
<C extends LabelableElement> void	setContainer(C container) Sets the container element, which contains this label.
void	setName(String name) Sets the name of the label.
void	setNamespace(String namespace) Sets the optional namespace of the label.
void	setQName(String qName) Sets the qName of this label, which is the combination of namespace and name must be unique in the containing object.
void	setValue(Object value) Sets the value of this label.

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

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

Methods inherited from interface org.corpus_tools.salt.util.Copyable

copy

Field Detail

NS_SEPERATOR

static final String NS_SEPERATOR

Separator between namespace and name: qname= NAMESPACE "::" NAME.

See Also:

Constant Field Values

Method Detail

getNamespace

String getNamespace()

Returns the optional namespace of the label. The combination of namespace and name must be unique in the containing object.

Returns:

namespace

setNamespace

void setNamespace(String namespace)

Sets the optional namespace of the label. The combination of namespace and name must be unique in the containing object.

Parameters:

namespace - namespace

getName

String getName()

Returns the name of the label. The combination of namespace and name must be unique in the containing object.

Returns:

name of the label

setName

void setName(String name)

Sets the name of the label. The combination of namespace and name must be unique in the containing object. The passed name must not be empty.

Parameters:

name - name of the label

getQName

String getQName()

Returns the qName of this label, which is the combination of namespace and name must be unique in the containing object.

Returns:

NAMESPACE "::" NAME

setQName

void setQName(String qName)

Sets the qName of this label, which is the combination of namespace and name must be unique in the containing object.

Parameters:

qname - the qname is splitted into NAMESPACE "::" NAME

getValue

Object getValue()

Returns the value of this label.

Returns:

generic value of this label.

setValue

void setValue(Object value)

Sets the value of this label.

Parameters:

value - generic value of this label.

getContainer

<C extends LabelableElement> C getContainer()

Returns the container element, which contains this label. The label and the container are double chained, which means when a label is added to the container, the labels container is automatically set to it or even removed.

Returns:

container of this label

setContainer

<C extends LabelableElement> void setContainer(C container)

Sets the container element, which contains this label. The label and the container are double chained, which means when a label is added to the container, the labels container is automatically set to it or even removed. Passing a null value means removing the label from the container.

Parameters:

value - container of this label