att.grappa
Interface GraphEnumeration

All Superinterfaces:
java.util.Enumeration
All Known Implementing Classes:
Subgraph.Enumerator

public interface GraphEnumeration
extends java.util.Enumeration

An extension of the Enumeration interface specific to enumerations of graph elements.

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

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

Method Detail

getSubgraphRoot

Subgraph getSubgraphRoot()
Get the root of this enumeration.

Returns:
the root subgraph for this enumeration

getEnumerationTypes

int getEnumerationTypes()
Get the types of elements possibly contained in this enumeration.

Returns:
an indication of the types of elements in this enumeration
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 enumeration
Throws:
java.util.NoSuchElementException - whenever the enumeration has no more elements.