org.kepler.sms

Class SemanticProperty

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.AbstractSettableAttribute

ptolemy.kernel.util.StringAttribute

org.kepler.sms.SemanticProperty

All Implemented Interfaces:

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

public class SemanticProperty
extends StringAttribute

A data structure to hold a semantic property in a MoML file. The container of a semantic property is currently limited to KeplerIOPortSemanticLinks.

Author:

Shawn Bowers

See Also:

KeplerIOPortSemanticLink

Created:

June 20, 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
SemanticProperty() Constructor
SemanticProperty(NamedObj container, java.lang.String name) Constructor
SemanticProperty(Workspace workspace) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Description of the Method
java.lang.String	getDefaultExpression() returns the default expression which is null
java.lang.String	getPropertyId() return the value of the semantic property (the id)
Settable.Visibility	getVisibility() SemanticTypes should be invisible to the user
void	setContainer(NamedObj container) Set the container of the semantic property to the given container.
void	setPropertyId(java.lang.String expr) set the semantic property id value
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, addValueListener, clone, exportMoML, getExpression, removeValueListener, setExpression

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

SemanticProperty

public SemanticProperty()

Constructor

SemanticProperty

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

Constructor

Parameters:

container - Description of the Parameter

name - The value of the property

Throws:

IllegalActionException - Description of the Exception

NameDuplicationException - Description of the Exception

SemanticProperty

public SemanticProperty(Workspace workspace)

Constructor

Parameters:

workspace - Description of the Parameter

Method Detail

setContainer

public void setContainer(NamedObj container)
                  throws IllegalActionException,
                         NameDuplicationException

Set the container of the semantic property to the given container. This method fails, in addition to the normal ptolemy constraints for setting containers, if the given container is not a org.kepler.sms.KeplerIOPortSemanticLink object.

Overrides:

setContainer in class Attribute

Parameters:

container - The container for this virtual port.

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()

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. Currently if not given, then unknown.

See Also:

AbstractSettableAttribute.setExpression(String), Instantiable

setPropertyId

public void setPropertyId(java.lang.String expr)
                   throws IllegalActionException

set the semantic property id value

Parameters:

expression - The new semantic type concept id

Throws:

IllegalActionException

getPropertyId

public java.lang.String getPropertyId()

return the value of the semantic property (the id)

Returns:

The concept id

getVisibility

public Settable.Visibility getVisibility()

SemanticTypes 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. SemanticType 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()

validate

public java.util.Collection validate()
                              throws IllegalActionException

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.

Throws:

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

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