ptolemy.data.ontologies.lattice

Class ProductLatticeConcept

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.lattice.ProductLatticeConcept

All Implemented Interfaces:

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

public class ProductLatticeConcept
extends FiniteConcept

A concept in a product lattice-based ontology. Represents a concept that is composed of a tuple of other concepts derived from other ontologies.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Charles Shelton

See Also:

ProductLatticeOntology

Pt.AcceptedRating:

Red (cshelton)

Pt.ProposedRating:

Red (cshelton)

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 and Description
ProductLatticeConcept(CompositeEntity ontology, java.lang.String name) Create a new product lattice concept with the specified name and the specified product lattice ontology.
ProductLatticeConcept(ProductLatticeOntology ontology, java.lang.String name, java.util.List<Concept> conceptTuple) Create a new product lattice concept with the specified name and the specified product lattice ontology.

Method Summary

Modifier and Type	Method and Description
ColorAttribute	getColor() Return the color attribute associated with this ProductLatticeConcept.
Concept	getComponentConceptValue(Ontology ontology) Return the first concept that is a component of this product lattice ontology concept tuple and belongs to the given ontology.
java.util.List<Concept>	getConceptTuple() Return the list of concepts that compose this product lattice concept.
Ontology	getOntology() Return the product lattice ontology that contains this concept.
java.lang.String	toString() Return the string that represents this concept, its name.

Methods inherited from class ptolemy.data.ontologies.FiniteConcept

getCoverSetAbove, getCoverSetBelow, getIncomingPort, getOutgoingPort

Methods inherited from class ptolemy.data.ontologies.Concept

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

Constructor Detail

ProductLatticeConcept

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

Create a new product lattice concept with the specified name and the specified product lattice ontology.

Parameters:

ontology - The specified product lattice 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.

ProductLatticeConcept

public ProductLatticeConcept(ProductLatticeOntology ontology,
                             java.lang.String name,
                             java.util.List<Concept> conceptTuple)
                      throws NameDuplicationException,
                             IllegalActionException

Create a new product lattice concept with the specified name and the specified product lattice ontology.

Parameters:

ontology - The specified product lattice ontology where this concept resides.

name - The specified name for the concept.

conceptTuple - The list of concepts that compose this product lattice concept.

Throws:

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

IllegalActionException - If the base class throws it.

Method Detail

getColor

public ColorAttribute getColor()
                        throws IllegalActionException

Return the color attribute associated with this ProductLatticeConcept. This depends on the component color ontology that is set by the container ProductLatticeOntology.setColorOntology(Ontology). The color of the concept will be derived from the color of the concept in the tuple from the specified component color ontology.

Overrides:

getColor in class Concept

Returns:

The current color attribute for this product lattice concept.

Throws:

IllegalActionException - Thrown if there is an error getting the color from the component concept value.

getComponentConceptValue

public Concept getComponentConceptValue(Ontology ontology)
                                 throws IllegalActionException

Return the first concept that is a component of this product lattice ontology concept tuple and belongs to the given ontology.

Parameters:

ontology - The specified ontology from which to get the component concept. This should be one of the component ontologies from the product lattice ontology for this concept.

Returns:

The concept from the concept.

Throws:

IllegalActionException - If the specified ontology is not a component of the product lattice ontology to which this concept belongs.

getConceptTuple

public java.util.List<Concept> getConceptTuple()

Return the list of concepts that compose this product lattice concept.

Returns:

The list of concepts that compose this product lattice concept.

getOntology

public Ontology getOntology()

Return the product lattice ontology that contains this concept.

Overrides:

getOntology in class Concept

Returns:

The containing product lattice ontology.

toString

public java.lang.String toString()

Return the string that represents this concept, its name.

Overrides:

toString in class FiniteConcept

Returns:

The string name that represents this concept.