org.corpus_tools.salt.graph.impl

Class LabelableElementImpl

java.lang.Object

org.corpus_tools.salt.graph.impl.LabelableElementImpl

All Implemented Interfaces:

Serializable, LabelableElement

Direct Known Subclasses:

IdentifiableElementImpl, LabelImpl

public abstract class LabelableElementImpl
extends Object
implements LabelableElement, Serializable

This class is an abstract container containing a set of Label objects.

Author:

florian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected LabelableElement	delegate A delegate object of the same type.
static int	EXPECTED_NUMBER_OF_LABELS Determines the expected number of labels.

Constructor Summary

Constructors

Constructor and Description
LabelableElementImpl()
LabelableElementImpl(LabelableElement delegatee) Initializes a new object and sets an internal delegate.

Method Summary

Modifier and Type	Method and Description
void	addLabel(Label label) Adds the given Label object to the list of labels.
void	basicAddLabel(Label label) This is an internally used method.
void	basicRemoveLabel(String qName) This is an internally used method.
boolean	containsLabel(String qName) Checks if this object has a Label object in its list having the given qualified name.
protected LabelableElement	getDelegate() Returns the delegate object.
Label	getLabel(String qName) Returns a label having the passed qualified name.
Label	getLabel(String namespace, String name)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXPECTED_NUMBER_OF_LABELS

public static final int EXPECTED_NUMBER_OF_LABELS

Determines the expected number of labels.

See Also:

Constant Field Values

delegate

protected LabelableElement delegate

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

Constructor Detail

LabelableElementImpl

public LabelableElementImpl()

LabelableElementImpl

public LabelableElementImpl(LabelableElement delegatee)

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

Parameters:

delegatee - object to pass method invocations to.

Method Detail

getDelegate

protected LabelableElement getDelegate()

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

Returns:

the delegate object

getLabels

public Collection<Label> getLabels()

Returns all labels being contained by this object.

Specified by:

getLabels in interface LabelableElement

Returns:

set of all Label objects

getLabel

public Label getLabel(String qName)

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

Specified by:

getLabel in interface LabelableElement

Parameters:

qName - the qualified name to be splitted

Returns:

Label object

getLabel

public Label getLabel(String namespace,
                      String name)

Specified by:

getLabel in interface LabelableElement

Parameters:

namespace - namespace of the Label to be searched for

name - name of the Label to be searched for

Returns:

Label object

getLabelsByNamespace

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

Specified by:

getLabelsByNamespace in interface LabelableElement

Returns:

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

addLabel

public void addLabel(Label label)

Adds the given Label object to the list of labels.

Specified by:

addLabel in interface LabelableElement

Parameters:

label - the Label object to be added

basicAddLabel

public void basicAddLabel(Label label)

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 addLabel(Label) and basicAddLabel(Label). The invocation of methods is implement as follows:

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

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

Parameters:

label - label to be inserted

removeLabel

public void removeLabel(String qName)

Removes the label having the passed qName.

Specified by:

removeLabel in interface LabelableElement

Parameters:

qName - qualified name of the Label to be removed

basicRemoveLabel

public void basicRemoveLabel(String qName)

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 removeLabel(String) and basicRemoveLabel(String). The invocation of methods is implement as follows:

 removeLabel(String)                      Label.setContainer(LabelableElement)
         ||             \ /                   ||
         ||              X                    ||
         \/             / \                   \/
 #basicRemoveLabel(STring)            LabelImpl.basicSetLabelableElement(LabelableElement)
 

That means method removeLabel(String) calls basicRemoveLabel(String) and Label#basicSetGraph(Graph). And method Label.setContainer(LabelableElement) calls basicRemoveLabel(String) and LabelImpl.basicSetLabelableElement(LabelableElement).

Parameters:

label - label to be inserted

removeLabel

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

Specified by:

removeLabel in interface LabelableElement

Parameters:

namespace - the namespace of the object to be removed

name - the name of the object to be removed

removeAll

public void removeAll()

Removes all Label objects.

Specified by:

removeAll in interface LabelableElement

containsLabel

public boolean containsLabel(String qName)

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

Specified by:

containsLabel in interface LabelableElement

Returns:

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

sizeLabels

public Integer sizeLabels()

returns the number of Label objects contained by this object.

Specified by:

sizeLabels in interface LabelableElement

Returns:

number of Label objects