com.arangodb.entity

Class CursorEntity

java.lang.Object

com.arangodb.entity.CursorEntity

All Implemented Interfaces:

Entity, MetaAware

public class CursorEntity
extends Object
implements Entity, MetaAware

Author:

Mark Vollmary

See Also:

API Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CursorEntity.Extras
static class	CursorEntity.Stats
static class	CursorEntity.Warning

Constructor Summary

Constructors

Constructor and Description
CursorEntity()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	cleanupMeta(Map<String,String> meta)
Boolean	getCached()
Integer	getCount()
CursorEntity.Extras	getExtra()
Boolean	getHasMore()
String	getId()
Map<String,String>	getMeta()
com.arangodb.velocypack.VPackSlice	getResult()
void	setMeta(Map<String,String> meta)

Methods inherited from class java.lang.Object

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

Constructor Detail

CursorEntity

public CursorEntity()

Method Detail

getId

public String getId()

getCount

public Integer getCount()

Returns:

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

getExtra

public CursorEntity.Extras getExtra()

Returns:

an optional object with extra information about the query result contained in its stats sub-attribute. For data-modification queries, the extra.stats sub-attribute 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)

getCached

public Boolean getCached()

Returns:

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.

getHasMore

public Boolean getHasMore()

Returns:

A boolean indicator whether there are more results available for the cursor on the server

getResult

public com.arangodb.velocypack.VPackSlice getResult()

Returns:

an vpack-array of result documents (might be empty if query has no results)

getMeta

public Map<String,String> getMeta()

Specified by:

getMeta in interface MetaAware

cleanupMeta

public Map<String,String> cleanupMeta(Map<String,String> meta)

Returns:

remove not allowed (valid storable) meta information

setMeta

public void setMeta(Map<String,String> meta)

Specified by:

setMeta in interface MetaAware