Gephi Toolkit Javadoc

org.gephi.graph.api
Interface HierarchicalDirectedGraph

All Superinterfaces:
Attributable, DirectedGraph, Graph, HierarchicalGraph

public interface HierarchicalDirectedGraph
extends HierarchicalGraph, DirectedGraph

Hierarchical directed graph.

Author:
Mathieu Bastian
See Also:
GraphModel

Method Summary
 EdgeIterable getInEdgesAndMetaInEdges(Node node)
          Returns incoming edges and meta edges incident to node.
 MetaEdge getMetaEdge(Node source, Node target)
          Finds and returns a meta-edge that connects source and target.
 int getMetaInDegree(Node node)
          Returns the number of node's incoming meta edges.
 EdgeIterable getMetaInEdges(Node node)
          Returns incoming meta edges incident to node.
 int getMetaOutDegree(Node node)
          Returns the number of node's outgoing meta edges.
 EdgeIterable getMetaOutEdges(Node node)
          Returns outgoing meta edges incident to node.
 EdgeIterable getOutEdgesAndMetaOutEdges(Node node)
          Returns outgoing edges and meta edges incident to node.
 int getTotalInDegree(Node node)
          Returns the sum of the in-degree for edges and meta-edge.
 int getTotalOutDegree(Node node)
          Returns the sum of the out-degree for edges and meta-edge.
 
Methods inherited from interface org.gephi.graph.api.HierarchicalGraph
addNode, clearMetaEdges, expand, flatten, getChildren, getChildrenCount, getDescendant, getDescendantCount, getEdgesAndMetaEdges, getEdgesAndMetaEdges, getEdgesTree, getHeight, getHierarchyEdges, getInnerEdges, getLevel, getLevelSize, getMetaDegree, getMetaEdges, getMetaEdges, getNodes, getNodesTree, getOuterEdges, getParent, getTopNodes, getTotalDegree, getTotalEdgeCount, groupNodes, isAncestor, isDescendant, isFollowing, isInView, isParent, isPreceding, moveToGroup, removeFromGroup, removeMetaEdge, resetViewToLeaves, resetViewToLevel, resetViewToTopNodes, retract, ungroupNodes, wrapToTreeNode
 
Methods inherited from interface org.gephi.graph.api.DirectedGraph
addEdge, getEdge, getInDegree, getInEdges, getMutualDegree, getOutDegree, getOutEdges, getPredecessors, getSuccessors, isPredecessor, isSuccessor
 
Methods inherited from interface org.gephi.graph.api.Graph
addEdge, addNode, clear, clearEdges, clearEdges, contains, contains, getDegree, getEdge, getEdge, getEdgeCount, getEdges, getEdges, getEdgeVersion, getGraphModel, getNeighbors, getNode, getNode, getNodeCount, getNodes, getNodeVersion, getOpposite, getView, isAdjacent, isAdjacent, isDirected, isSelfLoop, readLock, readUnlock, readUnlockAll, removeEdge, removeNode, setId, setId, writeLock, writeUnlock
 
Methods inherited from interface org.gephi.graph.api.Attributable
getAttributes
 

Method Detail

getMetaInEdges

EdgeIterable getMetaInEdges(Node node)
Returns incoming meta edges incident to node.

Parameters:
node - the node whose incoming meta edges are to be returned
Returns:
an edge iterable of node's incoming meta edges
Throws:
java.lang.IllegalArgumentException - if node is null or not legal in the graph

getInEdgesAndMetaInEdges

EdgeIterable getInEdgesAndMetaInEdges(Node node)
Returns incoming edges and meta edges incident to node.

Parameters:
node - the node whose incoming edges and meta edges are to be returned
Returns:
an edge iterable of node's incoming edges and meta edges
Throws:
java.lang.IllegalArgumentException - if node is null or not legal in the graph

getMetaOutEdges

EdgeIterable getMetaOutEdges(Node node)
Returns outgoing meta edges incident to node.

Parameters:
node - the node whose outgoing meta edges are to be returned
Returns:
an edge iterable of node's outgoing meta edges
Throws:
java.lang.IllegalArgumentException - if node is null or not legal in the graph

getOutEdgesAndMetaOutEdges

EdgeIterable getOutEdgesAndMetaOutEdges(Node node)
Returns outgoing edges and meta edges incident to node.

Parameters:
node - the node whose outgoing edges and meta edges are to be returned
Returns:
an edge iterable of node's outgoing edges and meta edges
Throws:
java.lang.IllegalArgumentException - if node is null or not legal in the graph

getMetaInDegree

int getMetaInDegree(Node node)
Returns the number of node's incoming meta edges.

Warning: This method is not thread safe, be sure to call it in a locked statement.

Parameters:
node - the node whose meta in-degree is queried
Returns:
the number of meta edges incoming to node
Throws:
java.lang.IllegalArgumentException - if node is null or not legal in the graph.

getTotalInDegree

int getTotalInDegree(Node node)
Returns the sum of the in-degree for edges and meta-edge. Equivalent to getInDegree(Node) + getMetaInDegree(Node).

Warning: This method is not thread safe, be sure to call it in a locked statement.

Parameters:
node - the node whose total in-degree is queried
Returns:
the number of edges and meta edges incoming to node
Throws:
java.lang.IllegalArgumentException - if node is null or not legal in the graph.

getTotalOutDegree

int getTotalOutDegree(Node node)
Returns the sum of the out-degree for edges and meta-edge. Equivalent to getOutDegree(Node) + getMetaOutDegree(Node).

Warning: This method is not thread safe, be sure to call it in a locked statement.

Parameters:
node - the node whose total out-degree is queried
Returns:
the number of edges and meta edges outgoing from node
Throws:
java.lang.IllegalArgumentException - if node is null or not legal in the graph.

getMetaOutDegree

int getMetaOutDegree(Node node)
Returns the number of node's outgoing meta edges.

Warning: This method is not thread safe, be sure to call it in a locked statement.

Parameters:
node - the node whose meta out-degree is queried
Returns:
the number of meta edges outgoing from node
Throws:
java.lang.IllegalArgumentException - if node is null or not legal in the graph.

getMetaEdge

MetaEdge getMetaEdge(Node source,
                     Node target)
Finds and returns a meta-edge that connects source and target. Returns null if no such meta-edge is found.

Warning: This method is not thread safe, be sure to call it in a locked statement.

Specified by:
getMetaEdge in interface HierarchicalGraph
Parameters:
source - the first incident node of the queried edge
target - thge second incident node of the queried edge
Returns:
an edge that connects source and target or null if no such edge exists
Throws:
java.lang.IllegalArgumentException - if source or target are null or not legal nodes in the graph

Gephi Toolkit Javadoc