net.sf.octet.traversal
Interface CycleSystemTraverser

All Known Implementing Classes:

BasicCycleSystemTraverser

public interface CycleSystemTraverser

Traverses the cycle systems of an AtomGraph. A cycle system is a set of cycles in an AtomGraph joined by one or more AtomPairs . The order and completeness of cycle system traversal will be implementation- dependent, as will be the order of Atom and AtomPair traversal within a paricular cycle system. Each detected cycle system will be traversed once.

Clients are notified of the various stages in the traversal algorithm by using a custom Handler . This is achieved by instantiating an object that implements Handler and invoking traverse with the object as an argument.

Author:

Richard Apodaca

Nested Class Summary

static interface

CycleSystemTraverser.Handler A handler of CycleSystemTraverser events.

Method Summary

void	traverse(AtomGraph graph, CycleSystemTraverser.Handler handler) Traverses graph, notifying handler if the stages in the traversal process.

Method Detail

traverse

public void traverse(AtomGraph graph,
                     CycleSystemTraverser.Handler handler)

Traverses graph, notifying handler if the stages in the traversal process.

Parameters:

graph - the AtomGraph to traverse.

handler - the Handler that will be notified of traversal events