att.grappa
Interface GraphIterator

All Superinterfaces:
java.util.Iterator

public interface GraphIterator
extends java.util.Iterator

An extension of the Iterator interface specific to iteration of graph elements.

Version:
1.2, ; Copyright 1996 - 2010 by AT&T Corp.
Author:
John Mocenigo, Research @ AT&T Labs

Method Summary
 int getIterationTypes()
          Get the types of elements possibly contained in this Iterator.
 Subgraph getSubgraphRoot()
          Get the root of this Iterator.
 Element nextGraphElement()
          A convenience method that should just return a cast of a call to nextElement()
 
Methods inherited from interface java.util.Iterator
hasNext, next, remove
 

Method Detail

getSubgraphRoot

Subgraph getSubgraphRoot()
Get the root of this Iterator.

Returns:
the root subgraph for this Iterator

getIterationTypes

int getIterationTypes()
Get the types of elements possibly contained in this Iterator.

Returns:
an indication of the types of elements in this Iterator
See Also:
GrappaConstants.NODE, GrappaConstants.EDGE, GrappaConstants.SUBGRAPH

nextGraphElement

Element nextGraphElement()
                         throws java.util.NoSuchElementException
A convenience method that should just return a cast of a call to nextElement()

Returns:
the next graph element in the Iterator
Throws:
java.util.NoSuchElementException - whenever the Iterator has no more elements.


Grappa 1.2