com.arangodb.entity

Class CursorEntity<T>

java.lang.Object

com.arangodb.entity.BaseEntity

com.arangodb.entity.CursorEntity<T>

All Implemented Interfaces:

Serializable, Iterable<T>

public class CursorEntity<T>
extends BaseEntity
implements Iterable<T>

Cursor entity that represents the result of a AQL query.

Author:

tamtam180 - kirscheless at gmail.com, mrbatista

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CursorEntity()

Method Summary

Modifier and Type	Method and Description
T	get(int index) Returns the cursor element at position *index*
List<String>	getBindVars()
int	getCount()
long	getCursorId()
Map<String,Object>	getExtra()
int	getFullCount()
List<T>	getResults() Returns the DocumentEntity objects of this CursorDocumentEntity
T	getUniqueResult() Return a single instance that matches the query, or null if the query returns no results.
List<WarningEntity>	getWarnings()
boolean	hasMore()
boolean	hasWarnings()
boolean	isCached()
boolean	isHasMore()
Iterator<T>	iterator()
void	setBindVars(List<String> bindVars)
void	setCached(boolean cached)
void	setCount(int count)
void	setCursorId(long cursorId)
void	setExtra(Map<String,Object> extra)
void	setFullCount(int count)
void	setHasMore(boolean hasMore)
void	setResults(List<T> results)
void	setWarnings(List<WarningEntity> warnings)
int	size() The size of the cursor results.

Methods inherited from class com.arangodb.entity.BaseEntity

getCode, getErrorMessage, getErrorNumber, getEtag, getRequestId, getStatusCode, isBatchResponseEntity, isError, isNotModified, isUnauthorized, setCode, setError, setErrorMessage, setErrorNumber, setEtag, setRequestId, setStatusCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CursorEntity

public CursorEntity()

Method Detail

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

size

public int size()

The size of the cursor results.

Returns:

int

get

public T get(int index)

Returns the cursor element at position *index*

Parameters:

index -

Returns:

Object

getResults

public List<T> getResults()

Returns the DocumentEntity objects of this CursorDocumentEntity

Returns:

list of DocumentEntity objects

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

isHasMore

public boolean isHasMore()

hasMore

public boolean hasMore()

getFullCount

public int getFullCount()

getCount

public int getCount()

getCursorId

public long getCursorId()

getBindVars

public List<String> getBindVars()

getExtra

public Map<String,Object> getExtra()

setResults

public void setResults(List<T> results)

setHasMore

public void setHasMore(boolean hasMore)

setFullCount

public void setFullCount(int count)

setCount

public void setCount(int count)

setCursorId

public void setCursorId(long cursorId)

setBindVars

public void setBindVars(List<String> bindVars)

setExtra

public void setExtra(Map<String,Object> extra)

isCached

public boolean isCached()

setCached

public void setCached(boolean cached)

getWarnings

public List<WarningEntity> getWarnings()

setWarnings

public void setWarnings(List<WarningEntity> warnings)

hasWarnings

public boolean hasWarnings()