Interface QueryResult<T>

All Superinterfaces:

AutoCloseable, CloseableIteration<T>, Iterable<T>, Iterator<T>

All Known Subinterfaces:

GraphQueryResult, TupleQueryResult

All Known Implementing Classes:

BackgroundGraphResult, BackgroundTupleResult, CachedGraphQueryResult, CachedTupleQueryResult, CleanerGraphQueryResult, CleanerTupleQueryResult, IteratingGraphQueryResult, IteratingTupleQueryResult, MutableTupleQueryResult, ReusableGraphQueryResult, ReusableTupleQueryResult

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

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

Author:

Jeen Broekstra, Arjohn Kampman

Field Summary

Fields inherited from interface CloseableIteration

EMPTY_STATEMENT_ITERATION

Modifier and Type	Field	Description
static final EmptyIteration<Statement>	EMPTY_STATEMENT_ITERATION

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

Modifier and Type	Method	Description
void	close()	Closes this iteration, freeing any resources that it is holding.

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface Iterator

forEachRemaining, 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 Iterator<T>

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 Iterator<T>

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>

Returns:

stream a Stream of query result elements.