com.arangodb.internal.cursor

Class ArangoCursorImpl<T>

java.lang.Object

com.arangodb.internal.cursor.AbstractArangoIterable<T>

com.arangodb.internal.cursor.ArangoCursorImpl<T>

All Implemented Interfaces:

ArangoCursor<T>, ArangoIterable<T>, ArangoIterator<T>, Closeable, AutoCloseable, Iterable<T>, Iterator<T>

Direct Known Subclasses:

ArangoCursorAsyncImpl

public class ArangoCursorImpl<T>
extends AbstractArangoIterable<T>
implements ArangoCursor<T>

Author:

Mark Vollmary

Field Summary

Fields

Modifier and Type	Field and Description
protected ArangoCursorIterator<T>	iterator

Constructor Summary

Constructors

Constructor and Description
ArangoCursorImpl(com.arangodb.internal.InternalArangoDatabase<?,?> db, com.arangodb.internal.ArangoCursorExecute execute, Class<T> type, CursorEntity result)

Method Summary

Modifier and Type	Method and Description
List<T>	asListRemaining()
void	close()
protected ArangoCursorIterator<T>	createIterator(ArangoCursor<T> cursor, com.arangodb.internal.InternalArangoDatabase<?,?> db, com.arangodb.internal.ArangoCursorExecute execute, CursorEntity result)
void	foreach(Consumer<? super T> action) Performs the given action for each element of the ArangoIterable
Integer	getCount()
String	getId()
String	getNextBatchId()
CursorEntity.Stats	getStats()
Class<T>	getType()
Collection<CursorEntity.Warning>	getWarnings()
boolean	hasNext()
boolean	isCached()
boolean	isPotentialDirtyRead()
ArangoIterator<T>	iterator()
T	next() Returns the next element in the iteration.
void	remove()

Methods inherited from class com.arangodb.internal.cursor.AbstractArangoIterable

allMatch, anyMatch, collectInto, count, filter, first, map, noneMatch, stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.arangodb.ArangoIterable

allMatch, anyMatch, collectInto, count, filter, first, map, noneMatch, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

iterator

protected final ArangoCursorIterator<T> iterator

Constructor Detail

ArangoCursorImpl

public ArangoCursorImpl(com.arangodb.internal.InternalArangoDatabase<?,?> db,
                        com.arangodb.internal.ArangoCursorExecute execute,
                        Class<T> type,
                        CursorEntity result)

Method Detail

createIterator

protected ArangoCursorIterator<T> createIterator(ArangoCursor<T> cursor,
                                                 com.arangodb.internal.InternalArangoDatabase<?,?> db,
                                                 com.arangodb.internal.ArangoCursorExecute execute,
                                                 CursorEntity result)

getId

public String getId()

Specified by:

getId in interface ArangoCursor<T>

Returns:

id of temporary cursor created on the server

getType

public Class<T> getType()

Specified by:

getType in interface ArangoCursor<T>

Returns:

the type of the result elements

getCount

public Integer getCount()

Specified by:

getCount in interface ArangoCursor<T>

Returns:

the total number of result documents available (only available if the query was executed with the count attribute set)

getStats

public CursorEntity.Stats getStats()

Specified by:

getStats in interface ArangoCursor<T>

Returns:

extra information about the query result. For data-modification queries, the stats will contain the number of modified documents and the number of documents that could not be modified due to an error (if ignoreErrors query option is specified)

getWarnings

public Collection<CursorEntity.Warning> getWarnings()

Specified by:

getWarnings in interface ArangoCursor<T>

Returns:

warnings which the query could have been produced

isCached

public boolean isCached()

Specified by:

isCached in interface ArangoCursor<T>

Returns:

indicating whether the query result was served from the query cache or not

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Description copied from interface: ArangoCursor

Returns the next element in the iteration.

If the cursor allows retries (see AqlQueryOptions.allowRetry(Boolean)), then it is safe to retry invoking this method in case of I/O exceptions (which are actually thrown as ArangoDBException with cause IOException).

If the cursor does not allow retries (default), then it is not safe to retry invoking this method in case of I/O exceptions, since the request to fetch the next batch is not idempotent (i.e. the cursor may advance multiple times on the server).

Specified by:

next in interface ArangoCursor<T>

Specified by:

next in interface Iterator<T>

Returns:

the next element in the iteration

asListRemaining

public List<T> asListRemaining()

Specified by:

asListRemaining in interface ArangoCursor<T>

Returns:

the remaining results as a List

isPotentialDirtyRead

public boolean isPotentialDirtyRead()

Specified by:

isPotentialDirtyRead in interface ArangoCursor<T>

Returns:

true if the result is a potential dirty read

remove

public void remove()

Specified by:

remove in interface Iterator<T>

iterator

public ArangoIterator<T> iterator()

Specified by:

iterator in interface ArangoIterable<T>

Specified by:

iterator in interface Iterable<T>

foreach

public void foreach(Consumer<? super T> action)

Description copied from interface: ArangoIterable

Performs the given action for each element of the ArangoIterable

Specified by:

foreach in interface ArangoIterable<T>

Parameters:

action - a action to perform on the elements

getNextBatchId

public String getNextBatchId()

Specified by:

getNextBatchId in interface ArangoCursor<T>

Returns:

The ID of the batch after the current one. The first batch has an ID of 1 and the value is incremented by 1 with every batch. Only set if the allowRetry query option is enabled.