|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.kernel.CompositeEntity
ptolemy.actor.gui.Effigy
An effigy represents model metadata, and is contained by the model directory or by another effigy. The effigy, for example, keeps track of where the model originated (from a URI or file) and whether the model has been modified since the URI or file was read. In design automation, such information is often called "metadata." When we began to design this class, we called it ModelModel, because it was a model of a Ptolemy II model. However, this name seemed awkward, so we changed it to Effigy. We also considered the name Proxy for the class. We rejected that name because of the common use of the word "proxy" in distributed object-oriented models.
The Effigy class extends CompositeEntity, so an instance of Effigy can contain entities. By convention, an effigy contains all open instances of Tableau associated with the model. It also contains a string attribute named "identifier" with a value that uniquely identifies the model. A typical choice (which depends on the configuration) is the canonical URI for a MoML file that describes the model. In the case of an effigy contained by another, a typical choice is the URI of the parent effigy, a pound sign "#", and a name.
An effigy may contain other effigies. The top effigy in such a containment hierarchy is associated with a URI or file. Contained effigies are associated with the same file, and represent structured data within the top-level representation in the file. The topEffigy() method returns that top effigy.
NOTE: It might seem more natural for the identifier to match the name of the effigy rather than recording the identifier in a string attribute. But in Ptolemy II, an entity name cannot have periods in it, and a URI typically does have periods in it.
ModelDirectory,
Tableau,
Serialized Form
| Yellow (celaine) |
| Green (eal) |
| Nested Class Summary |
| Nested classes inherited from class ptolemy.kernel.CompositeEntity |
CompositeEntity.ContainedObjectsIterator |
| Field Summary | |
StringAttribute |
identifier
The identifier for the effigy. |
URIAttribute |
uri
The URI for the effigy. |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
| Constructor Summary | |
Effigy(CompositeEntity container,
java.lang.String name)
Construct an effigy with the given name and container. |
|
Effigy(Workspace workspace)
Create a new effigy in the specified workspace with an empty string for its name. |
|
| Method Summary | |
protected void |
_checkContainer(CompositeEntity container)
Check that the specified container is of a suitable class for this entity, i.e., ModelDirectory or Effigy. |
protected void |
_removeEntity(ComponentEntity entity)
Remove the specified entity from this container. |
void |
attributeChanged(Attribute attribute)
If the argument is the identifier parameter, then set the title of all contained Tableaux to the value of the parameter; if the argument is the uri parameter, then check to see whether it is writable, and call setModifiable() appropriately. |
boolean |
closeTableaux()
Close all tableaux contained by this effigy, and by any effigies it contains. |
TableauFactory |
getTableauFactory()
Get a tableau factory that offers views of this effigy, or null if none has been specified. |
java.io.File |
getWritableFile()
Return a writable file for the URI given by the uri parameter of this effigy, if there is one, or return null if there is not. |
boolean |
isModifiable()
Return whether the model data is modifiable. |
boolean |
isModified()
Return the value set by setModified(), or false if setModified() has not been called on this effigy or any effigy contained by the same top effigy (returned by topEffigy()). |
boolean |
isSystemEffigy()
Return whether this effigy is a system effigy. |
int |
numberOfOpenTableaux()
Return the total number of open tableau for this effigy effigy and all effigies it contains. |
void |
setContainer(CompositeEntity container)
Override the base class so that tableaux contained by this object are removed before this effigy is removed from the ModelDirectory. |
void |
setModifiable(boolean flag)
If the argument is false, the specify that that the model is not modifiable, even if the URI associated with this effigy is writable. |
void |
setModified(boolean modified)
Record whether the data associated with this effigy has been modified since it was first read or last saved. |
void |
setSystemEffigy(boolean flag)
Set the effigy to be a system effigy if the given flag is true. |
void |
setTableauFactory(TableauFactory factory)
Specify a tableau factory that offers multiple views of this effigy. |
Tableau |
showTableaux()
Make all tableaux associated with this effigy and any effigies it contains visible by raising or deiconifying them. |
Effigy |
topEffigy()
Return the top-level effigy that (deeply) contains this one. |
void |
writeFile(java.io.File file)
Write the model associated with this effigy to the specified file. |
| Methods inherited from class ptolemy.kernel.ComponentEntity |
_addPort, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, newPort, propagateExistence, setName |
| Methods inherited from class ptolemy.kernel.Entity |
_removePort, connectedPortList, connectedPorts, connectionsChanged, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition |
| Methods inherited from class ptolemy.kernel.InstantiableNamedObj |
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition |
| 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, getFullName, getName, getName |
| Field Detail |
public StringAttribute identifier
public URIAttribute uri
| Constructor Detail |
public Effigy(Workspace workspace)
workspace - The workspace for this effigy.
public Effigy(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
container - The container.name - The name of the effigy.
IllegalActionException - If the entity cannot be contained
by the proposed container.
NameDuplicationException - If the name coincides with
an entity already in the container.| Method Detail |
public void attributeChanged(Attribute attribute)
throws IllegalActionException
attributeChanged in class NamedObjattribute - The attribute that changed.
IllegalActionException - If the base class throws it.public boolean closeTableaux()
public TableauFactory getTableauFactory()
setTableauFactory(TableauFactory)public java.io.File getWritableFile()
public boolean isModifiable()
public boolean isModified()
setModifiable(boolean)public boolean isSystemEffigy()
public int numberOfOpenTableaux()
public void setContainer(CompositeEntity container)
throws IllegalActionException,
NameDuplicationException
setContainer in class ComponentEntitycontainer - The directory in which to list this effigy.
IllegalActionException - If the proposed container is not
an instance of ModelDirectory, or if the superclass throws it.
NameDuplicationException - If the container already has
an entity with the specified name.ComponentEntity.getContainer()public void setModifiable(boolean flag)
flag - False to prevent writing to the URI.isModifiable()public void setModified(boolean modified)
modified - True if the data has been modified.public void setSystemEffigy(boolean flag)
public void setTableauFactory(TableauFactory factory)
factory - A tableau factory offering multiple views.public Tableau showTableaux()
public Effigy topEffigy()
public void writeFile(java.io.File file)
throws java.io.IOException
file - The file to write to.
java.io.IOException - If the write fails.
protected void _checkContainer(CompositeEntity container)
throws IllegalActionException
container - The proposed container.
IllegalActionException - If the container is not of
an acceptable class.protected void _removeEntity(ComponentEntity entity)
_removeEntity in class CompositeEntityentity - The tableau to remove.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||