Package ptolemy.actor.gt

Class GTIngredientsAttribute

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.AbstractSettableAttribute

ptolemy.kernel.util.StringAttribute

ptolemy.actor.gt.GTIngredientsAttribute

All Implemented Interfaces:

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

public class GTIngredientsAttribute
extends StringAttribute

An attribute that contains a list of GTIngredients and is associated with an entity in a transformation rule.

Since:

Ptolemy II 7.1

Version:

$Id$

Author:

Thomas Huining Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Yellow (tfeng)

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	Description
GTIngredientsAttribute()	Construct an attribute in the default workspace with an empty string as its name.
GTIngredientsAttribute(NamedObj container, java.lang.String name)	Construct an attribute with the given name contained by the specified container.
GTIngredientsAttribute(Workspace workspace)	Construct an attribute in the specified workspace with an empty string as a name.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone(Workspace workspace)	Clone the object into the specified workspace.
GTIngredientList	getIngredientList()	Parse the expression of this attribute if necessary and return the up-to-date ingredient list contained in this attribute.
void	setExpression(java.lang.String expression)	Set the expression of this attribute and defers parsing to the time when the ingredient list is obtained with getIngredientList() or when validate() is invoked.
java.util.Collection<?>	validate()	Parse the expression if necessary.

Methods inherited from class ptolemy.kernel.util.StringAttribute

_propagateValue, addValueListener, exportMoML, getExpression, getVisibility, removeValueListener, setVisibility

Methods inherited from class ptolemy.kernel.util.AbstractSettableAttribute

getDefaultExpression, 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

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

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Settable

getDisplayName

Constructor Detail

GTIngredientsAttribute

public GTIngredientsAttribute()

Construct an attribute in the default workspace with an empty string as its name. The object is added to the directory of the workspace. Increment the version number of the workspace.

GTIngredientsAttribute

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

Construct an attribute with the given name contained by the specified container. The container argument must not be null, or a NullPointerException will be thrown. This attribute will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. The object is added to the directory of the workspace if the container is null. Increment the version of the workspace.

Parameters:

container - The container.

name - The name of this attribute.

Throws:

IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.

NameDuplicationException - If the name coincides with an attribute already in the container.

GTIngredientsAttribute

public GTIngredientsAttribute(Workspace workspace)

Construct an attribute in the specified workspace with an empty string as a name. The object is added to the directory of the workspace. Increment the version number of the workspace.

Parameters:

workspace - The workspace that will list the attribute.

Method Detail

clone

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

Clone the object into the specified workspace. The new object is not added to the directory of that workspace (you must do this yourself if you want it there). The result is an object with no container.

Overrides:

clone in class StringAttribute

Parameters:

workspace - The workspace for the cloned object.

Returns:

The new object.

Throws:

java.lang.CloneNotSupportedException - Not thrown in this base class

See Also:

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

getIngredientList

public GTIngredientList getIngredientList()
                                   throws MalformedStringException

Parse the expression of this attribute if necessary and return the up-to-date ingredient list contained in this attribute.

Returns:

The ingredient list.

Throws:

MalformedStringException - If error occurs while parsing the expression.

setExpression

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

Set the expression of this attribute and defers parsing to the time when the ingredient list is obtained with getIngredientList() or when validate() is invoked.

Specified by:

setExpression in interface Settable

Overrides:

setExpression in class StringAttribute

Parameters:

expression - The new expression.

Throws:

IllegalActionException - If thrown by the superclass.

See Also:

StringAttribute.getExpression()

validate

public java.util.Collection<?> validate()
                                 throws IllegalActionException

Parse the expression if necessary.

Specified by:

validate in interface Settable

Overrides:

validate in class StringAttribute

Returns:

Always null.

Throws:

IllegalActionException - If error occurs while parsing the expression.