prefuse.data
Interface Node

All Superinterfaces:
Tuple
All Known Subinterfaces:
NodeItem
All Known Implementing Classes:
TableNode, TableNodeItem

public interface Node
extends Tuple

Tuple sub-interface that represents a node in a graph or tree structure. This interface supports both graph and tree methods, tree methods invoked on a node in a general graph typically default to operations on the graph's generated spanning tree.

Author:
jeffrey heer

Method Summary
 java.util.Iterator childEdges()
          Get an iterator over the edges from this node to its tree children.
 java.util.Iterator children()
          Get an iterator over this node's tree children.
 java.util.Iterator edges()
          Get an iterator over all incident edges, those for which this node is either the source or the target.
 Node getChild(int idx)
          Get the tree child node at the given index.
 int getChildCount()
          Get the number of tree children of this node.
 int getChildIndex(Node child)
          Get the ordering index of the give node child in a tree structure.
 int getDegree()
          Get the degree of the node, the number of edges for which this node is either the source or the target.
 int getDepth()
          Get the tree depth of this node.
 Node getFirstChild()
          Get this node's first tree child.
 Graph getGraph()
          Get the Graph of which this Node is a member.
 int getInDegree()
          Get the in-degree of the node, the number of edges for which this node is the target.
 Node getLastChild()
          Get this node's last tree child.
 Node getNextSibling()
          Get this node's next tree sibling.
 int getOutDegree()
          Get the out-degree of the node, the number of edges for which this node is the source.
 Node getParent()
          Get the parent node of this node in a tree structure.
 Edge getParentEdge()
          Get the edge between this node and its parent node in a tree structure.
 Node getPreviousSibling()
          Get this node's previous tree sibling.
 java.util.Iterator inEdges()
          Get an iterator over all incoming edges, those for which this node is the target.
 java.util.Iterator inNeighbors()
          Get an iterator over all adjacent nodes connected to this node by an incoming edge (i.e., all nodes that "point" at this one).
 java.util.Iterator neighbors()
          Get an iterator over all nodes connected to this node.
 java.util.Iterator outEdges()
          Get an iterator over all outgoing edges, those for which this node is the source.
 java.util.Iterator outNeighbors()
          Get an iterator over all adjacent nodes connected to this node by an outgoing edge (i.e., all nodes "pointed" to by this one).
 
Methods inherited from interface prefuse.data.Tuple
canGet, canGetBoolean, canGetDate, canGetDouble, canGetFloat, canGetInt, canGetLong, canGetString, canSet, canSetBoolean, canSetDate, canSetDouble, canSetFloat, canSetInt, canSetLong, canSetString, get, get, getBoolean, getBoolean, getColumnCount, getColumnIndex, getColumnName, getColumnType, getColumnType, getDate, getDate, getDefault, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getRow, getSchema, getString, getString, getTable, isValid, revertToDefault, set, set, setBoolean, setBoolean, setDate, setDate, setDouble, setDouble, setFloat, setFloat, setInt, setInt, setLong, setLong, setString, setString
 

Method Detail

getGraph

Graph getGraph()
Get the Graph of which this Node is a member.

Returns:
the backing Graph.

getInDegree

int getInDegree()
Get the in-degree of the node, the number of edges for which this node is the target.

Returns:
the in-degree of the node

getOutDegree

int getOutDegree()
Get the out-degree of the node, the number of edges for which this node is the source.

Returns:
the out-degree of the node

getDegree

int getDegree()
Get the degree of the node, the number of edges for which this node is either the source or the target.

Returns:
the total degree of the node

inEdges

java.util.Iterator inEdges()
Get an iterator over all incoming edges, those for which this node is the target.

Returns:
an Iterator over all incoming edges

outEdges

java.util.Iterator outEdges()
Get an iterator over all outgoing edges, those for which this node is the source.

Returns:
an Iterator over all outgoing edges

edges

java.util.Iterator edges()
Get an iterator over all incident edges, those for which this node is either the source or the target.

Returns:
an Iterator over all incident edges

inNeighbors

java.util.Iterator inNeighbors()
Get an iterator over all adjacent nodes connected to this node by an incoming edge (i.e., all nodes that "point" at this one).

Returns:
an Iterator over all neighbors with in-links on this node

outNeighbors

java.util.Iterator outNeighbors()
Get an iterator over all adjacent nodes connected to this node by an outgoing edge (i.e., all nodes "pointed" to by this one).

Returns:
an Iterator over all neighbors with out-links from this node

neighbors

java.util.Iterator neighbors()
Get an iterator over all nodes connected to this node.

Returns:
an Iterator over all neighbors of this node

getParent

Node getParent()
Get the parent node of this node in a tree structure.

Returns:
this node's parent node, or null if there is none.

getParentEdge

Edge getParentEdge()
Get the edge between this node and its parent node in a tree structure.

Returns:
the edge between this node and its parent

getDepth

int getDepth()
Get the tree depth of this node.

Returns:
the tree depth of this node. The root's tree depth is zero, and each level of the tree is one depth level greater.

getChildCount

int getChildCount()
Get the number of tree children of this node.

Returns:
the number of child nodes

getChildIndex

int getChildIndex(Node child)
Get the ordering index of the give node child in a tree structure.

Parameters:
child - the child node to look up
Returns:
the index of the child node, or -1 if the node is not a child of this one.

getChild

Node getChild(int idx)
Get the tree child node at the given index.

Parameters:
idx - the ordering index
Returns:
the child node at the given index

getFirstChild

Node getFirstChild()
Get this node's first tree child. This is the same as looking up the node at index 0.

Returns:
this node's first child node

getLastChild

Node getLastChild()
Get this node's last tree child. This is the same as looking up the node at the child count minus 1.

Returns:
this node's last child node

getPreviousSibling

Node getPreviousSibling()
Get this node's previous tree sibling.

Returns:
the previous sibling, or null if none

getNextSibling

Node getNextSibling()
Get this node's next tree sibling.

Returns:
the next sibling, or null if none

children

java.util.Iterator children()
Get an iterator over this node's tree children.

Returns:
an iterator over this node's children

childEdges

java.util.Iterator childEdges()
Get an iterator over the edges from this node to its tree children.

Returns:
an iterator over the edges to the child nodes


Copyright 2007 Regents of the University of California