com.tensegrity.gui.graphdocument
Class ElementDefinitionUtil.RenameAttributable

java.lang.Object
  com.tensegrity.gui.graphdocument.ElementDefinitionUtil.RenameAttributable

All Implemented Interfaces:

Attributable, AttributableOnSet

Enclosing class:

ElementDefinitionUtil

public abstract static class ElementDefinitionUtil.RenameAttributable

extends java.lang.Object

implements AttributableOnSet

Abstract class for an AttributableOnSet that can be used to rename multiple items in the context of an AttributeEditor. Implementations of this are used during conflict resolving.

Author:

BurkhardWick

Field Summary

protected java.util.HashMap

mapRename mapRename maps all old names to the new names

Fields inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

TREE_SUBSET_POSTFIX

Constructor Summary

protected

ElementDefinitionUtil.RenameAttributable() Constructor

Method Summary

void	addAttributableOnSetListener(AttributableOnSetListener attributableOnSetListener) Adds a listener to the attributable on set instance.
boolean	areAttributableEventsEnabled() Returns a boolean that indicates whether generating of events is enabled or not.
boolean	containsName(java.lang.String name) Returns true, if the given name is part of this rename attributable
void	disableAttributableEvents() Disables events for the registered listeners.
void	enableAttributableEvents() Enables the transmission of events to registered listeners.
Attribute	getAttribute(java.lang.String name) Returns the attribute with the given name or null if there is no Attribute with the given name.
AttributeSet	getAttributes() Returns an AttributeSet consisting of all attributes of this AttributableOnSet.
AttributeType	getAttributeType(java.lang.String name) Returns the AttributeType of the attribute with the given name.
java.lang.Object	getAttributeValue(java.lang.String name) Return the value of the attribute with the given name.
java.lang.String	getNewName(java.lang.String name) Returns the new name for the given old name
void	removeAttributableOnSetListener(AttributableOnSetListener attributableOnSetListener) Removes a listener from the attributable on set instance.
void	setAttribute(Attribute attribute) Sets the value of the attribute with the same name to the value of the given attribute.
void	setAttributes(AttributeSet attributes) Searches within the AttributeSet given by attributes for attributes that have the same name as the attributes of this AttributableOnSet holds.
void	setAttributesTree(AttributeSet attributes) Performs the same operation as the setAttributes(com.tensegrity.generic.attribute.AttributeSet) method with the difference that the AttributeSet given to this method must provide the treelike structure mentioned in the documentation of the AttributableOnSet.getAttributesTree().
void	setAttributeValue(java.lang.String name, java.lang.Object value) Sets the value of the attribute with the name to the given value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

getAttributesTree

Field Detail

mapRename

protected java.util.HashMap mapRename

mapRename maps all old names to the new names

Constructor Detail

ElementDefinitionUtil.RenameAttributable

protected ElementDefinitionUtil.RenameAttributable()

Constructor

Method Detail

setAttributesTree

public void setAttributesTree(AttributeSet attributes)

Description copied from interface: AttributableOnSet

Performs the same operation as the AttributableOnSet.setAttributes(com.tensegrity.generic.attribute.AttributeSet) method with the difference that the AttributeSet given to this method must provide the treelike structure mentioned in the documentation of the AttributableOnSet.getAttributesTree().

Specified by:

setAttributesTree in interface AttributableOnSet

Parameters:

attributes - the AttributeSet containing the attributes whose values to set.

getNewName

public java.lang.String getNewName(java.lang.String name)

Returns the new name for the given old name

Parameters:

name - the old name

Returns:

the new name for the given old name

containsName

public boolean containsName(java.lang.String name)

Returns true, if the given name is part of this rename attributable

Parameters:

name - the name to check

Returns:

true, if the given name is part of this rename attributable

getAttributes

public AttributeSet getAttributes()

Description copied from interface: AttributableOnSet

Returns an AttributeSet consisting of all attributes of this AttributableOnSet.

Specified by:

getAttributes in interface AttributableOnSet

Returns:

AttributeSet an AttributeSet with all attributes.

setAttributes

public void setAttributes(AttributeSet attributes)

Description copied from interface: AttributableOnSet

Searches within the AttributeSet given by attributes for attributes that have the same name as the attributes of this AttributableOnSet holds. The value of every attribute that has the same name is used as the new value for the corresponding attribute of this AttributableOnSet. An Attribute within the given AttributeSet that is not an attribute of the object that implements the AttributableOnSet interface is not handled by nor added to the specific implementor of the AttributableOnSet interface.

Specified by:

setAttributes in interface AttributableOnSet

Parameters:

attributes - the AttributeSet consisting of the attributes whose values to set.

addAttributableOnSetListener

public void addAttributableOnSetListener(AttributableOnSetListener attributableOnSetListener)

Description copied from interface: AttributableOnSet

Adds a listener to the attributable on set instance.

Specified by:

addAttributableOnSetListener in interface AttributableOnSet

Parameters:

attributableOnSetListener - an AttributableOnSet listener listening for changes

removeAttributableOnSetListener

public void removeAttributableOnSetListener(AttributableOnSetListener attributableOnSetListener)

Description copied from interface: AttributableOnSet

Removes a listener from the attributable on set instance.

Specified by:

removeAttributableOnSetListener in interface AttributableOnSet

Parameters:

attributableOnSetListener - the AttributableOnSet to be removed from the list of listeners.

enableAttributableEvents

public void enableAttributableEvents()

Description copied from interface: AttributableOnSet

Enables the transmission of events to registered listeners.

Specified by:

enableAttributableEvents in interface AttributableOnSet

disableAttributableEvents

public void disableAttributableEvents()

Description copied from interface: AttributableOnSet

Disables events for the registered listeners.

Specified by:

disableAttributableEvents in interface AttributableOnSet

areAttributableEventsEnabled

public boolean areAttributableEventsEnabled()

Description copied from interface: AttributableOnSet

Returns a boolean that indicates whether generating of events is enabled or not.

Specified by:

areAttributableEventsEnabled in interface AttributableOnSet

Returns:

boolean flag that indicates whether event generation is active or not

getAttribute

public Attribute getAttribute(java.lang.String name)

Description copied from interface: Attributable

Returns the attribute with the given name or null if there is no Attribute with the given name.

Specified by:

getAttribute in interface Attributable

Parameters:

name - name of the attribute to return.

Returns:

the attribute with the given name or null.

setAttribute

public void setAttribute(Attribute attribute)
                  throws IllegalValueException,
                         ConstraintViolationException

Description copied from interface: Attributable

Sets the value of the attribute with the same name to the value of the given attribute.
Notice: If the specific implementor of the Attributable interface doesn't support an Attribute with the name of the Attribute given by attribute, the given attribute is not handled by nor added to the attributes of the Attributable.

Specified by:

setAttribute in interface Attributable

Parameters:

attribute - the attribute to be set.

Throws:

ConstraintViolationException - is thrown when the value of the given Attribute violates the constraint of the Attribute to set.

IllegalValueException - is thrown when the value of the given Attribute is illegal (for instance when it is null).

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String name)

Description copied from interface: Attributable

Return the value of the attribute with the given name.

Specified by:

getAttributeValue in interface Attributable

Parameters:

name - the name of the attribute to return the value from.

Returns:

the value of the attribute with the given name.

setAttributeValue

public void setAttributeValue(java.lang.String name,
                              java.lang.Object value)
                       throws IllegalValueException,
                              ConstraintViolationException

Description copied from interface: Attributable

Sets the value of the attribute with the name to the given value.
Notice: If the specific implementor of the Attributable interface doesn't support an Attribute with the name given by name, the attribute given through name and value is not handled nor created by Attributable.

Specified by:

setAttributeValue in interface Attributable

Parameters:

name - the name of the attribute.

value - the value to set the attributes value to.

Throws:

ConstraintViolationException - is thrown when the given value violates the constraint of the Attribute to set.

IllegalValueException - is thrown when the given value is illegal (for instance when it is null).

getAttributeType

public AttributeType getAttributeType(java.lang.String name)

Description copied from interface: Attributable

Returns the AttributeType of the attribute with the given name.

Specified by:

getAttributeType in interface Attributable

Parameters:

name - the name of the attribute.

Returns:

the attribute type with given name.