The Octet Molecular Representation Framework v0.8.2

net.sf.octet.traversal
Interface DepthTraverser.Handler

All Superinterfaces:
TraversalHandler
Enclosing interface:
DepthTraverser

public static interface DepthTraverser.Handler
extends TraversalHandler

An extension of the TraversalHandler that includes methods specific to DepthTraverser traversal.

Author:
Richard Apodaca
See Also:
"Strategy Pattern (GoF95)", "Template Method Pattern (GoF95)"

Method Summary
 void branchFinished(Atom branch)
          Implement this method to be notified of the end of a branch traversal starting from branch.
 void branchStarted(Atom branch)
          Implement this method to be notified of the start of a branch traversal starting from branch.
 void cycleClosureTraversed(AtomPair pair)
          Implement this method to be notified that pair has been traversed as a cycle closure AtomPair.
 
Methods inherited from interface net.sf.octet.traversal.TraversalHandler
abortTraversal, atomPairTraversed, atomTraversed, traversalFinished, traversalStarted
 

Method Detail

branchStarted

public void branchStarted(Atom branch)
Implement this method to be notified of the start of a branch traversal starting from branch. This method will only be invoked after one neighbor of branch has been traversed.

Parameters:
branch - the branch Atom

branchFinished

public void branchFinished(Atom branch)
Implement this method to be notified of the end of a branch traversal starting from branch.

Parameters:
branch - the branch Atom

cycleClosureTraversed

public void cycleClosureTraversed(AtomPair pair)
Implement this method to be notified that pair has been traversed as a cycle closure AtomPair. No notification of the traversal of the same AtomPair via atomPairTraversed will be made, enabling the clear distinction between tree and non-tree AtomPairs.

Parameters:
pair - the AtomPair representing the cycle closure

The Octet Molecular Representation Framework v0.8.2