Interface QueryResult<T>

All Superinterfaces:

AutoCloseable, CloseableIteration<T, QueryEvaluationException>, Iterable<T>, Iteration<T, QueryEvaluationException>

All Known Subinterfaces:

GraphQueryResult, TupleQueryResult

All Known Implementing Classes:

BackgroundGraphResult, BackgroundTupleResult, CleanerGraphQueryResult, CleanerTupleQueryResult, GraphQueryResultImpl, IteratingGraphQueryResult, IteratingTupleQueryResult, MutableTupleQueryResult, QueryResults.CleanerGraphQueryResult, QueryResults.GraphQueryResultFilter, QueryResults.TupleQueryResultFilter, TupleQueryResultImpl

public interface QueryResult<T>
extends AutoCloseable, CloseableIteration<T, QueryEvaluationException>, Iterable<T>

Super type of all query result types (TupleQueryResult, GraphQueryResult, etc.).

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()	Returns true if the query result has more elements.
default Iterator<T>	iterator()
T	next()	Returns the next element in the query result.
default Stream<T>	stream()	Convert the result elements to a Java Stream.

Methods inherited from interface CloseableIteration

close

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface Iteration

remove

Method Details

iterator

default Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

hasNext

boolean hasNext()
         throws QueryEvaluationException

Returns true if the query result has more elements. (In other words, returns true if next() would return an element rather than throwing a NoSuchElementException.)

Specified by:

hasNext in interface Iteration<T, QueryEvaluationException>

Returns:

true if the iteration has more elements.

Throws:

QueryEvaluationException - if an error occurs while executing the query.

next

T next()
throws QueryEvaluationException

Returns the next element in the query result.

Specified by:

next in interface Iteration<T, QueryEvaluationException>

Returns:

the next element in the query result.

Throws:

NoSuchElementException - if the iteration has no more elements or if it has been closed.

QueryEvaluationException - if an error occurs while executing the query.

stream

default Stream<T> stream()

Convert the result elements to a Java Stream. Note that the consumer should take care to close the stream (by calling Stream#close() or using try-with-resource) if it is not fully consumed.

Specified by:

stream in interface CloseableIteration<T, QueryEvaluationException>

Specified by:

stream in interface Iteration<T, QueryEvaluationException>

Returns:

stream a Stream of query result elements.