com.jgraph.graph
Interface GraphModel

All Known Implementing Classes:
DefaultGraphModel

public interface GraphModel

The interface that defines a suitable data model for a JGraph.


Method Summary
 boolean acceptsSource(java.lang.Object edge, java.lang.Object port)
          Returns true if port is a valid source for edge.
 boolean acceptsTarget(java.lang.Object edge, java.lang.Object port)
          Returns true if port is a valid target for edge.
 void addGraphModelListener(GraphModelListener l)
          Adds a listener for the GraphModelEvent posted after the model changes.
 void addUndoableEditListener(javax.swing.event.UndoableEditListener listener)
          Adds an undo listener for notification of any changes.
 boolean contains(java.lang.Object node)
          Returns true if node or one of its ancestors is in the model.
 java.util.Iterator edges(java.lang.Object port)
          Returns an iterator of the edges connected to port.
 void edit(ConnectionSet cs, java.util.Map propertyMap, ParentMap pm, javax.swing.undo.UndoableEdit[] e)
          Applies the propertyMap and the connection changes to the model.
 java.util.Map getAttributes(java.lang.Object node)
          Returns a Map that represents the properties for the specified cell.
 java.lang.Object getChild(java.lang.Object parent, int index)
          Returns the child of parent at index index in the parent's child array.
 int getChildCount(java.lang.Object parent)
          Returns the number of children of parent.
 int getIndexOfChild(java.lang.Object parent, java.lang.Object child)
          Returns the index of child in parent.
 int getIndexOfRoot(java.lang.Object root)
          Returns the index of root in the model.
 java.lang.Object getParent(java.lang.Object child)
          Returns the parent of child in the model.
 java.lang.Object getRootAt(int index)
          Returns the root at index index in the model.
 int getRootCount()
          Returns the number of roots in the model.
 java.lang.Object getSource(java.lang.Object edge)
          Returns the source of edge.
 java.lang.Object getTarget(java.lang.Object edge)
          Returns the target of edge.
 void insert(java.lang.Object[] roots, ConnectionSet cs, ParentMap pm, java.util.Map attributeMap)
          Inserts the cells and connections into the model, and passes attributeMap to the views.
 boolean isAttributeStore()
          Returns true if the model stores all attributes.
 boolean isLeaf(java.lang.Object node)
          Returns whether the specified node is a leaf node.
 boolean isOrdered()
          Returns true if the model order should be used.
 void remove(java.lang.Object[] roots)
          Removes cells from the model.
 void removeGraphModelListener(GraphModelListener l)
          Removes a listener previously added with addGraphModelListener().
 void removeUndoableEditListener(javax.swing.event.UndoableEditListener listener)
          Removes an undo listener.
 void toBack(java.lang.Object[] cells)
          Sends cells to back.
 void toFront(java.lang.Object[] cells)
          Brings cells to front.
 

Method Detail

getRootCount

public int getRootCount()
Returns the number of roots in the model. Returns 0 if the model is empty.

Returns:
the number of roots in the model

getRootAt

public java.lang.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()).

Returns:
the root of at index index

getIndexOfRoot

public int getIndexOfRoot(java.lang.Object root)
Returns the index of root in the model. If root is null, returns -1.

Returns:
the index of the root in the model, or -1 if the parent is null

contains

public boolean contains(java.lang.Object node)
Returns true if node or one of its ancestors is in the model.

Returns:
true if node is in the model

isAttributeStore

public boolean isAttributeStore()
Returns true if the model stores all attributes. Otherwise, the view attributes and model properties are stored in separate places, allowing a cell to have multiple attribute sets among different views ("view-dependent" attributes).

Returns:
true if the model handles attributes.

getAttributes

public java.util.Map getAttributes(java.lang.Object node)
Returns a Map that represents the properties for the specified cell. This properties have precedence over each view's attributes, regardless of isAttributeStore.

Returns:
properties of node as a Map

toBack

public void toBack(java.lang.Object[] cells)
Sends cells to back.


toFront

public void toFront(java.lang.Object[] cells)
Brings cells to front.


isOrdered

public boolean isOrdered()
Returns true if the model order should be used. Typically, this returns the value of isAttributeStore.


getSource

public java.lang.Object getSource(java.lang.Object edge)
Returns the source of edge. edge must be an object previously obtained from this data source.

Returns:
Object that represents the source of edge

getTarget

public java.lang.Object getTarget(java.lang.Object edge)
Returns the target of edge. edge must be an object previously obtained from this data source.

Returns:
Object that represents the target of edge

acceptsSource

public boolean acceptsSource(java.lang.Object edge,
                             java.lang.Object port)
Returns true if port is a valid source for edge. edge and port must be objects previously obtained from this data source.

Returns:
true if port is a valid source for edge.

acceptsTarget

public boolean acceptsTarget(java.lang.Object edge,
                             java.lang.Object port)
Returns true if port is a valid target for edge. edge and port must be objects previously obtained from this data source.

Returns:
true if port is a valid target for edge.

edges

public java.util.Iterator edges(java.lang.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.

Parameters:
port - a port in the graph, obtained from this data source
Returns:
Iterator that represents the connected edges

getParent

public java.lang.Object getParent(java.lang.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.

Parameters:
child - a node in the graph, obtained from this data source
Returns:
the parent of child

getIndexOfChild

public int getIndexOfChild(java.lang.Object parent,
                           java.lang.Object child)
Returns the index of child in parent. If either the parent or child is null, returns -1.

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 java.lang.Object getChild(java.lang.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)).

Parameters:
parent - a node in the tree, obtained from this data source
Returns:
the child of parent at index index

getChildCount

public int getChildCount(java.lang.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.

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(java.lang.Object node)
Returns whether the specified node is a leaf node. The way the test is performed depends on the askAllowsChildren setting.

Parameters:
node - the node to check
Returns:
true if the node is a leaf node

insert

public void insert(java.lang.Object[] roots,
                   ConnectionSet cs,
                   ParentMap pm,
                   java.util.Map attributeMap)
Inserts the cells and connections into the model, and passes attributeMap to the views. Notifies the model- and undo listeners of the change.


remove

public void remove(java.lang.Object[] roots)
Removes cells from the model. If removeChildren is true, the children are also removed. Notifies the model- and undo listeners of the change.


edit

public void edit(ConnectionSet cs,
                 java.util.Map propertyMap,
                 ParentMap pm,
                 javax.swing.undo.UndoableEdit[] e)
Applies the propertyMap and the connection changes to the model. The initial edits that triggered the call are considered to be part of this transaction. Notifies the model- and undo listeners of the change. Note: If only edits is non-null, the edits are directly passed to the UndoableEditListeners.


addGraphModelListener

public void addGraphModelListener(GraphModelListener l)
Adds a listener for the GraphModelEvent posted after the model changes.


removeGraphModelListener

public void removeGraphModelListener(GraphModelListener l)
Removes a listener previously added with addGraphModelListener().


addUndoableEditListener

public void addUndoableEditListener(javax.swing.event.UndoableEditListener listener)
Adds an undo listener for notification of any changes. Undo/Redo operations performed on the UndoableEdit will cause the appropriate ModelEvent to be fired to keep the view(s) in sync with the model.


removeUndoableEditListener

public void removeUndoableEditListener(javax.swing.event.UndoableEditListener listener)
Removes an undo listener.