Package org.jgraph.graph

Class DefaultGraphModel

java.lang.Object
javax.swing.undo.UndoableEditSupport
org.jgraph.graph.DefaultGraphModel
All Implemented Interfaces:
Serializable, GraphModel
public class DefaultGraphModel extends UndoableEditSupport implements Serializable, GraphModel
The default implementation of a graph model.
See Also:

  • Field Details

    • listenerList

      protected transient EventListenerList listenerList
      The list of listeners that listen to the model.

    • emptyIterator

      protected transient Iterator emptyIterator
      Default instance of an empty iterator.

    • roots

      protected List roots
      Set that contains all root cells of this model.

    • asksAllowsChildren

      protected boolean asksAllowsChildren
      Indicates whether isLeaf is based on a node's allowsChildren value.

    • removeEmptyGroups

      protected boolean removeEmptyGroups
      Whether or not to remove group cells from the model when all of their children are removed

    • attributes

      protected AttributeMap attributes
      The model's own attributes as a map. Defaults to an empty Hashtable.

    • updateLevel

      protected transient int updateLevel
      Counter for the depth of nested transactions. Each call to beginUpdate increments this counter and each call to endUpdate decrements it. When the counter reaches 0, the transaction is closed and applied to the model.

    • transAddedCells

      protected transient Set transAddedCells
      Stores nested transaction added cells

    • transRemovedCells

      protected transient Set transRemovedCells
      Stores nested transaction removed cells

    • transEditAttrs

      protected transient Map transEditAttrs
      Stores nested transaction transport attribute maps

    • transEditCS

      protected transient ConnectionSet transEditCS
      Stores nested transaction connection sets

    • transEditPM

      protected transient ParentMap transEditPM
      Stores nested transaction parent maps

  • Constructor Details

    • DefaultGraphModel

      public DefaultGraphModel()
      Constructs a model that is not an attribute store.

    • DefaultGraphModel

      public DefaultGraphModel(List roots, AttributeMap attributes)
      Constructs a model that is not an attribute store.

    • DefaultGraphModel

      public DefaultGraphModel(List roots, AttributeMap attributes, ConnectionSet cs)
      Constructs a model using the specified information to construct the cells, attributes and connection data.

  • Method Details

    • getRoots

      public List getRoots()

    • getRootCount

      public int getRootCount()
      Returns the number of roots in the model. Returns 0 if the model is empty.
      Specified by:
      getRootCount in interface GraphModel
      Returns:
      the number of roots in the model

    • getRootAt

      public Object getRootAt(int index)
      Returns the root at index index in the model. This should not return null if index is a valid index for the model (that is index >= 0 && index < getRootCount()).
      Specified by:
      getRootAt in interface GraphModel
      Returns:
      the root of at index index

    • getIndexOfRoot

      public int getIndexOfRoot(Object root)
      Returns the index of root in the model. If root is null, returns -1.
      Specified by:
      getIndexOfRoot in interface GraphModel
      Parameters:
      root - a root in the model, obtained from this data source
      Returns:
      the index of the root in the model, or -1 if the parent is null

    • contains

      public boolean contains(Object node)
      Returns true if node or one of its ancestors is in the model.
      Specified by:
      contains in interface GraphModel
      Returns:
      true if node is in the model

    • getAttributes

      public AttributeMap getAttributes(Object node)
      Returns a Map that represents the attributes for the specified cell. This attributes have precedence over each view's attributes, regardless of isAttributeStore.
      Specified by:
      getAttributes in interface GraphModel
      Returns:
      attributes of node as a Map

    • getValue

      public Object getValue(Object cell)
      Description copied from interface: GraphModel
      Returns the user object for the specified cell.
      Specified by:
      getValue in interface GraphModel
      Returns:
      Returns the user object of the given cell. This implementation checks if the cell is a default mutable tree node and returns it's user object.

    • getAttributes

      public Map getAttributes()
      Returns the graph model's attribute. Shortcut to getAttributes(null).
      Returns:
      attributes of node as a Map

    • getSource

      public Object getSource(Object edge)
      Returns the source of edge. edge must be an object previously obtained from this data source.
      Specified by:
      getSource in interface GraphModel
      Returns:
      Object that represents the source of edge

    • getTarget

      public Object getTarget(Object edge)
      Returns the target of edge. edge must be an object previously obtained from this data source.
      Specified by:
      getTarget in interface GraphModel
      Returns:
      Object that represents the target of edge

    • acceptsSource

      public boolean acceptsSource(Object edge, Object port)
      Returns true if port is a valid source for edge. edge and port must be objects previously obtained from this data source.
      Specified by:
      acceptsSource in interface GraphModel
      Returns:
      true if port is a valid source for edge.

    • acceptsTarget

      public boolean acceptsTarget(Object edge, Object port)
      Returns true if port is a valid target for edge. edge and port must be objects previously obtained from this data source.
      Specified by:
      acceptsTarget in interface GraphModel
      Returns:
      true if port is a valid target for edge.

    • edges

      public Iterator edges(Object port)
      Returns an iterator of the edges connected to port. port must be a object previously obtained from this data source. This method never returns null.
      Specified by:
      edges in interface GraphModel
      Parameters:
      port - a port in the graph, obtained from this data source
      Returns:
      Iterator that represents the connected edges

    • isEdge

      public boolean isEdge(Object edge)
      Returns true if edge is a valid edge.
      Specified by:
      isEdge in interface GraphModel
      Returns:
      true if edge is a valid edge.

    • isPort

      public boolean isPort(Object port)
      Returns true if port is a valid port, possibly supporting edge connection.
      Specified by:
      isPort in interface GraphModel
      Returns:
      true if port is a valid port.

    • getConnectionSet

      public ConnectionSet getConnectionSet()
      A shortcut method to create a connection set that represents the connections in this model. Useful for encoding to avoid writing redundant connection data stored in the cells.

    • cloneCells

      public Map cloneCells(Object[] cells)
      Returns a map of (cell, clone)-pairs for all cells. In the new array, all references are replaced with references to the cloned cells (ie parent or anchor). This method does only include children which are in cells. Use JGraph.getDescendants to get a complete list of all children.
      Specified by:
      cloneCells in interface GraphModel

    • setParent

      protected void setParent(Object child, Object parent)
      Sets the parent of the specified cell.

    • cloneCell

      protected Object cloneCell(Object cellObj)
      Creates a shallow copy of the cell including a copy of the user object. Subclassers can override the cloneUserObject to provide a custom user object cloning mechanism.

    • cloneUserObject

      protected Object cloneUserObject(Object userObject)
      Clones the user object. Helper method that is invoked from cloneCells. You must use cloneCells (or cloneCell for single cells) to get a deep copy of a clone. Subclassers must override this and valueForCellChanged to implement custom user objects. This implementation returns object.

    • getParent

      public Object getParent(Object child)
      Returns the parent of child in the model. child must be a node previously obtained from this data source. This returns null if child is a root in the model.
      Specified by:
      getParent in interface GraphModel
      Parameters:
      child - a node in the graph, obtained from this data source
      Returns:
      the parent of child

    • getIndexOfChild

      public int getIndexOfChild(Object parent, Object child)
      Returns the index of child in parent. If either the parent or child is null, returns -1.
      Specified by:
      getIndexOfChild in interface GraphModel
      Parameters:
      parent - a note in the tree, obtained from this data source
      child - the node we are interested in
      Returns:
      the index of the child in the parent, or -1 if either the parent or the child is null

    • getChild

      public Object getChild(Object parent, int index)
      Returns the child of parent at index index in the parent's child array. parent must be a node previously obtained from this data source. This should not return null if index is a valid index for parent (that is index >= 0 && index < getChildCount( parent )).
      Specified by:
      getChild in interface GraphModel
      Parameters:
      parent - a node in the tree, obtained from this data source
      Returns:
      the child of parent at index index

    • getChildCount

      public int getChildCount(Object parent)
      Returns the number of children of parent . Returns 0 if the node is a leaf or if it has no children. parent must be a node previously obtained from this data source.
      Specified by:
      getChildCount in interface GraphModel
      Parameters:
      parent - a node in the tree, obtained from this data source
      Returns:
      the number of children of the node parent

    • isLeaf

      public boolean isLeaf(Object node)
      Returns whether the specified node is a leaf node. The way the test is performed depends on the.
      Specified by:
      isLeaf in interface GraphModel
      Parameters:
      node - the node to check
      Returns:
      true if the node is a leaf node

    • insert

      public void insert(Object[] roots, Map attributes, ConnectionSet cs, ParentMap pm, UndoableEdit[] edits)
      Inserts the roots and connections into the model. Notifies the model- and undo listeners of the change. The passed-in edits are executed if they implement the GraphModelEvent.ExecutableGraphChange interface in ascending array-order, after execution of the model change. Note: The passed-in propertyMap may contain PortView s which must be turned into Point s when stored in the model.
      Specified by:
      insert in interface GraphModel

    • remove

      public void remove(Object[] roots)
      Removes cells from the model. Notifies the model- and undo listeners of the change.
      Specified by:
      remove in interface GraphModel

    • edit

      public void edit(Map attributes, ConnectionSet cs, ParentMap pm, UndoableEdit[] edits)
      Shortcut to the new edit method which allows inserts and removes to go along with an edit.
      Specified by:
      edit in interface GraphModel

    • edit

      public void edit(Object[] inserted, Object[] removed, Map attributes, ConnectionSet cs, ParentMap pm, UndoableEdit[] edits)
      Applies attributes and the connection changes to the model. The initial edits that triggered the call are considered to be part of this transaction. The passed-in edits are executed if they implement the GraphModelEvent.ExecutableGraphChange interface in ascending array-order, after execution of the model change. Notifies the model- and undo listeners of the change. Note: If only edits is non-null, the edits are directly passed to the UndoableEditListeners. Note: The passed-in propertyMap may contains PortViews which must be turned into Points when stored in the model.

    • execute

      public void execute(ExecutableChange change)
      Description copied from interface: GraphModel
      Executes the specified executable change on this graph model
      Specified by:
      execute in interface GraphModel
      Parameters:
      change - the change to be executed

    • getUpdateLevel

      public int getUpdateLevel()
      Overrides:
      getUpdateLevel in class UndoableEditSupport

    • beginUpdate

      public void beginUpdate()
      Description copied from interface: GraphModel
      Indicates the start of one level of an executable change
      Specified by:
      beginUpdate in interface GraphModel
      Overrides:
      beginUpdate in class UndoableEditSupport

    • endUpdate

      public void endUpdate()
      Description copied from interface: GraphModel
      Indicates the end of the current level of an executable change
      Specified by:
      endUpdate in interface GraphModel
      Overrides:
      endUpdate in class UndoableEditSupport

    • updateTransaction

      protected void updateTransaction(Object[] inserted, Object[] removed, Map attributes, ConnectionSet cs, ParentMap pm)
      Updates the current state of the various transaction data
      Parameters:
      inserted - inserted cell to be added to the transaction
      removed - removed cells to be removed from the transaction
      attributes - nested attribute maps to apply to the transaction
      cs - connection sets to add to the transaction
      pm - parent maps to add to the transaction

    • toBack

      public void toBack(Object[] cells)
      Sends cells to back.
      Specified by:
      toBack in interface GraphModel

    • toFront

      public void toFront(Object[] cells)
      Brings cells to front.
      Specified by:
      toFront in interface GraphModel

    • createLayerEdit

      protected DefaultGraphModel.GraphModelLayerEdit createLayerEdit(Object[] cells, int layer)

    • createRemoveEdit

      protected DefaultGraphModel.GraphModelEdit createRemoveEdit(Object[] cells)
      Returns an edit that represents a remove.

    • createEdit

      protected DefaultGraphModel.GraphModelEdit createEdit(Object[] inserted, Object[] removed, Map attributes, ConnectionSet cs, ParentMap pm, UndoableEdit[] edits)

    • handleInsert

      protected Object[] handleInsert(Object[] cells)
      Inserts cells into the model. Returns the cells that were inserted (including descendants).

    • handleRemove

      protected Object[] handleRemove(Object[] cells)
      Removes cells from the model. Returns the cells that were removed as roots.

    • handleParentMap

      protected ParentMap handleParentMap(ParentMap parentMap)
      Applies cells to the model. Returns a parent map that may be used to undo this change.

    • handleAttributes

      protected Map handleAttributes(Map attributes)
      Applies attributes to the cells specified as keys. Returns the attributes to undo the change.

    • valueForCellChanged

      public Object valueForCellChanged(Object cell, Object newValue)
      Applies the new value to the specified cell. Unfortunately for cloning the user object you must still override the attribute map and provide a custom cloneUserObject method. This is because the cloning of a cell is local to the cell, which in turn has a reference to its attribute map.
      Specified by:
      valueForCellChanged in interface GraphModel
      Parameters:
      cell -
      newValue -
      Returns:
      the old value for the cell, if any

    • handleConnectionSet

      protected ConnectionSet handleConnectionSet(ConnectionSet cs)
      Applies connectionSet to the model. Returns a connection set that may be used to undo this change.

    • handleConnection

      protected void handleConnection(ConnectionSet.Connection c, boolean establish)
      Inserts the specified connection into the model.

    • connect

      protected void connect(Object edge, Object port, boolean isSource, boolean insert)
      Connects or disconnects the edge and port in this model based on remove. Subclassers should override this to update connectivity datastructures.

    • addGraphModelListener

      public void addGraphModelListener(GraphModelListener l)
      Adds a listener for the GraphModelEvent posted after the graph changes.
      Specified by:
      addGraphModelListener in interface GraphModel
      Parameters:
      l - the listener to add
      See Also:

    • removeGraphModelListener

      public void removeGraphModelListener(GraphModelListener l)
      Removes a listener previously added with addGraphModelListener() .
      Specified by:
      removeGraphModelListener in interface GraphModel
      Parameters:
      l - the listener to remove
      See Also:

    • cellsChanged

      public void cellsChanged(Object[] cells)
      Invoke this method after you've changed how the cells are to be represented in the graph.

    • fireGraphChanged

      protected void fireGraphChanged(Object source, GraphModelEvent.GraphModelChange edit)

    • getGraphModelListeners

      public GraphModelListener[] getGraphModelListeners()
      Return an array of all GraphModelListeners that were added to this model.

    • cloneCell

      public static Object cloneCell(GraphModel model, Object cell)
      Returns a deep clone of the specified cell, including all children.

    • cloneCell

      public static Object[] cloneCell(GraphModel model, Object[] cells)
      Returns a deep clone of the specified cells, including all children.

    • setSourcePort

      public static void setSourcePort(GraphModel model, Object edge, Object port)
      Helper methods that connects the source of edge to port in model.

    • setTargetPort

      public static void setTargetPort(GraphModel model, Object edge, Object port)
      Helper methods that connects the source of edge to port in model.

    • getSourceVertex

      public static Object getSourceVertex(GraphModel model, Object edge)
      Returns the source vertex of the edge by calling getParent on getSource on the specified model.

    • getTargetVertex

      public static Object getTargetVertex(GraphModel model, Object edge)
      Returns the target vertex of the edge by calling getParent on getTarget on the specified model.

    • getUserObject

      public static Object getUserObject(Object cell)
      Deprecated.
      Use GraphModel.getValue(Object) instead.
      Returns:
      Returns the user object of the given cell. This implementation checks if the cell is a default mutable tree node and returns it's user object.

    • isGroup

      public static boolean isGroup(GraphModel model, Object cell)
      Checks whether the cell has at least one child which is not a port. This implementation operates on the model, not taking into account visibility of cells. It returns true for groups regardless of their folded state.
      Parameters:
      cell - the cell to check for being a group
      Returns:
      Returns true if the cell contains at least one cell which is not a port

    • getAll

      public static Object[] getAll(GraphModel model)
      Returns all cells of the model in an array.
      Returns:
      Returns all cells in the model including all descandants.
      See Also:

    • getRoots

      public static Object[] getRoots(GraphModel model)
      Returns the roots of the specified model as an array. This implementation uses the GraphModel interface in the general case, but if the model is a DefaultGraphModel the performance can be improved to linear time.

    • getRootsAsCollection

      public static Collection getRootsAsCollection(GraphModel model)
      Returns the roots of the specified model as a collection. This implementation uses the GraphModel interface in the general case, but if the model is a DefaultGraphModel the performance can be improved to linear time.

    • getRoots

      public static Object[] getRoots(GraphModel model, Object[] cells)
      Returns the roots in cells by checking if their parent is null. This implementation only uses the GraphModel interface. This method never returns null.

    • getTopmostCells

      public static Object[] getTopmostCells(GraphModel model, Object[] cells)
      Returns:
      Returns the roots of cells, eg. an array that contains no cell having an ancestor in cells.

    • hasAncestorIn

      public static boolean hasAncestorIn(GraphModel model, Set parents, Object child)
      Returns true if the specified child has an ancestor in parents.

    • getDescendants

      public static List getDescendants(GraphModel model, Object[] cells)
      Flattens the given array of root cells by adding the roots and their descandants. The resulting set contains all cells, which means it contains branches and leafs. Note: This is an iterative implementation. No recursion used.
      Note: This returns a linked list, for frequent read operations you should turn this into an array, or at least an array list.

    • order

      public static Object[] order(GraphModel model, Object[] cells)
      Orders cells so that they reflect the model order.

    • getEdges

      public static Set getEdges(GraphModel model, Object[] cells)
      Returns the set of all connected edges to cells or their descendants. The passed-in cells are never returned as part of the result set. This can be used on vertices, edges and ports.

    • getOpposite

      public static Object getOpposite(GraphModel model, Object edge, Object cell)
      Returns:
      Returns the opposite port or vertex in edge.

    • containsEdgeBetween

      public static boolean containsEdgeBetween(GraphModel model, Object v1, Object v2)
      Returns true if the given vertices are conntected by a single edge in this document.

    • getEdgesBetween

      public static Object[] getEdgesBetween(GraphModel model, Object cell1, Object cell2, boolean directed)
      Returns the edges between two specified ports or two specified vertices. If directed is true then cell1 must be the source of the returned edges. This method never returns null. If there are no edges between the specified cells, then an array of length 0 is returned.

    • getOutgoingEdges

      public static Object[] getOutgoingEdges(GraphModel model, Object cell)
      Returns the outgoing edges for cell. Cell should be a port or a vertex.

    • getIncomingEdges

      public static Object[] getIncomingEdges(GraphModel model, Object cell)
      Returns the incoming edges for cell. Cell should be a port or a vertex.

    • getEdges

      public static Object[] getEdges(GraphModel model, Object cell, boolean incoming)
      Returns the incoming or outgoing edges for cell. Cell should be a port or a vertex.

    • isVertex

      public static boolean isVertex(GraphModel model, Object vertex)
      Returns true if vertex is a valid vertex.
      Returns:
      true if vertex is a valid vertex.

    • isRemoveEmptyGroups

      public boolean isRemoveEmptyGroups()
      Returns:
      the removeEmptyGroups

    • setRemoveEmptyGroups

      public void setRemoveEmptyGroups(boolean removeEmptyGroups)
      Parameters:
      removeEmptyGroups - the removeEmptyGroups to set