uk.ed.inf.graph.compound.impl
Class CompoundNode

java.lang.Object
  extended by uk.ed.inf.graph.compound.base.BaseCompoundNode
      extended by uk.ed.inf.graph.compound.archetypal.ArchetypalCompoundNode
          extended by uk.ed.inf.graph.compound.impl.CompoundNode
All Implemented Interfaces:
java.lang.Comparable<BaseCompoundNode>, IBasicNode<BaseCompoundNode,BaseCompoundEdge>, ICompoundNode<BaseCompoundNode,BaseCompoundEdge>, IDirectedNode<BaseCompoundNode,BaseCompoundEdge>, IRestorableGraphElement, ITreeNode<BaseCompoundNode>

public class CompoundNode
extends ArchetypalCompoundNode


Constructor Summary
CompoundNode(CompoundGraph superGraph, int index)
           
CompoundNode(CompoundNode parent, int index)
           
 
Method Summary
protected  void createChildCompoundGraph(ArchetypalCompoundNode rootNode)
           
 ChildCompoundGraph getChildCompoundGraph()
          Get subgraph of this compound node.
 boolean isRemoved()
          Has the node been removed from the graph? Nodes are not removed from the graph's data structures, but flagged as deleted.
protected  void removalAction(boolean removed)
          additional actions to be executed upon this node being marked as removed.
protected  void setRemoved(boolean removed)
          This should be used to set the removal status variable only.
 java.lang.String toString()
           
 
Methods inherited from class uk.ed.inf.graph.compound.archetypal.ArchetypalCompoundNode
getGraph, getIndex, getParent
 
Methods inherited from class uk.ed.inf.graph.compound.base.BaseCompoundNode
ancestorIterator, childIterator, compareTo, connectedNodeIterator, createInEdgeSet, createOutEdgeSet, edgeIterator, getDegree, getEdgeInList, getEdgeOutList, getEdgesWith, getInDegree, getInEdgeIterator, getInEdgesFrom, getInNodeIterator, getOutDegree, getOutEdgeIterator, getOutEdgesTo, getOutNodeIterator, getRoot, hasEdgeWith, hasInEdgeFrom, hasOutEdgeTo, isAncestor, isChild, isDescendent, isParent, levelOrderIterator, markRemoved
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface uk.ed.inf.graph.basic.IBasicNode
equals, hashCode
 

Constructor Detail

CompoundNode

CompoundNode(CompoundGraph superGraph,
             int index)

CompoundNode

CompoundNode(CompoundNode parent,
             int index)
Method Detail

createChildCompoundGraph

protected void createChildCompoundGraph(ArchetypalCompoundNode rootNode)
Specified by:
createChildCompoundGraph in class ArchetypalCompoundNode

getChildCompoundGraph

public ChildCompoundGraph getChildCompoundGraph()
Description copied from interface: ICompoundNode
Get subgraph of this compound node. Note that this node is the root-node of the sub-Cigraph.

Specified by:
getChildCompoundGraph in interface ICompoundNode<BaseCompoundNode,BaseCompoundEdge>
Specified by:
getChildCompoundGraph in class ArchetypalCompoundNode
Returns:

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

removalAction

protected void removalAction(boolean removed)
Description copied from class: BaseCompoundNode
additional actions to be executed upon this node being marked as removed.

Specified by:
removalAction in class BaseCompoundNode

setRemoved

protected void setRemoved(boolean removed)
Description copied from class: BaseCompoundNode
This should be used to set the removal status variable only. No other actions# should be performed here. To perform an action on removal then use BaseCompoundNode.removalAction(boolean).

Specified by:
setRemoved in class BaseCompoundNode
Parameters:
removed - the removal status: true means the nodes is removed.

isRemoved

public boolean isRemoved()
Description copied from interface: IBasicNode
Has the node been removed from the graph? Nodes are not removed from the graph's data structures, but flagged as deleted.

Specified by:
isRemoved in interface IBasicNode<BaseCompoundNode,BaseCompoundEdge>
Specified by:
isRemoved in class BaseCompoundNode
Returns:
true if removed, false otherwise.