softparsmap
Class ChildIterator

java.lang.Object
  extended bysoftparsmap.ChildIterator
All Implemented Interfaces:
java.util.Iterator

public class ChildIterator
extends java.lang.Object
implements java.util.Iterator

This child iterator will take into account that some of a the edges in a gene tree might be collapsed and therefore skip those nodes. Using this iterator and while flagging nodes collapsed provides a simple way to temporary collapse nodes in a gene tree.


Constructor Summary
ChildIterator(GeneNode node)
          This iterator needs a gene node.
ChildIterator(GeneNode node, boolean storeWeakNodes)
          This iterator needs a gene node and it is possible to store weak edges that are skipped when stepping through the children of the gene node.
 
Method Summary
 boolean hasNext()
          See Iterator.java
 java.lang.Object next()
          See Iterator.java
 void remove()
          This method can not be used and a FatalException will be thrown if called.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChildIterator

public ChildIterator(GeneNode node)
This iterator needs a gene node.

Parameters:
node - is a gene node

ChildIterator

public ChildIterator(GeneNode node,
                     boolean storeWeakNodes)
This iterator needs a gene node and it is possible to store weak edges that are skipped when stepping through the children of the gene node.

Parameters:
node - is the gene node
storeWeakNodes - specifies of weak edges should be stored
Method Detail

hasNext

public boolean hasNext()
See Iterator.java

Specified by:
hasNext in interface java.util.Iterator
See Also:
Iterator

next

public java.lang.Object next()
See Iterator.java

Specified by:
next in interface java.util.Iterator
See Also:
Iterator

remove

public void remove()
This method can not be used and a FatalException will be thrown if called.

Specified by:
remove in interface java.util.Iterator
Throws:
FatalExcetpion - if this method is called.