

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
Method Summary  
boolean 
addEdgeMetaChild(int parent_index,
int child_edge_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
addMetaChild(Node parent,
Edge child)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
addMetaChild(Node parent,
Node child)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
addNodeMetaChild(int parent_index,
int child_node_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
containsEdge(Edge edge)
Return true if the given Edge is in this RootGraph. 
boolean 
containsNode(Node node)
Return true if the given Node is in this RootGraph. 
int 
createEdge(int source_index,
int target_index)
Create a directed Edge from the Node with the given source_index to the Node with the given target_index, and return the new Edge's index. 
int 
createEdge(int source_index,
int target_index,
boolean directed)
Create an Edge from the Node with the given source_index to the Node with the given target_index, and return the new Edge's index. 
int 
createEdge(Node source,
Node target)
Create a directed Edge from the given source Node to the given target Node, and return its index. 
int 
createEdge(Node source,
Node target,
boolean directed)
Create an Edge from the given source Node to the given target Node, and return its index. 
int[] 
createEdges(int[] source_indices,
int[] target_indices,
boolean directed)
Deprecated. Use createEdge(int, int, boolean) instead. 
GraphPerspective 
createGraphPerspective(int[] node_indices,
int[] edge_indices)
Create a new GraphPerspective with just the given Nodes and Edges (and all Nodes incident on the given Edges). 
GraphPerspective 
createGraphPerspective(Node[] nodes,
Edge[] edges)
Create a new GraphPerspective with just the given Nodes and Edges (and all Nodes incident on the given Edges). 
int 
createNode()
Create a new Node in this RootGraph, and return its index. 
int 
createNode(GraphPerspective perspective)
Create a new Node in this RootGraph, and return its index. 
int 
createNode(int[] node_indices,
int[] edge_indices)
Create a new Node in this RootGraph, and return its index. 
int 
createNode(Node[] nodes,
Edge[] edges)
Create a new Node in this RootGraph, and return its index. 
int[] 
createNodes(int new_node_count)
Deprecated. Use createNode() instead. 
boolean 
edgeExists(int from_node_index,
int to_node_index)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead; if you decide to use this method anyways: this method returns true if and only if either 1) there exists a directed edge E in this RootGraph such that from_node_index is E's source node's index and to_node_index is E's target node's index or 2) there exists an undirected edge E in this RootGraph such that E's endpoint nodes have indices from_node_index and to_node_index. 
boolean 
edgeExists(Node from,
Node to)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead; if you decide to use this method anyways: this method returns true if and only if either 1) there exists a directed edge E in this RootGraph such that the from node specified is E's source node and the target node specified is E's target node or 2) there exists an undirected edge E in this RootGraph such that E's endpoints are the from and to nodes specified. 
java.util.List 
edgeMetaChildrenList(int node_index)
Deprecated. Use getEdgeMetaChildIndicesArray(int) instead. 
java.util.List 
edgeMetaChildrenList(Node node)
Deprecated. Use getEdgeMetaChildIndicesArray(int) instead. 
java.util.List 
edgeMetaParentsList(int edge_index)
Deprecated. Use getEdgeMetaParentIndicesArray(int) instead. 
java.util.Iterator 
edgesIterator()
Returns an Iterator over all giny.model.Edge objects in this RootGraph. 
java.util.List 
edgesList()
Deprecated. Use edgesIterator() instead. 
java.util.List 
edgesList(int from_node_index,
int to_node_index,
boolean include_undirected_edges)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead. 
java.util.List 
edgesList(Node from,
Node to)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead. 
void 
ensureCapacity(int nodes,
int edges)
Deprecated. Please don't call this silly method; implementors: I suggest creating an easter egg and having it take effect when this method is called. 
int[] 
getAdjacentEdgeIndicesArray(int node_index,
boolean undirected_edges,
boolean incoming_directed_edges,
boolean outgoing_directed_edges)
Returns indices of all edges adjacent to the node at specified index. 
int[] 
getChildlessMetaDescendants(int node_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
int[] 
getConnectingEdgeIndicesArray(int[] node_indices)
This will return an array of edge indices that are the edges between nodes. 
int[] 
getConnectingNodeIndicesArray(int[] edge_indices)
Deprecated. Use getEdgeSourceIndex(int) and getEdgeTargetIndex(int) instead, or use createGraphPerspective(int[], int[]). 
int 
getDegree(int node_index)
Return the number of distinct Edges incident on the Node with the given index. 
int 
getDegree(Node node)
Return the number of distinct Edges incident on the given Node. 
Edge 
getEdge(int edge_index)
Return the Edge with the given index in this RootGraph. 
int 
getEdgeCount()
Returns number of edges in this RootGraph. 
int 
getEdgeCount(int from_node_index,
int to_node_index,
boolean count_undirected_edges)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead. 
int 
getEdgeCount(Node from,
Node to,
boolean count_undirected_edges)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead. 
int[] 
getEdgeIndicesArray()
Deprecated. Use edgesIterator() together with Edge.getRootGraphIndex(). 
int[] 
getEdgeIndicesArray(int from_node_index,
int to_node_index,
boolean include_undirected_edges)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead. 
int[] 
getEdgeIndicesArray(int from_node_index,
int to_node_index,
boolean include_undirected_edges,
boolean include_both_directions)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead. 
int[] 
getEdgeMetaChildIndicesArray(int node_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
int[] 
getEdgeMetaParentIndicesArray(int edge_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
int 
getEdgeSourceIndex(int edge_index)
Retrieve the index of the Node that is the source of the Edge with the given index. 
int 
getEdgeTargetIndex(int edge_index)
Retrieve the index of the Node that is the target of the Edge with the given index. 
int 
getInDegree(int node_index)
Return the number of Edges e such that e.getTarget().equals( node ). 
int 
getInDegree(int node_index,
boolean count_undirected_edges)
Return the number of Edges e such that e.getSource().equals( node ). 
int 
getInDegree(Node node)
Return the number of Edges e such that e.getTarget().equals( node ). 
int 
getInDegree(Node node,
boolean count_undirected_edges)
Return the number of Edges e such that e.getSource().equals( node ). 
int 
getIndex(Edge edge)
Return the index of the given Edge. 
int 
getIndex(Node node)
Return the index of the given Node. 
Node 
getNode(int node_index)
Return the Node with the given index in this RootGraph. 
int 
getNodeCount()
Returns number of nodes in this RootGraph. 
int[] 
getNodeIndicesArray()
Deprecated. Use nodesIterator() together with Node.getRootGraphIndex(). 
int[] 
getNodeMetaChildIndicesArray(int node_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
int[] 
getNodeMetaChildIndicesArray(int node_index,
boolean recursive)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
int[] 
getNodeMetaParentIndicesArray(int node_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
int 
getOutDegree(int node_index)
Return the number of Edges esuch that e.getSource().equals( node ). 
int 
getOutDegree(int node_index,
boolean count_undirected_edges)
Return the number of Edges e such that e.getSource().equals( node ). 
int 
getOutDegree(Node node)
Return the number of Edges e such that e.getSource().equals( node ). 
int 
getOutDegree(Node node,
boolean count_undirected_edges)
Return the number of Edges e such that e.getSource().equals( node ). 
boolean 
isEdgeDirected(int edge_index)
Retrieve the directedness of the Edge with the given index. 
boolean 
isEdgeMetaChild(int parent_index,
int child_edge_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
isEdgeMetaParent(int child_edge_index,
int parent_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
isMetaChild(Node parent,
Edge child)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
isMetaChild(Node parent,
Node child)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
isMetaParent(Edge child,
Node parent)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
isMetaParent(Node child,
Node parent)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
isNeighbor(int a_node_index,
int another_node_index)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead; if you decide to use this method anyways, please note that the definition of "node neighbor" is such: Node A is a "node neighbor" of node B if and only if there exists an edge [directed or undirected] E such that A is E's target and B is E's source, or A is E's source and B is E's target; this method then returns true if and only if node at index a_node_index is a "node neighbor" of node at index another_node_index in this RootGraph. 
boolean 
isNeighbor(Node a_node,
Node another_node)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead; if you decide to use this method anyways, please note that the definition of "node neighbor" is such: Node A is a "node neighbor" of node B if and only if there exists an edge [directed or undirected] E such that A is E's target and B is E's source, or A is E's source and B is E's target; this method then returns true if and only if a_node is a "node neighbor" of another_node in this RootGraph. 
boolean 
isNodeMetaChild(int parent_index,
int child_node_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
isNodeMetaChild(int parent_index,
int child_node_index,
boolean recursive)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
boolean 
isNodeMetaParent(int child_node_index,
int parent_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
java.util.List 
metaParentsList(Edge edge)
Deprecated. Use getEdgeMetaParentIndicesArray(int) instead. 
java.util.List 
metaParentsList(Node node)
Deprecated. Use getNodeMetaParentIndicesArray(int) instead. 
java.util.List 
neighborsList(Node node)
Deprecated. Use getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean) instead; if you decide to use this method anyways, please note that the definition of "node neighbor" is such: Node A is a "node neighbor" of node B if and only if there exists an edge [directed or undirected] E such that A is E's target and B is E's source, or A is E's source and B is E's target; this method then returns a nonrepeating list of all nodes N in this RootGraph such that N is a "node neighbor" of node, the input parameter. 
java.util.List 
nodeMetaChildrenList(int parent_index)
Nodes and Edges comprise an additional directed graph through the containsa relationship, in which a MetaParent Node contains each of its MetaChild Nodes and Edges. 
java.util.List 
nodeMetaChildrenList(Node node)
Deprecated. Use getNodeMetaChildIndicesArray(int) instead. 
java.util.List 
nodeMetaParentsList(int node_index)
Deprecated. Use getNodeMetaParentIndicesArray(int) instead. 
java.util.Iterator 
nodesIterator()
Returns an Iterator over all giny.model.Node objects in this RootGraph. 
java.util.List 
nodesList()
Deprecated. Use nodesIterator() instead. 
Edge 
removeEdge(Edge edge)
Remove the given Edge from this RootGraph and all of its GraphPerspectives. 
int 
removeEdge(int edge_index)
Remove the Edge with the given index from this RootGraph and all of its GraphPerspectives. 
boolean 
removeEdgeMetaChild(int parent_index,
int child_edge_index)

int[] 
removeEdges(int[] edge_indices)
Deprecated. Use removeEdge(int) instead. 
java.util.List 
removeEdges(java.util.List edges)
Deprecated. Use removeEdge(Edge) or removeEdges(int[]) instead. 
int 
removeNode(int node_index)
Remove the Node with the given index (and all of that Node's incident Edges) from this RootGraph and all of its GraphPerspectives. 
Node 
removeNode(Node node)
Remove the given Node and all Edges incident on it from this RootGraph and all of its GraphPerspectives. 
boolean 
removeNodeMetaChild(int parent_index,
int child_node_index)

int[] 
removeNodes(int[] node_indices)
Deprecated. Use removeNode(int) instead. 
java.util.List 
removeNodes(java.util.List nodes)
Deprecated. Use removeNode(Node) or removeNodes(int[]) instead. 
Method Detail 
public GraphPerspective createGraphPerspective(Node[] nodes, Edge[] edges)
TECHNICAL DETAIL: Each Node in the Node array input parameter should be a Node that was previously returned by a method of this RootGraph or by a method of another component that this RootGraph system defines. Likewise, each Edge in the Edge array input parameter should be an Edge that was previously returned by a method of this RootGraph or by a method of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
nodes
 A [possibly null] array of Nodes in this RootGraph to include in the new
GraphPerspectiveedges
 A [possibly null] array of Edges in this RootGraph to include in the new
GraphPerspective
public GraphPerspective createGraphPerspective(int[] node_indices, int[] edge_indices)
node_indices
 A [possibly null] array of indices of Nodes in this RootGraph to
include in the new GraphPerspectiveedge_indices
 A [possibly null] array of indices of Edges in this RootGraph to
include in the new GraphPerspective
public void ensureCapacity(int nodes, int edges)
public int getNodeCount()
public int getEdgeCount()
public java.util.Iterator nodesIterator()
TECHNICAL DETAIL: Iterating over the set of all nodes in a RootGraph and manipulating a RootGraph's topology (by calling removeXXX() and createXXX() methods) concurrently will have undefined effects on the returned Iterator.
public java.util.List nodesList()
nodesIterator()
public int[] getNodeIndicesArray()
nodesIterator()
,
Node.getRootGraphIndex()
public java.util.Iterator edgesIterator()
TECHNICAL DETAIL: Iterating over the set of all edges in a RootGraph and manipulating a RootGraph's topology (by calling removeXXX() and createXXX() methods) concurrently will have undefined effects on the returned Iterator.
public java.util.List edgesList()
edgesIterator()
public int[] getEdgeIndicesArray()
edgesIterator()
,
Edge.getRootGraphIndex()
public Node removeNode(Node node)
TECHNICAL DETAIL: The Node input parameter should be a Node that was previously returned by a method of this RootGraph or by a method of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
IMPORTANT! The returned Node object, if not null, should not be used to query fields by calling methods on that returned Node object  the returned Node's behavior is completely undefined. For example, an implementation of RootGraph may choose to return a Node object whose getRootGraphIndex() method returns a positive value. The purpose of the return value of this method is purely to mark "success" or "not success"  in fact, if this API were redesigned, the return value of this operation would become a boolean value.
node
 The Node to remove.
public int removeNode(int node_index)
node_index
 The index in this RootGraph of the Node to remove.
public java.util.List removeNodes(java.util.List nodes)
removeNode(Node)
,
removeNodes(int[])
public int[] removeNodes(int[] node_indices)
node_indices
 An nonnull array of the indices in this RootGraph of the
Nodes to remove.
removeNode(int)
public int createNode()
public int createNode(Node[] nodes, Edge[] edges)
TECHNICAL DETAIL: The Node and Edge input parameters should be objects that were previously returned by methods of this RootGraph or by methods of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
nodes
 a [possibly null] array of Nodes that will be MetaChildren of
the newly created Node.edges
 a [possibly null] array of Edges that will be MetaChildren of
the newly created Node.
public int createNode(GraphPerspective perspective)
TECHNICAL DETAIL: The GraphPerspective input parameter should be an object that was previously returned by this RootGraph or by a method of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
perspective
 a [possibly null] GraphPerspective of this RootGraph,
containing the Nodes and Edges that will be MetaChildren of the newly created
Node.
public int createNode(int[] node_indices, int[] edge_indices)
node_indices
 a [possibly null] array of the indices in this
RootGraph of the Nodes that will be MetaChildren of the newly created Node.edge_indices
 a [possibly null] array of the indices in this
RootGraph of the Edges that will be MetaChildren of the newly created Node.
public int[] createNodes(int new_node_count)
new_node_count
 the number of new nodes to create.
createNode()
public Edge removeEdge(Edge edge)
TECHNICAL DETAIL: The Edge input parameter should be an Edge that was previously returned by a method of this RootGraph or by a method of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
IMPORTANT! The returned Edge object, if not null, should not be used to query fields by calling methods on that returned Edge object  the returned Edge's behavior is completely undefined. For example, an implementation of RootGraph may choose to return an Edge object whose getRootIndex() methods returns a positive value. The purpose of the return value of this method is purely to mark "success" or "not success"  in fact, if this API were redesigned, the return value of this operation would become a boolean value.
edge
 The Edge to remove.
public int removeEdge(int edge_index)
edge_index
 The index in this RootGraph of the Edge to remove.
public java.util.List removeEdges(java.util.List edges)
removeEdge(Edge)
,
removeEdges(int[])
public int[] removeEdges(int[] edge_indices)
edge_indices
 A nonnull array of the indices in this RootGraph of the
Edges to remove.
removeEdge(int)
public int createEdge(Node source, Node target)
TECHNICAL DETAIL: Each of the two Node input parameters should be a Node that was previously returned by a method of this RootGraph or by a method of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
source
 the source of the new directed Edgetarget
 the target of the new directed Edge
public int createEdge(Node source, Node target, boolean directed)
TECHNICAL DETAIL: Each of the two Node input parameters should be a Node that was previously returned by a method of this RootGraph or by a method of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
source
 the source of the new Edgetarget
 the target of the new Edgedirected
 The new Edge will be directed iff this argument is true.
public int createEdge(int source_index, int target_index)
source_index
 the index in this RootGraph of the source of the new
directed Edgetarget_index
 the index in this RootGraph of the target of the new
directed Edge
public int createEdge(int source_index, int target_index, boolean directed)
source_index
 the index in this RootGraph of the source of the new
Edgetarget_index
 the index in this RootGraph of the target of the new
Edgedirected
 The new Edge will be directed iff this argument is true.
public int[] createEdges(int[] source_indices, int[] target_indices, boolean directed)
If returnArr represents the int[] that is returned by this method, then returnArr[i] defines the index of newly created edge whose source node index is source_indices[i] and whose target node index is target_indices[i].
source_indices
 a nonnull array of the indices of the source Nodes for the
new Edges.target_indices
 a nonnull array of length source_indices.length of
the indices of the target Nodes for the new Edges.directed
 The new Edges will be directed iff this argument is true.
createEdge(int, int, boolean)
public boolean containsNode(Node node)
TECHNICAL DETAIL: The Node input parameter should be an object that was previously returned by a method of this RootGraph or by a method of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
public boolean containsEdge(Edge edge)
TECHNICAL DETAIL: The Edge input parameter should be an object that was previously returned by a method of this RootGraph or by a method of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
public java.util.List neighborsList(Node node)
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public boolean isNeighbor(Node a_node, Node another_node)
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public boolean isNeighbor(int a_node_index, int another_node_index)
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public boolean edgeExists(Node from, Node to)
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public boolean edgeExists(int from_node_index, int to_node_index)
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public int getEdgeCount(Node from, Node to, boolean count_undirected_edges)
from
 the Node that is the source of the edges to be counted.to
 the Node that is the target of the edges to be counted.count_undirected_edges
 Undirected edges will be included in the
count iff count_undirected_edges is true.
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public int getEdgeCount(int from_node_index, int to_node_index, boolean count_undirected_edges)
from_node_index
 the index of the Node to count edges from.to_node_index
 the index of the Node to find edges to.count_undirected_edges
 Undirected edges will be included in the
count iff count_undirected_edges is true.
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public int[] getAdjacentEdgeIndicesArray(int node_index, boolean undirected_edges, boolean incoming_directed_edges, boolean outgoing_directed_edges)
node_index
 the index of the node whose adjacent edge
information we're seeking.undirected_edges
 edge indices of all adjacent
undirected edges are included in the return value of this
method if this value is true, otherwise not a single
index corresponding to an undirected edge is returned;
undirected edge E is an adjacent undirected edge to node N
[definition:] if and only if E's source is N or E's target
is N.incoming_directed_edges
 edge indices of all incoming
directed edges are included in the return value of this
method if this value is true, otherwise not a single index
corresponding to an incoming directed edge is returned;
directed edge E is an incoming directed edge to node N
[definition:] if and only if N is E's target.outgoing_directed_edges
 edge indices of all outgoing
directed edges are included in the return value of this
method if this value is true, otherwise not a single index
corresponding to an outgoing directed edge is returned;
directed edge E is an outgoing directed edge from node N
[definition:] if and only if N is E's source.
public int[] getConnectingEdgeIndicesArray(int[] node_indices)
public int[] getConnectingNodeIndicesArray(int[] edge_indices)
getEdgeSourceIndex(int)
,
getEdgeTargetIndex(int)
,
createGraphPerspective(int[], int[])
public int[] getEdgeIndicesArray(int from_node_index, int to_node_index, boolean include_undirected_edges, boolean include_both_directions)
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public java.util.List edgesList(Node from, Node to)
from
 the Node that is the source of the Edges to be returned.to
 the Node that is the target of the Edges to be returned.
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public java.util.List edgesList(int from_node_index, int to_node_index, boolean include_undirected_edges)
from_node_index
 the index of the Node to return edges from.to_node_index
 the index of the Node to return edges to.include_undirected_edges
 Undirected edges will be included in the
List iff include_undirected_edges is true.
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public int[] getEdgeIndicesArray(int from_node_index, int to_node_index, boolean include_undirected_edges)
from_node_index
 the index of the Node to return edges from.to_node_index
 the index of the Node to return edges to.include_undirected_edges
 Undirected edges will be included in the
array iff include_undirected_edges is true.
getAdjacentEdgeIndicesArray(int, boolean, boolean, boolean)
public int getInDegree(Node node)
node
 the Node to count inedges of.
public int getInDegree(int node_index)
node_index
 the index of the Node to count inedges of.
public int getInDegree(Node node, boolean count_undirected_edges)
node
 the Node to count inedges of.count_undirected_edges
 Undirected edges will be included in the
count iff count_undirected_edges is true.
public int getInDegree(int node_index, boolean count_undirected_edges)
node_index
 the index of the Node to count inedges of.count_undirected_edges
 Undirected edges will be included in the
count iff count_undirected_edges is true.
public int getOutDegree(Node node)
node
 the Node to count outedges of.
public int getOutDegree(int node_index)
node_index
 the index of the Node to count outedges of.
public int getOutDegree(Node node, boolean count_undirected_edges)
node
 the Node to count outedges of.count_undirected_edges
 Undirected edges will be included in the
count iff count_undirected_edges is true.
public int getOutDegree(int node_index, boolean count_undirected_edges)
node_index
 the index of the Node to count outedges of.count_undirected_edges
 Undirected edges will be included in the
count iff count_undirected_edges is true.
public int getDegree(Node node)
public int getDegree(int node_index)
public int getIndex(Node node)
TECHNICAL DETAIL: The Node input parameter should be an object that was previously returned by a method of this RootGraph or by a method of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
node
 the Node to find a corresponding index for.
public Node getNode(int node_index)
node_index
 the index in this RootGraph of to find a corresponding
Node for.
public int getIndex(Edge edge)
TECHNICAL DETAIL: The Edge input parameter should be an object that was previously returned by a method of this RootGraph or by a method of another component that this RootGraph system defines. If this is not the case, results of calling this method are undefined.
edge
 the Edge to find a corresponding index for.
public Edge getEdge(int edge_index)
edge_index
 the index in this RootGraph of to find a corresponding
Edge for.
public int getEdgeSourceIndex(int edge_index)
edge_index
 the index in this RootGraph of the Edge
public int getEdgeTargetIndex(int edge_index)
edge_index
 the index in this RootGraph of the Edge
public boolean isEdgeDirected(int edge_index)
edge_index
 the index in this RootGraph of the Edge
public boolean addMetaChild(Node parent, Node child)
parent
 the Node that is to be the parent (the container) in
the containsa relationship that we are creating.child
 the Node that is to be the child (the containee) in the
containsa relationship that we are creating.
public boolean addNodeMetaChild(int parent_index, int child_node_index)
parent_index
 the index in this RootGraph of the Node that is to be
the parent (the container) in the containsa relationship that we
are creating.
public boolean removeNodeMetaChild(int parent_index, int child_node_index)
public boolean isMetaParent(Node child, Node parent)
child
 the Node that is the child (the containee) in the
containsa relationship that we are querying.parent
 the Node that is the parent (the container) in the
containsa relationship that we are querying.
public boolean isNodeMetaParent(int child_node_index, int parent_index)
child_node_index
 the index of the Node that is the child (the
containee) in the containsa relationship that we are querying.parent_index
 the index of the Node that is the parent (the
container) in the containsa relationship that we are querying.
public java.util.List metaParentsList(Node node)
node
 the Node that is the child (the containee) in the
containsa relationship that we are querying.
getNodeMetaParentIndicesArray(int)
public java.util.List nodeMetaParentsList(int node_index)
node_index
 the index of the Node that is the child (the
containee) in the containsa relationship that we are querying.
getNodeMetaParentIndicesArray(int)
public int[] getNodeMetaParentIndicesArray(int node_index)
node_index
 the index of the Node that is the child (the
containee) in the containsa relationship that we are querying.
public boolean isMetaChild(Node parent, Node child)
parent
 the Node that is the parent (the container) in the
containsa relationship that we are querying.child
 the Node that is the child (the containee) in the
containsa relationship that we are querying.
public boolean isNodeMetaChild(int parent_index, int child_node_index)
parent_index
 the index of the Node that is the parent (the
container) in the containsa relationship that we are querying.child_node_index
 the index of the Node that is the child (the
containee) in the containsa relationship that we are querying.
public boolean isNodeMetaChild(int parent_index, int child_node_index, boolean recursive)
parent_index
 the index of the Node that is the parent (the
container) in the containsa relationship that we are querying.child_node_index
 the index of the Node that is the child (the
containee) in the containsa relationship that we are querying.recursive
 if true, the method will look for child_node_index recursively inside
descendants of parent_index
public java.util.List nodeMetaChildrenList(Node node)
node
 the Node that is the parent (the container) in the
containsa relationship that we are querying.
getNodeMetaChildIndicesArray(int)
public java.util.List nodeMetaChildrenList(int parent_index)
public int[] getNodeMetaChildIndicesArray(int node_index)
node_index
 the index of the Node that is the parent (the
containee) in the containsa relationship that we are querying.
public int[] getNodeMetaChildIndicesArray(int node_index, boolean recursive)
node_index
 the index of the Node that is the parent (the
containee) in the containsa relationship that we are querying.recursive
 if true, then this method returns all descendants of node_index by
recursively searching inside node_index's children
public int[] getChildlessMetaDescendants(int node_index)
node_index
 the RootGraph index of the node for which childless descendants will
be returned
public boolean addMetaChild(Node parent, Edge child)
parent
 the Node that is to be the parent (the container) in
the containsa relationship that we are creating.child
 the Edge that is to be the child (the containee) in the
containsa relationship that we are creating.
public boolean addEdgeMetaChild(int parent_index, int child_edge_index)
parent_index
 the index in this RootGraph of the Node that is to be
the parent (the container) in the containsa relationship that we
are creating.
public boolean removeEdgeMetaChild(int parent_index, int child_edge_index)
public boolean isMetaParent(Edge child, Node parent)
child
 the Edge that is the child (the containee) in the
containsa relationship that we are querying.parent
 the Node that is the parent (the container) in the
containsa relationship that we are querying.
public boolean isEdgeMetaParent(int child_edge_index, int parent_index)
child_edge_index
 the index of the Edge that is the child (the
containee) in the containsa relationship that we are querying.parent_index
 the index of the Node that is the parent (the
container) in the containsa relationship that we are querying.
public java.util.List metaParentsList(Edge edge)
edge
 the Edge that is the child (the containee) in the
containsa relationship that we are querying.
getEdgeMetaParentIndicesArray(int)
public java.util.List edgeMetaParentsList(int edge_index)
edge_index
 the index of the Edge that is the child (the
containee) in the containsa relationship that we are querying.
getEdgeMetaParentIndicesArray(int)
public int[] getEdgeMetaParentIndicesArray(int edge_index)
edge_index
 the index of the Edge that is the child (the
containee) in the containsa relationship that we are querying.
public boolean isMetaChild(Node parent, Edge child)
parent
 the Node that is the parent (the container) in the
containsa relationship that we are querying.child
 the Edge that is the child (the containee) in the
containsa relationship that we are querying.
public boolean isEdgeMetaChild(int parent_index, int child_edge_index)
parent_index
 the index of the Node that is the parent (the
container) in the containsa relationship that we are querying.child_edge_index
 the index of the Edge that is the child (the
containee) in the containsa relationship that we are querying.
public java.util.List edgeMetaChildrenList(Node node)
node
 the Node that is the parent (the container) in the
containsa relationship that we are querying.
getEdgeMetaChildIndicesArray(int)
public java.util.List edgeMetaChildrenList(int node_index)
node_index
 the index of the Node that is the parent (the
container) in the containsa relationship that we are querying.
getEdgeMetaChildIndicesArray(int)
public int[] getEdgeMetaChildIndicesArray(int node_index)
node_index
 the index of the Node that is the parent (the
containee) in the containsa relationship that we are querying.


PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 