org.corpus_tools.salt.graph.impl

Class LabelImpl

java.lang.Object

org.corpus_tools.salt.graph.impl.LabelableElementImpl

org.corpus_tools.salt.graph.impl.LabelImpl

All Implemented Interfaces:

Serializable, Label, LabelableElement, Copyable<Label>

Direct Known Subclasses:

IdentifierImpl, SAbstractAnnotationImpl

public class LabelImpl
extends LabelableElementImpl
implements Label, Copyable<Label>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected LabelableElement	container The container of this object.
protected String	name
protected String	namespace
protected Object	value The generic value field.

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

delegate, EXPECTED_NUMBER_OF_LABELS

Fields inherited from interface org.corpus_tools.salt.graph.Label

NS_SEPERATOR

Constructor Summary

Constructors

Constructor and Description
LabelImpl()
LabelImpl(Label delegatee) Initializes a new object and sets an internal delegatee.

Method Summary

Modifier and Type	Method and Description
void	basicSetLabelableElement(LabelableElement container) This is an internally used method.
Label	copy(Label other) This method the namespace, the name and the value from this object to the passed one and returns the passed one.
LabelableElement	getContainer() Returns the container element, which contains this label.
protected Label	getDelegate() Returns the delegate object.
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.
void	setContainer(LabelableElement 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 newQName) 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.
String	toString()

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

addLabel, basicAddLabel, basicRemoveLabel, containsLabel, getLabel, getLabel, getLabels, getLabelsByNamespace, removeAll, removeLabel, 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.LabelableElement

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

Field Detail

namespace

protected String namespace

name

protected String name

value

protected Object value

The generic value field.

container

protected LabelableElement container

The container of this object.

Constructor Detail

LabelImpl

public LabelImpl()

LabelImpl

public LabelImpl(Label delegatee)

Initializes a new object and sets an internal delegatee. This means, all method invocations are passed to the delegatee.

Parameters:

delegatee - object to pass method invocations to.

Method Detail

getDelegate

protected Label getDelegate()

Returns the delegate object. 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.

Overrides:

getDelegate in class LabelableElementImpl

Returns:

the delegate object

getNamespace

public String getNamespace()

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

Specified by:

getNamespace in interface Label

Returns:

namespace

setNamespace

public void setNamespace(String namespace)

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

Specified by:

setNamespace in interface Label

Parameters:

namespace - namespace

getName

public String getName()

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

Specified by:

getName in interface Label

Returns:

name of the label

setName

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

Specified by:

setName in interface Label

Parameters:

name - name of the label

getQName

public String getQName()

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

Specified by:

getQName in interface Label

Returns:

NAMESPACE "::" NAME

setQName

public void setQName(String newQName)

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

Specified by:

setQName in interface Label

getValue

public Object getValue()

Returns the value of this label.

Specified by:

getValue in interface Label

Returns:

generic value of this label.

setValue

public void setValue(Object value)

Sets the value of this label.

Specified by:

setValue in interface Label

Parameters:

value - generic value of this label.

setContainer

public void setContainer(LabelableElement 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.

Specified by:

setContainer in interface Label

getContainer

public LabelableElement 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.

Specified by:

getContainer in interface Label

Returns:

container of this label

basicSetLabelableElement

public void basicSetLabelableElement(LabelableElement container)

This is an internally used method. To implement a double chaining of LabelableElement and label object. When a label is inserted into this container and to avoid an endless invocation the insertion of a label is split into the two methods LabelableElementImpl.addLabel(Label) and LabelableElementImpl.basicAddLabel(Label). The invocation of methods is implement as follows:

 LabelableElementImpl.addLabel(Label)                      Label.setContainer(LabelableElement)
         ||             \ /                   ||
         ||              X                    ||
         \/             / \                   \/
 LabelableElementImpl.basicAddLabel(Label)            basicSetLabelableElement(LabelableElement)
 

That means method LabelableElementImpl.addLabel(Label) calls LabelableElementImpl.basicAddLabel(Label) and Label#basicSetGraph(Graph). And method Label.setContainer(LabelableElement) calls LabelableElementImpl.basicAddLabel(Label) and basicSetLabelableElement(LabelableElement).

Parameters:

label - label to be inserted

copy

public Label copy(Label other)

This method the namespace, the name and the value from this object to the passed one and returns the passed one.

Specified by:

copy in interface Copyable<Label>

Parameters:

clone - the clone to which all properties of this shall be copied to

Returns:

other enhanced for namespace, name and value

toString

public String toString()

Overrides:

toString in class Object