Package ptolemy.data.ontologies

Class FlatTokenRepresentativeConcept

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity

ptolemy.data.ontologies.Concept

ptolemy.data.ontologies.FiniteConcept

ptolemy.data.ontologies.InfiniteConceptRepresentative

ptolemy.data.ontologies.FlatTokenRepresentativeConcept

All Implemented Interfaces:

java.lang.Cloneable, InequalityTerm, Changeable, Debuggable, DebugListener, Derivable, Flowable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

DimensionRepresentativeConcept, FlatScalarTokenRepresentativeConcept

public class FlatTokenRepresentativeConcept
extends InfiniteConceptRepresentative

A finite concept in an ontology that represents a flat set of infinite concepts that map to a set of arbitrary Ptolemy tokens.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Charles Shelton

See Also:

FlatTokenInfiniteConcept

Pt.AcceptedRating:

Red (blickly)

Pt.ProposedRating:

Red (blickly)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.data.ontologies.FiniteConcept

abovePort, belowPort

Fields inherited from class ptolemy.data.ontologies.Concept

isAcceptable

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

Constructor Summary

Constructors

Constructor	Description
FlatTokenRepresentativeConcept(CompositeEntity ontology, java.lang.String name)	Create a new FlatTokenRepresentativeConcept with the specified name and ontology.

Method Summary

Modifier and Type	Method	Description
protected FlatTokenInfiniteConcept	_createInfiniteConceptInstance(java.lang.String infiniteConceptString)	Create a new FlatTokenInfiniteConcept for the given concept string.
protected FlatTokenInfiniteConcept	_instantiateFlatTokenInfiniteConcept(Token tokenValue)	Return a new FlatTokenInfiniteConcept for this representative with the given token value.
boolean	containsThisInfiniteConceptString(java.lang.String infiniteConceptString)	Return true if the string can represent a FlatTokenInfiniteConcept for this representative, false otherwise.
FlatTokenInfiniteConcept	getFlatTokenInfiniteConceptByToken(Token tokenValue)	Return the FlatTokenInfiniteConcept with the given token that is contained by this representative.

Methods inherited from class ptolemy.data.ontologies.InfiniteConceptRepresentative

_clearInstantiatedInfiniteConcepts, clone, getInfiniteConceptByString, getInstantiatedInfiniteConcepts

Methods inherited from class ptolemy.data.ontologies.FiniteConcept

getCoverSetAbove, getCoverSetBelow, getIncomingPort, getOutgoingPort, toString

Methods inherited from class ptolemy.data.ontologies.Concept

getAssociatedObject, getColor, getOntology, getValue, getVariables, initialize, isAboveOrEqualTo, isSettable, isValueAcceptable, setValue

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, newPort, propagateExistence, setContainer, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, connectionsChanged, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, 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.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getDisplayName, getFullName, getName, getName

Constructor Detail

FlatTokenRepresentativeConcept

public FlatTokenRepresentativeConcept(CompositeEntity ontology,
                                      java.lang.String name)
                               throws NameDuplicationException,
                                      IllegalActionException

Create a new FlatTokenRepresentativeConcept with the specified name and ontology.

Parameters:

ontology - The specified ontology where this concept resides.

name - The specified name for the concept.

Throws:

NameDuplicationException - If the ontology already contains a concept with the specified name.

IllegalActionException - If the base class throws it.

Method Detail

containsThisInfiniteConceptString

public boolean containsThisInfiniteConceptString(java.lang.String infiniteConceptString)

Return true if the string can represent a FlatTokenInfiniteConcept for this representative, false otherwise.

Specified by:

containsThisInfiniteConceptString in class InfiniteConceptRepresentative

Parameters:

infiniteConceptString - The string that represents the infinite concept.

Returns:

true if the string can represent an infinite concept for this representative, false otherwise.

getFlatTokenInfiniteConceptByToken

public FlatTokenInfiniteConcept getFlatTokenInfiniteConceptByToken(Token tokenValue)
                                                            throws IllegalActionException

Return the FlatTokenInfiniteConcept with the given token that is contained by this representative. If the FlatTokenInfiniteConcept has already been instantiated, return it. If not, instantiate a new FlatTokenInfiniteConcept with the given token and return it.

Parameters:

tokenValue - The token value that is used to get a FlatTokenInfiniteConcept.

Returns:

The FlatTokenInfiniteConcept that has the given token and this representative.

Throws:

IllegalActionException - Thrown if there is an error finding or creating the FlatTokenInfiniteConcept from the given token.

_createInfiniteConceptInstance

protected FlatTokenInfiniteConcept _createInfiniteConceptInstance(java.lang.String infiniteConceptString)
                                                           throws IllegalActionException

Create a new FlatTokenInfiniteConcept for the given concept string.

Specified by:

_createInfiniteConceptInstance in class InfiniteConceptRepresentative

Parameters:

infiniteConceptString - The specified concept string that represents the FlatTokenInfiniteConcept to be created.

Returns:

The newly created FlatTokenInfiniteConcept object.

Throws:

IllegalActionException - Thrown if a valid FlatTokenInfiniteConcept cannot be created.

_instantiateFlatTokenInfiniteConcept

protected FlatTokenInfiniteConcept _instantiateFlatTokenInfiniteConcept(Token tokenValue)
                                                                 throws IllegalActionException

Return a new FlatTokenInfiniteConcept for this representative with the given token value.

Parameters:

tokenValue - The token value for the FlatTokenInfiniteConcept to be instantiated.

Returns:

A new FlatTokenInfiniteConcept

Throws:

IllegalActionException - Thrown if the FlatTokenInfiniteConcept cannot be created.