org.kepler.moml

Class NamedObjId

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.AbstractSettableAttribute

ptolemy.kernel.util.StringAttribute

org.kepler.moml.NamedObjId

All Implemented Interfaces:

java.lang.Cloneable, Changeable, ChangeListener, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable

public class NamedObjId
extends StringAttribute
implements ChangeListener

The NamedObjId is a StringAttribute to be used for identifying a NamedObj by a KeplerLSID. A NamedObj that contains this Attribute is considered to be uniquely identified by the KeplerLSID that this NamedObjId stores. This class also handles the updating of KeplerLSIDs based on the ptolemy change listener system. Static methods in org.kepler.objectmanager.ObjectManager can be used to access NamedObjId attributes contained by NamedObjs.

Author:

berkley, schultz

Created:

March 1, 2005

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Nested classes/interfaces inherited from interface ptolemy.kernel.util.Settable

Settable.Visibility

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.kernel.util.Settable

EXPERT, FULL, NONE, NOT_EDITABLE

Constructor Summary

Constructors

Constructor and Description
NamedObjId() Constructor
NamedObjId(NamedObj container, java.lang.String name) Constructor
NamedObjId(Workspace workspace) Constructor

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener listener) Add a change listener, if the container is null the listener is not added.
void	addValueListener(ValueListener listener) add a valueListener
static void	assignIdTo(NamedObj no) Generate a new KeplerLSID and assign it to this NamedObj.
static void	assignIdTo(NamedObj no, KeplerLSID lsid) Assign the given KeplerLSID to this NamedObj.
static void	assignIdTo(NamedObj no, KeplerLSID lsid, boolean updateReferrals) Assign the given KeplerLSID to this NamedObj.
void	changeExecuted(ChangeRequest change) React to a change request has been successfully executed.
void	changeFailed(ChangeRequest change, java.lang.Exception exception) React to a change request has resulted in an exception.
java.lang.Object	clone(Workspace workspace) Clone the object into the specified workspace.
boolean	equals(java.lang.Object obj) Description of the Method
java.lang.String	getDefaultExpression() returns the default expression which is null
KeplerLSID	getId()
static NamedObjId	getIdAttributeFor(NamedObj no) Return the NamedObjId associated with the given NamedObj or null if no associated NamedObjId.
static KeplerLSID	getIdFor(NamedObj no) Return the LSID for the given NamedObj.
static NamedObjIdReferralList	getIDListAttributeFor(NamedObj no) Return the KeplerIDListAttribute associated with the given NamedObj or null if no KeplerIDListAttribute exists.
NamedObjId	getParentId()
Settable.Visibility	getVisibility() NamedObjIds should be invisible to the user
static boolean	idMatches(KeplerLSID lsid, NamedObj no, boolean matchRevision) Check the given NamedObj to see if it matches the search ID.
static void	incrementLSIDOnWorkflowChange(boolean listen) Set if workflow changes should increment LSIDs.
void	removeValueListener(ValueListener listener) remove the indicated listener
void	requestNamedObjIdChange()
void	setContainer(NamedObj container) Override setContainer method to handle adding and removing the listener based on whether or not there is a container.
void	setExpression(KeplerLSID lsid) Helper method for setting the expression directly with a KeplerLSID object.
void	setExpression(java.lang.String expression) set the value of this id.
void	setParentId(NamedObjId parent)
void	setVisibility(Settable.Visibility visibility) this method does not change the visibility.
void	updateRevision() The updateRevision() method is used to retrieve the next available revision from the LSIDGenerator and updates the revision accordingly.
java.util.Collection	validate() validate the expression.

Methods inherited from class ptolemy.kernel.util.StringAttribute

_propagateValue, exportMoML, getExpression

Methods inherited from class ptolemy.kernel.util.AbstractSettableAttribute

getValueAsString

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.kernel.util.Settable

getDisplayName

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getFullName, getName, getName, setName

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

NamedObjId

public NamedObjId()

Constructor

NamedObjId

public NamedObjId(NamedObj container,
                  java.lang.String name)
           throws IllegalActionException,
                  NameDuplicationException

Constructor

Parameters:

container - Description of the Parameter

name - Description of the Parameter

Throws:

IllegalActionException - Description of the Exception

NameDuplicationException - Description of the Exception

NamedObjId

public NamedObjId(Workspace workspace)

Constructor

Parameters:

workspace - Description of the Parameter

Method Detail

getParentId

public NamedObjId getParentId()

setParentId

public void setParentId(NamedObjId parent)

assignIdTo

public static void assignIdTo(NamedObj no)
                       throws java.lang.Exception

Generate a new KeplerLSID and assign it to this NamedObj.

Parameters:

no - the NamedObj.

Throws:

java.lang.Exception

assignIdTo

public static void assignIdTo(NamedObj no,
                              KeplerLSID lsid)
                       throws java.lang.Exception

Assign the given KeplerLSID to this NamedObj. If the NamedObj already has this LSID assigned to it do nothing. If the NamedObj has a different LSID, assign the new LSID to the NamedObj and move the old LSID into the referral list.

Parameters:

no -

lsid -

Throws:

java.lang.Exception

assignIdTo

public static void assignIdTo(NamedObj no,
                              KeplerLSID lsid,
                              boolean updateReferrals)
                       throws java.lang.Exception

Assign the given KeplerLSID to this NamedObj. If the NamedObj already has this LSID assigned to it do nothing. If the NamedObj has a different LSID, assign the new LSID to the NamedObj and optionally move the old LSID into the referral list.

Parameters:

no - the NamedObj

lsid - the new LSID to assign.

updateReferrals - if true, update the referrals list.

Throws:

java.lang.Exception

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the object into the specified workspace.

Overrides:

clone in class StringAttribute

Parameters:

workspace - The workspace for the new object.

Returns:

A new NamedObj.

Throws:

java.lang.CloneNotSupportedException - If any of the attributes cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

getDefaultExpression

public java.lang.String getDefaultExpression()

returns the default expression which is null

Specified by:

getDefaultExpression in interface Settable

Overrides:

getDefaultExpression in class AbstractSettableAttribute

Returns:

The defaultExpression value

See Also:

AbstractSettableAttribute.setExpression(String), Instantiable

getId

public KeplerLSID getId()

getIdFor

public static KeplerLSID getIdFor(NamedObj no)

Return the LSID for the given NamedObj. If an LSID has not already been assigned then assign the NamedObj a new LSID.

Parameters:

no -

getIDListAttributeFor

public static NamedObjIdReferralList getIDListAttributeFor(NamedObj no)
                                                    throws IllegalActionException,
                                                           NameDuplicationException

Return the KeplerIDListAttribute associated with the given NamedObj or null if no KeplerIDListAttribute exists.

Parameters:

no - * @throws NameDuplicationException

Throws:

IllegalActionException

NameDuplicationException

getIdAttributeFor

public static NamedObjId getIdAttributeFor(NamedObj no)

Return the NamedObjId associated with the given NamedObj or null if no associated NamedObjId.

Parameters:

no -

setExpression

public void setExpression(java.lang.String expression)
                   throws IllegalActionException

set the value of this id. If you want a NamedObjIdChangeRequest sent out in response to this setExpression you must call requestNamedObjIdChange(). updateRevision does this for you.

Specified by:

setExpression in interface Settable

Overrides:

setExpression in class StringAttribute

Parameters:

expression - The new expression value

Throws:

IllegalActionException - If the change is not acceptable to the container.

See Also:

requestNamedObjIdChange()

setExpression

public void setExpression(KeplerLSID lsid)
                   throws IllegalActionException

Helper method for setting the expression directly with a KeplerLSID object.

Parameters:

lsid -

Throws:

IllegalActionException

addValueListener

public void addValueListener(ValueListener listener)

add a valueListener

Specified by:

addValueListener in interface Settable

Overrides:

addValueListener in class StringAttribute

Parameters:

listener - The feature to be added to the ValueListener attribute

See Also:

StringAttribute.removeValueListener(ValueListener)

getVisibility

public Settable.Visibility getVisibility()

NamedObjIds should be invisible to the user

Specified by:

getVisibility in interface Settable

Overrides:

getVisibility in class StringAttribute

Returns:

The visibility value

See Also:

StringAttribute.setVisibility(Settable.Visibility)

setVisibility

public void setVisibility(Settable.Visibility visibility)

this method does not change the visibility. NamedObjId should only be invisible

Specified by:

setVisibility in interface Settable

Overrides:

setVisibility in class StringAttribute

Parameters:

visibility - The new visibility value

See Also:

StringAttribute.getVisibility()

removeValueListener

public void removeValueListener(ValueListener listener)

remove the indicated listener

Specified by:

removeValueListener in interface Settable

Overrides:

removeValueListener in class StringAttribute

Parameters:

listener - Description of the Parameter

See Also:

StringAttribute.addValueListener(ValueListener)

idMatches

public static boolean idMatches(KeplerLSID lsid,
                                NamedObj no,
                                boolean matchRevision)

Check the given NamedObj to see if it matches the search ID.

Parameters:

no -

Returns:

true if the given NamedObj has an attached NamedObjId that matches the KeplerLSID that we are searching for

Throws:

java.lang.Exception

changeExecuted

public void changeExecuted(ChangeRequest change)

Description copied from interface: ChangeListener

React to a change request has been successfully executed. This method is called after a change request has been executed successfully.

Specified by:

changeExecuted in interface ChangeListener

Parameters:

change - The change that has been executed, or null if the change was not done via a ChangeRequest.

updateRevision

public void updateRevision()
                    throws java.lang.Exception

The updateRevision() method is used to retrieve the next available revision from the LSIDGenerator and updates the revision accordingly.

Throws:

java.lang.Exception

requestNamedObjIdChange

public void requestNamedObjIdChange()

changeFailed

public void changeFailed(ChangeRequest change,
                         java.lang.Exception exception)

Description copied from interface: ChangeListener

React to a change request has resulted in an exception. This method is called after a change request was executed, but during the execution an exception was thrown.

Specified by:

changeFailed in interface ChangeListener

Parameters:

change - The change that was attempted or null if the change was not done via a ChangeRequest.

exception - The exception that resulted.

validate

public java.util.Collection validate()

validate the expression.

Specified by:

validate in interface Settable

Overrides:

validate in class StringAttribute

Returns:

Null, indicating that no other instances of Settable are validated.

setContainer

public void setContainer(NamedObj container)
                  throws IllegalActionException,
                         NameDuplicationException

Override setContainer method to handle adding and removing the listener based on whether or not there is a container.

Overrides:

setContainer in class Attribute

Parameters:

container - The container to attach this attribute to..

Throws:

IllegalActionException - If this attribute is not of the expected class for the container, or it has no name, or the attribute and container are not in the same workspace, or the proposed container would result in recursive containment.

NameDuplicationException - If the container already has an attribute with the name of this attribute.

See Also:

Attribute.getContainer()

addChangeListener

public void addChangeListener(ChangeListener listener)

Add a change listener, if the container is null the listener is not added.

Specified by:

addChangeListener in interface Changeable

Overrides:

addChangeListener in class NamedObj

Parameters:

listener - The listener to add.

See Also:

NamedObj.removeChangeListener(ChangeListener), NamedObj.requestChange(ChangeRequest), Changeable

equals

public boolean equals(java.lang.Object obj)

Description of the Method

Overrides:

equals in class java.lang.Object

Parameters:

obj - Description of the Parameter

Returns:

Description of the Return Value

incrementLSIDOnWorkflowChange

public static void incrementLSIDOnWorkflowChange(boolean listen)

Set if workflow changes should increment LSIDs. NOTE: this setting only affects NamedObjId objects created after this method is called; it does not change existing NamedObjIds.