com.arangodb

Class BaseCursorProxy<T,S extends DocumentEntity<T>>

java.lang.Object

com.arangodb.BaseCursorProxy<T,S>

All Implemented Interfaces:

Iterable<S>

Direct Known Subclasses:

DocumentCursor, EdgeCursor, VertexCursor

public class BaseCursorProxy<T,S extends DocumentEntity<T>>
extends Object
implements Iterable<S>

Author:

a-brandt

Constructor Summary

Constructors

Constructor and Description
BaseCursorProxy(DocumentCursorResult<T,S> baseCursor)

Method Summary

Modifier and Type	Method and Description
List<T>	asEntityList() Returns the entities of DocumentEntity objects as a list
List<S>	asList() Returns the DocumentEntity objects as a list
void	close() Close cursor (removes cursor from database)
Iterator<T>	entityIterator() Returns an iterator over a entity set of elements of type T.
int	getCode()
int	getCount() Get total number of results (if requested)
Long	getCursorId() Returns the cursor identifier
Map<String,Object>	getExtra() A list of extra stats returned by the query
int	getFullCount() Get total number of results for queries with LIMIT clause
String	getRequestId()
int	getStatusCode()
S	getUniqueResult() Return a single instance that matches the query, or null if the query returns no results.
boolean	hasMore() Returns true if the cursor can load more data from the database
boolean	isCached() a boolean flag indicating whether the query result was served from the query cache or not.
boolean	isNotModified() If the resource has been modified it returns true
Iterator<S>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BaseCursorProxy

public BaseCursorProxy(DocumentCursorResult<T,S> baseCursor)

Method Detail

iterator

public Iterator<S> iterator()

Specified by:

iterator in interface Iterable<S extends DocumentEntity<T>>

entityIterator

public Iterator<T> entityIterator()

Returns an iterator over a entity set of elements of type T.

Returns:

an Iterator.

asList

public List<S> asList()

Returns the DocumentEntity objects as a list

Returns:

list of DocumentEntity objects

asEntityList

public List<T> asEntityList()

Returns the entities of DocumentEntity objects as a list

Returns:

list of DocumentEntity objects

close

public void close()
           throws ArangoException

Close cursor (removes cursor from database)

Throws:

ArangoException

getCount

public int getCount()

Get total number of results (if requested)

Returns:

total number of results

getFullCount

public int getFullCount()

Get total number of results for queries with LIMIT clause

Returns:

total number of results

getUniqueResult

public S getUniqueResult()

Return a single instance that matches the query, or null if the query returns no results. Throws NonUniqueResultException (RuntimeException) if there is more than one matching result

Returns:

the single result or null

isNotModified

public boolean isNotModified()

If the resource has been modified it returns true

Returns:

boolean

getCode

public int getCode()

getStatusCode

public int getStatusCode()

getRequestId

public String getRequestId()

hasMore

public boolean hasMore()

Returns true if the cursor can load more data from the database

Returns:

true, if the cursor can load more data from the database

getCursorId

public Long getCursorId()

Returns the cursor identifier

Returns:

the cursor identifier

isCached

public boolean isCached()

a boolean flag indicating whether the query result was served from the query cache or not. If the query result is served from the query cache, the extra return attribute will not contain any stats sub-attribute and no profile sub-attribute. (since ArangoDB 2.7)

Returns:

true, if the result is cached

getExtra

public Map<String,Object> getExtra()

A list of extra stats returned by the query

Returns:

query stats