org.kepler.moml

Class PortAttribute

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.AbstractSettableAttribute

ptolemy.kernel.util.StringAttribute

org.kepler.moml.PortAttribute

All Implemented Interfaces:

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

public class PortAttribute
extends StringAttribute

This implements a DependencyAttribute for moml properties.

Author:

berkley

Created:

Aug. 19, 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 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
PortAttribute() Constructor
PortAttribute(NamedObj container, java.lang.String name) Constructor
PortAttribute(Workspace workspace) Constructor

Method Summary

Modifier and Type	Method and Description
void	addValueListener(ValueListener listener) add a valueListener
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
java.lang.String	getExpression() return the value of the id
Settable.Visibility	getVisibility() NamedObjIds should be invisible to the user
void	removeValueListener(ValueListener listener) remove the indicated listener
void	setExpression(java.lang.String expression) set the value of this id
void	setVisibility(Settable.Visibility visibility) this method does not change the visibility.
java.util.Collection	validate() validate the expression.

Methods inherited from class ptolemy.kernel.util.StringAttribute

_propagateValue, exportMoML

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, setContainer, 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, addChangeListener, 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

Constructor Detail

PortAttribute

public PortAttribute()

Constructor

PortAttribute

public PortAttribute(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

PortAttribute

public PortAttribute(Workspace workspace)

Constructor

Parameters:

workspace - Description of the Parameter

Method Detail

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

setExpression

public void setExpression(java.lang.String expression)

set the value of this id

Specified by:

setExpression in interface Settable

Overrides:

setExpression in class StringAttribute

Parameters:

expression - The new expression value

See Also:

StringAttribute.getExpression()

getExpression

public java.lang.String getExpression()

return the value of the id

Specified by:

getExpression in interface Settable

Overrides:

getExpression in class StringAttribute

Returns:

The expression value

See Also:

StringAttribute.setExpression(String)

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)

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.

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