The Octet Molecular Representation Framework v0.8.2

net.sf.octet.traversal
Interface BreadthTraverser.Handler

All Superinterfaces:
TraversalHandler
Enclosing interface:
BreadthTraverser

public static interface BreadthTraverser.Handler
extends TraversalHandler

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

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

Method Summary
 void crossAtomPairTraversed(AtomPair pair)
          Implement this method to receive notification that a cross AtomPair has been traversed.
 void layerFinished(int layerIndex)
          Implement this method to receive notification that the layer containing Atoms a distance of layerIndex from the root Atom has been exited.
 void layerStarted(int layerIndex)
          Implement this method to receive notification that the next layer, a distance of layerIndex atoms away fromt the root Atom, has been entered.
 
Methods inherited from interface net.sf.octet.traversal.TraversalHandler
abortTraversal, atomPairTraversed, atomTraversed, traversalFinished, traversalStarted
 

Method Detail

layerStarted

public void layerStarted(int layerIndex)
Implement this method to receive notification that the next layer, a distance of layerIndex atoms away fromt the root Atom, has been entered.

Parameters:
layerIndex - the atomic distance of the Atoms in this layer from the root Atom

layerFinished

public void layerFinished(int layerIndex)
Implement this method to receive notification that the layer containing Atoms a distance of layerIndex from the root Atom has been exited.

Parameters:
layerIndex - the atomic distance of the Atoms in this layer from the root Atom

crossAtomPairTraversed

public void crossAtomPairTraversed(AtomPair pair)
Implement this method to receive notification that a cross AtomPair has been traversed. This is an AtomPair that connects two Atoms in the current layer. Indicates the presence of a cycle with an odd-number of Atoms.

Parameters:
pair - an AtomPair connecting two Atoms in the current layer.

The Octet Molecular Representation Framework v0.8.2