edu.ucla.sspace.dependency

Class BreadthFirstPathIterator

java.lang.Object

edu.ucla.sspace.dependency.BreadthFirstPathIterator

All Implemented Interfaces:

Iterator<DependencyPath>

public class BreadthFirstPathIterator
extends Object
implements Iterator<DependencyPath>

A class for performing a breadth-first iteration of the links in a dependency tree starting at any arbitrary node. The paths returned will always begin at the specified start node.

This class is not thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
protected Queue<SimpleDependencyPath>	frontier The paths that have been expanded from the starting node but have not yet been returned.

Constructor Summary

Constructors

Constructor and Description
BreadthFirstPathIterator(DependencyTreeNode startNode) Creates a new iterator over all the paths starting at the provided index.
BreadthFirstPathIterator(DependencyTreeNode startNode, int maxPathLength) Creates a new iterator over all the paths starting at the provided index that will only return paths up to the specified maximum length.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Returns true if there are still paths to return for the tree.
DependencyPath	next() Returns the next DependencyPath in the tree whose length is equal or greater than the previously returned path.
void	remove() Throws an UnsupportedOperationException if called

Methods inherited from class java.lang.Object

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

Field Detail

frontier

protected final Queue<SimpleDependencyPath> frontier

The paths that have been expanded from the starting node but have not yet been returned.

Constructor Detail

BreadthFirstPathIterator

public BreadthFirstPathIterator(DependencyTreeNode startNode)

Creates a new iterator over all the paths starting at the provided index.

Parameters:

startNode - the node that will start all the paths to be generated.

BreadthFirstPathIterator

public BreadthFirstPathIterator(DependencyTreeNode startNode,
                        int maxPathLength)

Creates a new iterator over all the paths starting at the provided index that will only return paths up to the specified maximum length.

Parameters:

startNode - the node that will start all the paths to be generated.

maxPathLength - the maximum path length to return

Throws:

IllegalArgumentException - if is < 1.

Method Detail

hasNext

public boolean hasNext()

Returns true if there are still paths to return for the tree.

Specified by:

hasNext in interface Iterator<DependencyPath>

next

public DependencyPath next()

Returns the next DependencyPath in the tree whose length is equal or greater than the previously returned path.

Specified by:

next in interface Iterator<DependencyPath>

remove

public void remove()

Throws an UnsupportedOperationException if called

Specified by:

remove in interface Iterator<DependencyPath>