Package ptolemy.data.ontologies

Class FiniteConcept

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DimensionlessConcept, InfiniteConceptRepresentative, ProductLatticeConcept

public class FiniteConcept
extends Concept
implements Flowable

A concept in a finite ontology. The fact that this concept is part of a finite ontology allows us to do things like draw it in a GUI, do graph traversal algorithms with a (finite) adjacency matrix, and other similar useful conveniences.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Edward A. Lee, Ben Lickly, Dai Bui, Christopher Brooks

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

Modifier and Type	Field	Description
ComponentPort	abovePort	The port linked to concepts above this one in the lattice.
ComponentPort	belowPort	The port linked to concepts below this one in the lattice.

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
FiniteConcept(CompositeEntity ontology, java.lang.String name)	Create a new concept with the specified name and the specified ontology.

Method Summary

Modifier and Type	Method	Description
java.util.Set<FiniteConcept>	getCoverSetAbove()	Return the finite concepts that cover this one.
java.util.Set<FiniteConcept>	getCoverSetBelow()	Return the finite concepts that are covered by this one.
ComponentPort	getIncomingPort()	Return the below port specified in the constructor.
ComponentPort	getOutgoingPort()	Return the above port specified in the constructor.
java.lang.String	toString()	Return the string representation of this concept, its name.

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

Field Detail

abovePort

public ComponentPort abovePort

The port linked to concepts above this one in the lattice.

belowPort

public ComponentPort belowPort

The port linked to concepts below this one in the lattice.

Constructor Detail

FiniteConcept

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

Create a new concept with the specified name and the specified 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

getCoverSetAbove

public java.util.Set<FiniteConcept> getCoverSetAbove()

Return the finite concepts that cover this one. If this concept is x, then we mean here the set of concepts y such that x ≤ y and x ≤ z < y implies that z = x.

Returns:

A set of concepts that cover this one.

getCoverSetBelow

public java.util.Set<FiniteConcept> getCoverSetBelow()

Return the finite concepts that are covered by this one. If this concept is x, then we mean here the set of concepts y such that y ≤ x and y < z ≤ x implies that z = x.

Returns:

A set of concepts that are covered by this one.

getIncomingPort

public ComponentPort getIncomingPort()

Return the below port specified in the constructor.

Specified by:

getIncomingPort in interface Flowable

Returns:

The below port specified in the constructor.

getOutgoingPort

public ComponentPort getOutgoingPort()

Return the above port specified in the constructor.

Specified by:

getOutgoingPort in interface Flowable

Returns:

The above port specified in the constructor.

toString

public java.lang.String toString()

Return the string representation of this concept, its name.

Specified by:

toString in class Concept

Returns:

The name of this concept.