org.hypergraphdb.query.impl
Class TraversalResult

java.lang.Object
  org.hypergraphdb.query.impl.TraversalResult

All Implemented Interfaces:

java.util.Iterator<Pair<HGHandle,HGHandle>>, HGSearchResult<Pair<HGHandle,HGHandle>>, TwoWayIterator<Pair<HGHandle,HGHandle>>, CloseMe

public class TraversalResult
extends java.lang.Object
implements HGSearchResult<Pair<HGHandle,HGHandle>>

TraversalResult wraps a graph HGTraversal as a query HGSearchResult. Because graph traversals are not bidirectional, this implementation will throw an UnsupportedOperationException from the backwards moving methods.

Author:

Borislav Iordanov

Field Summary

Fields inherited from interface org.hypergraphdb.HGSearchResult

EMPTY

Constructor Summary

TraversalResult(HGTraversal traversal)

Method Summary

void	close() Free all system resources held up by the result set and invalidate it for further use.
Pair<HGHandle,HGHandle>	current() Returns the current element in the result set.
boolean	hasNext()
boolean	hasPrev() Return true if there is a previous element in the current iteration state and false otherwise.
boolean	isOrdered() Return true if the elements in this search result are in ordered and false otherwise.
Pair<HGHandle,HGHandle>	next()
Pair<HGHandle,HGHandle>	prev() Returns the previous element in this iteration.
void	remove()

Methods inherited from class java.lang.Object

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

Constructor Detail

TraversalResult

public TraversalResult(HGTraversal traversal)

Method Detail

current

public Pair<HGHandle,HGHandle> current()

Description copied from interface: HGSearchResult

Returns the current element in the result set. If there is no current element, java.util.NoSuchElementException is thrown. There is no current element in one of two cases: either the result set is empty or the next method was never invoked.

Specified by:

current in interface HGSearchResult<Pair<HGHandle,HGHandle>>

Returns:

The current element in a HGSearchResult.

close

public void close()

Description copied from interface: HGSearchResult

Free all system resources held up by the result set and invalidate it for further use.

Specified by:

close in interface HGSearchResult<Pair<HGHandle,HGHandle>>

Specified by:

close in interface CloseMe

isOrdered

public boolean isOrdered()

Description copied from interface: HGSearchResult

Return true if the elements in this search result are in ordered and false otherwise. It is assumed that when elements are ordered, they are instances of java.lang.Comparable

Specified by:

isOrdered in interface HGSearchResult<Pair<HGHandle,HGHandle>>

hasPrev

public boolean hasPrev()

Description copied from interface: TwoWayIterator

Return true if there is a previous element in the current iteration state and false otherwise. After the iterator has been initialized, the value of hasPrev will always be false.

Specified by:

hasPrev in interface TwoWayIterator<Pair<HGHandle,HGHandle>>

prev

public Pair<HGHandle,HGHandle> prev()

Description copied from interface: TwoWayIterator

Returns the previous element in this iteration.

Specified by:

prev in interface TwoWayIterator<Pair<HGHandle,HGHandle>>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<Pair<HGHandle,HGHandle>>

next

public Pair<HGHandle,HGHandle> next()

Specified by:

next in interface java.util.Iterator<Pair<HGHandle,HGHandle>>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<Pair<HGHandle,HGHandle>>