ptolemy.kernel
Class CompositeEntity

java.lang.Object
  |
  +--ptolemy.kernel.util.NamedObj
        |
        +--ptolemy.kernel.Entity
              |
              +--ptolemy.kernel.ComponentEntity
                    |
                    +--ptolemy.kernel.CompositeEntity

All Implemented Interfaces:

java.lang.Cloneable, Debuggable, Nameable, java.io.Serializable

Direct Known Subclasses:

CompositeActor, Configuration, Effigy, EffigyFactory, EntityLibrary, FSMActor, ModelDirectory, Tableau

public class CompositeEntity

extends ComponentEntity

A CompositeEntity is a cluster in a clustered graph. I.e., it is a non-atomic entity, in that it can contain other entities and relations. It supports transparent ports, where, in effect, the port of a contained entity is represented by a port of this entity. Methods that "deeply" traverse the topology see right through transparent ports. It may be opaque, in which case its ports are opaque and methods that "deeply" traverse the topology do not see through them. For instance, deepEntityList() returns the opaque entities directly or indirectly contained by this entity.

To add an entity or relation to this composite, call its setContainer() method with this composite as an argument. To remove it, call its setContainer() method with a null argument (or another container). The entity must be an instance of ComponentEntity and the relation of ComponentRelation or an exception is thrown. Derived classes may further constrain these to subclasses. To do that, they should override the protected methods _addEntity() and _addRelation() and the public member newRelation().

A CompositeEntity may be contained by another CompositeEntity. To set that up, call the setContainer() method of the inside entity. Derived classes may further constrain the container to be a subclass of CompositeEntity. To do this, they should override setContainer() to throw an exception. Recursive containment structures, where an entity directly or indirectly contains itself, are disallowed, and an exception is thrown on an attempt to set up such a structure.

A CompositeEntity can contain instances of ComponentPort. By default these ports will be transparent, although subclasses of CompositeEntity can make them opaque by overriding the isOpaque() method to return true. Derived classes may further constrain the ports to a subclass of ComponentPort. To do this, they should override the public method newPort() to create a port of the appropriate subclass, and the protected method _addPort() to throw an exception if its argument is a port that is not of the appropriate subclass.

Since:

Ptolemy II 0.2

Version:

$Id: CompositeEntity.java,v 1.86 2002/02/22 22:38:10 cxh Exp $

Author:

John S. Davis II, Edward A. Lee

See Also:

Serialized Form

Inner classes inherited from class ptolemy.kernel.util.NamedObj

NamedObj.MoMLInfo

Field Summary

protected NamedList

_containedEntities

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _debugging, _debugListeners, _uniqueNameIndex, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

CompositeEntity()
Construct an entity in the default workspace with an empty string as its name.

CompositeEntity(CompositeEntity container, java.lang.String name)
Create an object with a name and a container.

CompositeEntity(Workspace workspace)
Construct an entity in the specified workspace with an empty string as a name.

Method Summary

protected void	_addEntity(ComponentEntity entity) Add an entity to this container.
protected void	_addRelation(ComponentRelation relation) Add a relation to this container.
protected java.lang.String	_description(int detail, int indent, int bracket) Return a description of the object.
protected void	_exportMoMLContents(java.io.Writer output, int depth) Write a MoML description of the contents of this object, which in this class are the attributes, ports, contained relations, and contained entities, plus all links.
protected void	_removeEntity(ComponentEntity entity) Remove the specified entity.
protected void	_removeRelation(ComponentRelation relation) Remove the specified relation.
java.util.List	allAtomicEntityList() Return a list that consists of all the atomic entities in a model.
void	allowLevelCrossingConnect(boolean boole) Allow or disallow connections that are created using the connect() method to cross levels of the hierarchy.
java.lang.Object	clone(Workspace workspace) Clone the object into the specified workspace.
ComponentRelation	connect(ComponentPort port1, ComponentPort port2) Create a new relation and use it to connect two ports.
ComponentRelation	connect(ComponentPort port1, ComponentPort port2, java.lang.String relationName) Create a new relation with the specified name and use it to connect two ports.
java.util.List	deepEntityList() List the opaque entities that are directly or indirectly contained by this entity.
java.util.Enumeration	deepGetEntities() Deprecated. Use deepEntityList() instead.
java.util.List	entityList() List the contained entities in the order they were added (using their setContainer() method).
java.util.List	entityList(java.lang.Class filter) Return a list of the component entities contained by this object that are instances of the specified class.
java.lang.String	exportLinks(int indentation, java.util.Collection filter) Return a sequence of MoML link attributes that describe any link between objects (ports, entities, and relations) that are present in the filter argument.
Attribute	getAttribute(java.lang.String name) Get the attribute with the given name.
java.util.Enumeration	getEntities() Deprecated. Use entityList() instead.
ComponentEntity	getEntity(java.lang.String name) Get a contained entity by name.
Port	getPort(java.lang.String name) Get a contained port by name.
ComponentRelation	getRelation(java.lang.String name) Get a contained relation by name.
java.util.Enumeration	getRelations() Deprecated. Use relationList() instead.
boolean	isAtomic() Return false since CompositeEntities are not atomic.
boolean	isOpaque() Return false.
ComponentRelation	newRelation(java.lang.String name) Create a new relation with the specified name, add it to the relation list, and return it.
int	numEntities() Return the number of contained entities.
int	numRelations() Return the number of contained relations.
java.util.List	relationList() List the relations contained by this entity.
void	removeAllEntities() Remove all contained entities and unlink them from all relations.
void	removeAllRelations() Remove all contained relations and unlink them from everything.
java.lang.String	uniqueName(java.lang.String prefix) Return a name that is guaranteed to not be the name of any contained attribute, port, entity, or relation.

Methods inherited from class ptolemy.kernel.ComponentEntity

_addPort, _checkContainer, getContainer, newPort, setContainer, setName

Methods inherited from class ptolemy.kernel.Entity

_removePort, connectedPortList, connectedPorts, connectionsChanged, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _attachText, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _removeAttribute, _splitName, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, deepContains, depthInHierarchy, description, description, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getFullName, getMoMLInfo, getName, getName, removeChangeListener, removeDebugListener, requestChange, setDeferMoMLDefinitionTo, toplevel, toString, workspace

Methods inherited from class java.lang.Object

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

Field Detail

_containedEntities

protected NamedList _containedEntities

Constructor Detail

CompositeEntity

public CompositeEntity()

Construct an entity in the default workspace with an empty string as its name. Add the entity to the workspace directory. Increment the version number of the workspace.

CompositeEntity

public CompositeEntity(Workspace workspace)

Construct an entity in the specified workspace with an empty string as a name. You can then change the name with setName(). If the workspace argument is null, then use the default workspace. Add the entity to the workspace directory. Increment the version number of the workspace.

Parameters:

workspace - The workspace that will list the entity.

CompositeEntity

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

Create an object with a name and a container. The container argument must not be null, or a NullPointerException will be thrown. This entity 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. Increment the version of the workspace.

Parameters:

container - The container entity.

name - The name of the entity.

Throws:

IllegalActionException - If the container is incompatible with this entity.

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

Method Detail

allAtomicEntityList

public java.util.List allAtomicEntityList()

Return a list that consists of all the atomic entities in a model. This method differs from CompositeEntity.deepEntityList() in that this method looks inside opaque entities, whereas deepEntityList() does not.

Returns:

a List of all atomic entities in the model.

allowLevelCrossingConnect

public void allowLevelCrossingConnect(boolean boole)

Allow or disallow connections that are created using the connect() method to cross levels of the hierarchy. The default is that such connections are disallowed. Generally it is a bad idea to allow level-crossing connections, since it breaks modularity. This loss of modularity means, among other things, that this composite cannot be cloned. Nonetheless, this capability is provided for the benefit of users that feel they just must have it, and who are willing to sacrifice clonability and modularity.

Parameters:

boole - True to allow level-crossing connections.

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). NOTE: This will not work if there are level-crossing transitions. The result is an entity with clones of the ports of the original entity, the contained entities, and the contained relations. The ports of the returned entity are not connected to anything. The connections of the relations are duplicated in the new entity, unless they cross levels, in which case an exception is thrown.

Overrides:

clone in class ComponentEntity

Parameters:

workspace - The workspace for the cloned object.

Returns:

A new CompositeEntity.

Throws:

java.lang.CloneNotSupportedException - If the entity contains level crossing transitions so that its connections cannot be cloned, or if one of the attributes cannot be cloned.

connect

public ComponentRelation connect(ComponentPort port1,
                                 ComponentPort port2)
                          throws IllegalActionException

Create a new relation and use it to connect two ports. It creates a new relation using newRelation() with an automatically generated name and uses it to link the specified ports. The order of the ports determines the order in which the links to the relation are established, but otherwise has no importance. The name is of the form "_Ri" where i is an integer. Level-crossing connections are not permitted unless allowLevelCrossingConnect() has been called with a true argument. Note that is rarely a good idea to permit level crossing connections, since they break modularity and cloning. A reference to the newly created relation is returned. To remove the relation, call its setContainer() method with a null argument. This method is write-synchronized on the workspace and increments its version number.

Parameters:

port1 - The first port to connect.

port2 - The second port to connect.

Throws:

IllegalActionException - If one of the arguments is null, or if a disallowed level-crossing connection would result.

connect

public ComponentRelation connect(ComponentPort port1,
                                 ComponentPort port2,
                                 java.lang.String relationName)
                          throws IllegalActionException,
                                 NameDuplicationException

Create a new relation with the specified name and use it to connect two ports. Level-crossing connections are not permitted unless allowLevelCrossingConnect() has been called with a true argument. Note that is rarely a good idea to permit level crossing connections, since they break modularity and cloning. A reference to the newly created alias relation is returned. To remove the relation, call its setContainer() method with a null argument. This method is write-synchronized on the workspace and increments its version number.

Parameters:

port1 - The first port to connect.

port2 - The second port to connect.

relationName - The name of the new relation.

Throws:

IllegalActionException - If one of the arguments is null, or if a disallowed level-crossing connection would result, or if the two ports are not in the same workspace as this entity.

NameDuplicationException - If there is already a relation with the specified name in this entity.

deepEntityList

public java.util.List deepEntityList()

List the opaque entities that are directly or indirectly contained by this entity. The list will be empty if there are no such contained entities. This method is read-synchronized on the workspace.

Returns:

A list of opaque ComponentEntity objects.

deepGetEntities

public java.util.Enumeration deepGetEntities()

Deprecated. Use deepEntityList() instead.

Enumerate the opaque entities that are directly or indirectly contained by this entity. The enumeration will be empty if there are no such contained entities. This method is read-synchronized on the workspace.

Returns:

An enumeration of opaque ComponentEntity objects.

entityList

public java.util.List entityList()

List the contained entities in the order they were added (using their setContainer() method). The returned list is static in the sense that it is not affected by any subsequent additions or removals of entities. This method is read-synchronized on the workspace.

Returns:

An unmodifiable list of ComponentEntity objects.

entityList

public java.util.List entityList(java.lang.Class filter)

Return a list of the component entities contained by this object that are instances of the specified class. If there are no such instances, then return an empty list. This method is read-synchronized on the workspace.

Parameters:

filter - The class of ComponentEntity of interest.

Returns:

A list of instances of specified class.

exportLinks

public java.lang.String exportLinks(int indentation,
                                    java.util.Collection filter)
                             throws java.io.IOException

Return a sequence of MoML link attributes that describe any link between objects (ports, entities, and relations) that are present in the filter argument. Both ends of the link must be present in filter for MoML to be generated for that link. The filter argument normally contains ports, relations, and entities that are contained by this composite entity. If it contains an entity, then that is equivalent to containing all the ports contained by that entity. It is recommended to use a collection class (such as HashSet) for which the contains() method is efficient.

If the argument is null, then return all the links that this composite is responsible for (i.e., apply no filtering). If the argument is an empty collection, then return none of the links. The links that this entity is responsible for is the inside links of its ports, and links on ports contained by contained entities.

Parameters:

indentation - The depth at which the output should be indented.

filter - A collection of ports, parameters, and entities, or null to apply no filtering.

Throws:

java.io.IOException - If an I/O error occurs.

getAttribute

public Attribute getAttribute(java.lang.String name)

Get the attribute with the given name. The name may be compound, with fields separated by periods, in which case the attribute returned is contained by a (deeply) contained attribute, port, relation, or entity. If the name contains one or more periods, then it is assumed to be the relative name of an attribute contained by one of the contained attributes, ports, entities or relations. This method is read-synchronized on the workspace.

Overrides:

getAttribute in class Entity

Parameters:

name - The name of the desired attribute.

Returns:

The requested attribute if it is found, null otherwise.

getEntity

public ComponentEntity getEntity(java.lang.String name)

Get a contained entity by name. The name may be compound, with fields separated by periods, in which case the entity returned is contained by a (deeply) contained entity. This method is read-synchronized on the workspace.

Parameters:

name - The name of the desired entity.

Returns:

An entity with the specified name, or null if none exists.

getEntities

public java.util.Enumeration getEntities()

Deprecated. Use entityList() instead.

Enumerate the contained entities in the order they were added (using their setContainer() method). The returned enumeration is static in the sense that it is not affected by any subsequent additions or removals of entities. This method is read-synchronized on the workspace.

Returns:

An enumeration of ComponentEntity objects.

getPort

public Port getPort(java.lang.String name)

Get a contained port by name. The name may be compound, with fields separated by periods, in which case the port returned is contained by a (deeply) contained entity. This method is read-synchronized on the workspace.

Overrides:

getPort in class Entity

Parameters:

name - The name of the desired port.

Returns:

A port with the specified name, or null if none exists.

getRelation

public ComponentRelation getRelation(java.lang.String name)

Get a contained relation by name. The name may be compound, with fields separated by periods, in which case the relation returned is contained by a (deeply) contained entity. This method is read-synchronized on the workspace.

Parameters:

name - The name of the desired relation.

Returns:

A relation with the specified name, or null if none exists.

getRelations

public java.util.Enumeration getRelations()

Deprecated. Use relationList() instead.

Enumerate the relations contained by this entity. The returned enumeration is static in the sense that it is not affected by any subsequent additions or removals of relations. This method is read-synchronized on the workspace.

Returns:

An enumeration of ComponentRelation objects.

isAtomic

public final boolean isAtomic()

Return false since CompositeEntities are not atomic. Note that this will return false even if there are no contained entities or relations. Derived classes may not override this. To hide the contents of the entity, they should override isOpaque().

Overrides:

isAtomic in class ComponentEntity

Returns:

False.

isOpaque

public boolean isOpaque()

Return false. Derived classes may return true in order to hide their components behind opaque ports.

Overrides:

isOpaque in class ComponentEntity

Returns:

True if the entity is opaque.

See Also:

CompositeEntity

newRelation

public ComponentRelation newRelation(java.lang.String name)
                              throws IllegalActionException,
                                     NameDuplicationException

Create a new relation with the specified name, add it to the relation list, and return it. Derived classes can override this to create domain-specific subclasses of ComponentRelation. This method is write-synchronized on the workspace and increments its version number.

Parameters:

name - The name of the new relation.

Returns:

The new relation.

Throws:

IllegalActionException - If name argument is null.

NameDuplicationException - If name collides with a name already in the container.

numEntities

public int numEntities()

Return the number of contained entities. This method is read-synchronized on the workspace.

Returns:

The number of entities.

numRelations

public int numRelations()

Return the number of contained relations. This method is read-synchronized on the workspace.

Returns:

The number of relations.

relationList

public java.util.List relationList()

List the relations contained by this entity. The returned list is static in the sense that it is not affected by any subsequent additions or removals of relations. This method is read-synchronized on the workspace.

Returns:

An unmodifiable list of ComponentRelation objects.

removeAllEntities

public void removeAllEntities()

Remove all contained entities and unlink them from all relations. This is done by setting their containers to null. This method is read-synchronized on the workspace and increments its version number.

removeAllRelations

public void removeAllRelations()

Remove all contained relations and unlink them from everything. This is done by setting their containers to null. This method is write-synchronized on the workspace and increments its version number.

uniqueName

public java.lang.String uniqueName(java.lang.String prefix)

Return a name that is guaranteed to not be the name of any contained attribute, port, entity, or relation.

Overrides:

uniqueName in class Entity

Parameters:

prefix - A prefix for the name.

Returns:

A unique name.

_addEntity

protected void _addEntity(ComponentEntity entity)
                   throws IllegalActionException,
                          NameDuplicationException

Add an entity to this container. This method should not be used directly. Call the setContainer() method of the entity instead. This method does not set the container of the entity to point to this composite entity. It assumes that the entity is in the same workspace as this container, but does not check. The caller should check. Derived classes may override this method to constrain the the entity to a subclass of ComponentEntity. This method is not synchronized on the workspace, so the caller should be.

Parameters:

entity - Entity to contain.

Throws:

IllegalActionException - If the entity has no name, or the action would result in a recursive containment structure.

NameDuplicationException - If the name collides with a name already in the entity.

_addRelation

protected void _addRelation(ComponentRelation relation)
                     throws IllegalActionException,
                            NameDuplicationException

Add a relation to this container. This method should not be used directly. Call the setContainer() method of the relation instead. This method does not set the container of the relation to refer to this container. This method is not synchronized on the workspace, so the caller should be.

Parameters:

relation - Relation to contain.

Throws:

IllegalActionException - If the relation has no name.

NameDuplicationException - If the name collides with a name already on the contained relations list.

_description

protected java.lang.String _description(int detail,
                                        int indent,
                                        int bracket)

Return a description of the object. The level of detail depends on the argument, which is an or-ing of the static final constants defined in the NamedObj class. Lines are indented according to to the level argument using the protected method _getIndentPrefix(). Zero, one or two brackets can be specified to surround the returned description. If one is specified it is the the leading bracket. This is used by derived classes that will append to the description. Those derived classes are responsible for the closing bracket. An argument other than 0, 1, or 2 is taken to be equivalent to 0. This method is read-synchronized on the workspace.

Overrides:

_description in class Entity

Parameters:

detail - The level of detail.

indent - The amount of indenting.

bracket - The number of surrounding brackets (0, 1, or 2).

Returns:

A description of the object.

_exportMoMLContents

protected void _exportMoMLContents(java.io.Writer output,
                                   int depth)
                            throws java.io.IOException

Write a MoML description of the contents of this object, which in this class are the attributes, ports, contained relations, and contained entities, plus all links. The links are written in an order that respects the ordering in ports, but not necessarily the ordering in relations. This method is called by exportMoML(). Each description is indented according to the specified depth and terminated with a newline character.

Overrides:

_exportMoMLContents in class Entity

Parameters:

output - The output to write to.

depth - The depth in the hierarchy, to determine indenting.

Throws:

java.io.IOException - If an I/O error occurs.

_removeEntity

protected void _removeEntity(ComponentEntity entity)

Remove the specified entity. This method should not be used directly. Call the setContainer() method of the entity instead with a null argument. The entity is assumed to be contained by this composite (otherwise, nothing happens). This does not alter the entity in any way. This method is not synchronized on the workspace, so the caller should be.

Parameters:

entity - The entity to remove.

_removeRelation

protected void _removeRelation(ComponentRelation relation)

Remove the specified relation. This method should not be used directly. Call the setContainer() method of the relation instead with a null argument. The relation is assumed to be contained by this composite (otherwise, nothing happens). This does not alter the relation in any way. This method is not synchronized on the workspace, so the caller should be.

Parameters:

relation - The relation to remove.