charger.obj

Class GraphObjectIterator

Object

charger.obj.GraphObjectIterator

All Implemented Interfaces:

Iterator

Direct Known Subclasses:

DeepIterator, ShallowIterator

public abstract class GraphObjectIterator
extends Object
implements Iterator

General iterator for graph objects.

Author:

Harry S. Delugach ( delugach@uah.edu ) Copyright (c) 1998-2020 by Harry S. Delugach.

See Also:

GraphObject, Graph

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	deep an indicator of whether to perform a deep or shallow iteration
private GraphObject	GraphObjectToMatch Used when iterating objects of a particular class, rather than using an integer type indicator
private GraphObject.Kind	kindToMatch An indicator GraphObject type or subtype(s) being iterated
private ArrayList<GraphObject>	objectList Holds the graph objects to be examined

Constructor Summary

Constructors

Constructor and Description
GraphObjectIterator(Graph g, GraphObject go, GraphObject.Kind kind, boolean isDeep) Collect graph objects to form an iteration.

Method Summary

Modifier and Type	Method and Description
private void	addGraphObjects(Graph g) Adds objects from a graph to the collection to return (in ArrayList v), based on GraphObjectToMatch or KindToMatch
boolean	hasNext()
int	howMany()
GraphObject	next()
void	remove()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Iterator

forEachRemaining

Field Detail

objectList

private ArrayList<GraphObject> objectList

Holds the graph objects to be examined

kindToMatch

private GraphObject.Kind kindToMatch

An indicator GraphObject type or subtype(s) being iterated

deep

private boolean deep

an indicator of whether to perform a deep or shallow iteration

GraphObjectToMatch

private GraphObject GraphObjectToMatch

Used when iterating objects of a particular class, rather than using an integer type indicator

Constructor Detail

GraphObjectIterator

public GraphObjectIterator(Graph g,
                           GraphObject go,
                           GraphObject.Kind kind,
                           boolean isDeep)

Collect graph objects to form an iteration. The graph itself is not included.

Parameters:

g - graph whose elements are collected to form the iteration

kind - one of GraphObject GRAPH, GNODE, GEDGE -- what kind of objects to collect. Should be zero if all objects are to be collected.

isDeep - whether to recursively collect objects from nested graphs (true) or not

See Also:

GraphObject.Kind

Method Detail

addGraphObjects

private void addGraphObjects(Graph g)

Adds objects from a graph to the collection to return (in ArrayList v), based on GraphObjectToMatch or KindToMatch

Parameters:

g - the graph whose object are to be tested for whether they should be included or not.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator

next

public GraphObject next()

Specified by:

next in interface Iterator

remove

public void remove()
            throws UnsupportedOperationException

Specified by:

remove in interface Iterator

Throws:

UnsupportedOperationException

howMany

public int howMany()