com.arangodb

Interface ArangoCursor<T>

All Superinterfaces:

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

All Known Subinterfaces:

ArangoCursorAsync<T>

All Known Implementing Classes:

ArangoCursorAsyncImpl, com.arangodb.internal.cursor.ArangoCursorImpl

public interface ArangoCursor<T>
extends ArangoIterable<T>, ArangoIterator<T>, Closeable

Author:

Mark Vollmary

Method Summary

Modifier and Type	Method and Description
List<T>	asListRemaining()
Integer	getCount()
String	getId()
Map<String,Object>	getStats()
Class<T>	getType()
Collection<CursorWarning>	getWarnings()
boolean	isCached()
boolean	isPotentialDirtyRead()

Methods inherited from interface com.arangodb.ArangoIterable

iterator, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Methods inherited from interface java.io.Closeable

close

Method Detail

getId

String getId()

Returns:

id of temporary cursor created on the server

getType

Class<T> getType()

Returns:

the type of the result elements

getCount

Integer getCount()

Returns:

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

getStats

Map<String,Object> getStats()

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

Collection<CursorWarning> getWarnings()

Returns:

warnings which the query could have been produced

isCached

boolean isCached()

Returns:

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

asListRemaining

List<T> asListRemaining()

Returns:

the remaining results as a List

isPotentialDirtyRead

boolean isPotentialDirtyRead()

Returns:

true if the result is a potential dirty read

Since:

ArangoDB 3.10