edu.ucla.sspace.dependency

Class FilteredDependencyIterator

java.lang.Object

edu.ucla.sspace.dependency.FilteredDependencyIterator

All Implemented Interfaces:

Iterator<DependencyPath>

public class FilteredDependencyIterator
extends Object
implements Iterator<DependencyPath>

A traversal class for iterating over a dependency tree of Relations. Given the tree and a starting index, the traverser will find all paths that satisfy several different criteria: length of the path and accepted relations in the path.

Note that this class is NOT thread safe.

Constructor Summary

Constructors

Constructor and Description
FilteredDependencyIterator(DependencyTreeNode startNode, DependencyPathAcceptor acceptor) Creates a new DependencyIterator that will return all DependencyPath instances rooted at startNode that are validated by the provided acceptor.
FilteredDependencyIterator(DependencyTreeNode startNode, DependencyPathAcceptor acceptor, int maxPathLength) Creates a new DependencyIterator that will return all DependencyPath instances rooted at startNode that are validated by the provided acceptor and whose length are under the maximum length

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Returns true if there are more paths to return that meet the acceptor and path length requirements.
DependencyPath	next() Returns the next path that meets the requirements.
void	remove() Throws UnsupportedOperationException if called.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredDependencyIterator

public FilteredDependencyIterator(DependencyTreeNode startNode,
                          DependencyPathAcceptor acceptor)

Creates a new DependencyIterator that will return all DependencyPath instances rooted at startNode that are validated by the provided acceptor.

Parameters:

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

acceptor - The DependencyPathAcceptor that will validate each link the a path

Throws:

IllegalArgumentException - if maxPathLength is less than 1

FilteredDependencyIterator

public FilteredDependencyIterator(DependencyTreeNode startNode,
                          DependencyPathAcceptor acceptor,
                          int maxPathLength)

Creates a new DependencyIterator that will return all DependencyPath instances rooted at startNode that are validated by the provided acceptor and whose length are under the maximum length

Parameters:

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

acceptor - The DependencyPathAcceptor that will validate the paths returned by this iterator

maxPathLength - the maximum number of relations in any path

Throws:

IllegalArgumentException - if maxPathLength is less than 1

Method Detail

hasNext

public boolean hasNext()

Returns true if there are more paths to return that meet the acceptor and path length requirements.

Specified by:

hasNext in interface Iterator<DependencyPath>

next

public DependencyPath next()

Returns the next path that meets the requirements.

Specified by:

next in interface Iterator<DependencyPath>

Throws:

NoSuchElementException - if called when no further paths exist

remove

public void remove()

Throws UnsupportedOperationException if called.

Specified by:

remove in interface Iterator<DependencyPath>