edu.ucla.sspace.dependency

Interface DependencyPath

All Superinterfaces:

Iterable<DependencyRelation>

All Known Implementing Classes:

SimpleDependencyPath

public interface DependencyPath
extends Iterable<DependencyRelation>

An interface for representing the nodes and their relations in a dependency path.

Method Summary

Methods

Modifier and Type	Method and Description
DependencyTreeNode	first() Returns the first node in the path, which is closest to the root.
DependencyRelation	firstRelation() Returns the relation that connects the first and second nodes in the path, which are closest to the root.
DependencyTreeNode	getNode(int position) Returns the node location at the specified position along the path.
String	getRelation(int position) Returns the relation connecting the node at the specified position to the next node.
Iterator<DependencyRelation>	iterator() Returns an iterator over all the relations in the path in order from closest to the root to furthest.
DependencyTreeNode	last() Returns the last node in the path, which is furthest from the root.
DependencyRelation	lastRelation() Returns the relation that connects the last and second to last nodes in the path, which are furthest from the root.
int	length() Returns the number of nodes in the dependency path.

Method Detail

first

DependencyTreeNode first()

Returns the first node in the path, which is closest to the root.

firstRelation

DependencyRelation firstRelation()

Returns the relation that connects the first and second nodes in the path, which are closest to the root.

getNode

DependencyTreeNode getNode(int position)

Returns the node location at the specified position along the path.

getRelation

String getRelation(int position)

Returns the relation connecting the node at the specified position to the next node. Note that for the last node in the path, no relation exists, so there are at most length() - 1 relations in the path.

Throws:

IllegalArgumentException - if position is less than 0 or position is greater than length() - 1.

iterator

Iterator<DependencyRelation> iterator()

Returns an iterator over all the relations in the path in order from closest to the root to furthest.

Specified by:

iterator in interface Iterable<DependencyRelation>

last

DependencyTreeNode last()

Returns the last node in the path, which is furthest from the root.

lastRelation

DependencyRelation lastRelation()

Returns the relation that connects the last and second to last nodes in the path, which are furthest from the root.

length

int length()

Returns the number of nodes in the dependency path. The number of relations in the path will be length() - 1.