y25.base
Interface LayerEdgeCursor

All Superinterfaces:
YCursor

public interface LayerEdgeCursor
extends YCursor

A cursor interface for iterating over layer edges.

The typical use in conjunction with a LayeredGraph instance is as follows:

 LayeredGraph lg; // a layered graph
 for (LayerEdgeCursor lec = lg.layerEdges(); lec.ok(); lec.next()) {
 	LayerEdge le = lec.layerEdge();
 	// ... do something with the current layer edge ...
 }
 


Method Summary
 void cyclicNext()
          Moves the cursor to the cyclic next element of the underlying sequence.
 void cyclicPrev()
          Moves the cursor to the cyclic previous element of the underlying sequence.
 LayerEdge layerEdge()
          Returns the layer edge at the current location of the cursor.
 
Methods inherited from interface y.base.YCursor
current, next, ok, prev, size, toFirst, toLast
 

Method Detail

layerEdge

public LayerEdge layerEdge()
Returns the layer edge at the current location of the cursor.

Returns:
The graph currently pointed to by this cursor.

cyclicNext

public void cyclicNext()
Moves the cursor to the cyclic next element of the underlying sequence. This is the next element if available, else it is the first element.


cyclicPrev

public void cyclicPrev()
Moves the cursor to the cyclic previous element of the underlying sequence. This is the previous element if available, else it is the last element.