com.arangodb

Class CursorResult<T>

java.lang.Object

com.arangodb.CursorResult<T>

All Implemented Interfaces:

Iterable<T>

Direct Known Subclasses:

DocumentCursorResult

public class CursorResult<T>
extends Object
implements Iterable<T>

Author:

tamtam180 - kirscheless at gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CursorResult.CursorIterator internal iterator

Constructor Summary

Constructors

Constructor and Description
CursorResult(String database, InternalCursorDriver cursorDriver, CursorEntity<T> entity, Class<?>... clazz)

Method Summary

Modifier and Type	Method and Description
List<T>	asList() Returns the objects as a list
void	close() Close cursor (removes cursor from database)
int	getCount() Get total number of results (if requested)
CursorEntity<T>	getEntity() Returns the CursorEntity object
int	getFullCount() Get total number of results for queries with LIMIT clause
T	getUniqueResult() Return a single instance that matches the query, or null if the query returns no results.
List<WarningEntity>	getWarnings() Returns a list of AQL warnings (code and message)
boolean	hasWarning() Returns true, if there are AQL warnings
Iterator<T>	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

CursorResult

public CursorResult(String database,
                    InternalCursorDriver cursorDriver,
                    CursorEntity<T> entity,
                    Class<?>... clazz)

Method Detail

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

asList

public List<T> asList()

Returns the 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 T 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

getEntity

public CursorEntity<T> getEntity()

Returns the CursorEntity object

Returns:

CursorEntity

hasWarning

public boolean hasWarning()

Returns true, if there are AQL warnings

Returns:

true, if there are AQL warnings

getWarnings

public List<WarningEntity> getWarnings()

Returns a list of AQL warnings (code and message)

Returns:

list of AQL warnings