ptolemy.vergil.fsm
Class FSMGraphModel

java.lang.Object
  extended bydiva.graph.AbstractGraphModel
      extended bydiva.graph.modular.ModularGraphModel
          extended byptolemy.vergil.basic.AbstractBasicGraphModel
              extended byptolemy.vergil.fsm.FSMGraphModel
All Implemented Interfaces:
GraphModel

public class FSMGraphModel
extends AbstractBasicGraphModel

A graph model for graphically manipulating ptolemy FSM models.

Since:
Ptolemy II 2.0
Version:
$Id: FSMGraphModel.java,v 1.28 2004/04/29 23:06:05 eal Exp $
Author:
Steve Neuendorffer
Accepted Rating:
Red (johnr)
Proposed Rating:
Yellow (neuendor)

Nested Class Summary
 class FSMGraphModel.ArcModel
          The model for arcs between states.
 class FSMGraphModel.PortModel
          The model for external ports.
 class FSMGraphModel.StateModel
          The model for an icon that represent states.
 
Nested classes inherited from class ptolemy.vergil.basic.AbstractBasicGraphModel
AbstractBasicGraphModel.GraphChangeListener
 
Field Summary
 
Fields inherited from class diva.graph.AbstractGraphModel
_graphListeners
 
Constructor Summary
FSMGraphModel(CompositeEntity composite)
          Construct a new graph model whose root is the given composite entity.
 
Method Summary
protected  boolean _update()
          Update the graph model.
 void disconnectEdge(java.lang.Object eventSource, java.lang.Object edge)
          Disconnect an edge from its two enpoints and notify graph listeners with an EDGE_HEAD_CHANGED and an EDGE_TAIL_CHANGED event whose source is the given source.
 FSMGraphModel.ArcModel getArcModel()
           
 java.lang.String getDeleteEdgeMoML(java.lang.Object edge)
          Return a MoML String that will delete the given edge from the Ptolemy model.
 java.lang.String getDeleteNodeMoML(java.lang.Object node)
          Return a MoML String that will delete the given node from the Ptolemy model.
 EdgeModel getEdgeModel(java.lang.Object edge)
          Return the model for the given edge object.
 NodeModel getNodeModel(java.lang.Object node)
          Return the node model for the given object.
 FSMGraphModel.PortModel getPortModel()
           
 java.lang.Object getSemanticObject(java.lang.Object element)
          Return the semantic object corresponding to the given node, edge, or composite.
 FSMGraphModel.StateModel getStateModel()
           
 void removeNode(java.lang.Object eventSource, java.lang.Object node)
          Delete a node from its parent graph and notify graph listeners with a NODE_REMOVED event.
 
Methods inherited from class ptolemy.vergil.basic.AbstractBasicGraphModel
_getLocation, getCompositeModel, getProperty, getPtolemyModel, isNode, removeListeners, setProperty, setSemanticObject
 
Methods inherited from class diva.graph.modular.ModularGraphModel
containsNode, getHead, getNodeCount, getParent, getRoot, getTail, inEdges, isComposite, isDirected, isEdge, nodes, outEdges
 
Methods inherited from class diva.graph.AbstractGraphModel
addGraphListener, dispatchGraphEvent, removeGraphListener, setDispatchEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FSMGraphModel

public FSMGraphModel(CompositeEntity composite)
Construct a new graph model whose root is the given composite entity.

Parameters:
composite - The top-level composite entity for the model.
Method Detail

disconnectEdge

public void disconnectEdge(java.lang.Object eventSource,
                           java.lang.Object edge)
Disconnect an edge from its two enpoints and notify graph listeners with an EDGE_HEAD_CHANGED and an EDGE_TAIL_CHANGED event whose source is the given source.

Specified by:
disconnectEdge in class AbstractBasicGraphModel
Parameters:
eventSource - The source of the event that will be dispatched, e.g. the view that made this call.
Throws:
GraphException - If the operation fails.

getDeleteEdgeMoML

public java.lang.String getDeleteEdgeMoML(java.lang.Object edge)
Return a MoML String that will delete the given edge from the Ptolemy model.

Specified by:
getDeleteEdgeMoML in class AbstractBasicGraphModel
Returns:
A valid MoML string.

getDeleteNodeMoML

public java.lang.String getDeleteNodeMoML(java.lang.Object node)
Return a MoML String that will delete the given node from the Ptolemy model.

Specified by:
getDeleteNodeMoML in class AbstractBasicGraphModel
Returns:
A valid MoML string.

getEdgeModel

public EdgeModel getEdgeModel(java.lang.Object edge)
Return the model for the given edge object. If the object is not an edge, then return null.

Specified by:
getEdgeModel in class ModularGraphModel
Parameters:
edge - An object which is assumed to be in this graph model.
Returns:
An instance of ArcModel if the object is an Arc. Otherwise return null.

getNodeModel

public NodeModel getNodeModel(java.lang.Object node)
Return the node model for the given object. If the object is not a node, then return null.

Overrides:
getNodeModel in class AbstractBasicGraphModel
Parameters:
node - An object which is assumed to be in this graph model.
Returns:
The node model for the specified node, or null if there is none.

getSemanticObject

public java.lang.Object getSemanticObject(java.lang.Object element)
Return the semantic object corresponding to the given node, edge, or composite. A "semantic object" is an object associated with a node in the graph. In this case, if the node is icon, the semantic object is the entity containing the icon. If it is an arc, then the semantic object is the arc's relation.

Specified by:
getSemanticObject in interface GraphModel
Overrides:
getSemanticObject in class AbstractBasicGraphModel
Parameters:
element - A graph element.
Returns:
The semantic object associated with this element, or null if the object is not recognized.

removeNode

public void removeNode(java.lang.Object eventSource,
                       java.lang.Object node)
Delete a node from its parent graph and notify graph listeners with a NODE_REMOVED event.

Specified by:
removeNode in class AbstractBasicGraphModel
Parameters:
eventSource - The source of the event that will be dispatched, e.g. the view that made this call.
Throws:
GraphException - If the operation fails.

getPortModel

public FSMGraphModel.PortModel getPortModel()

getStateModel

public FSMGraphModel.StateModel getStateModel()

getArcModel

public FSMGraphModel.ArcModel getArcModel()

_update

protected boolean _update()
Update the graph model. This is called whenever a change request is executed. In this class the internal set of link objects is verified to be correct.

Overrides:
_update in class AbstractBasicGraphModel
Returns:
True if the graph model changes (always true in this base class).