com.arangodb.entity

Class BaseDocument

java.lang.Object

com.arangodb.entity.BaseEntity

com.arangodb.entity.BaseDocument

All Implemented Interfaces:

DocumentHolder, Serializable

public class BaseDocument
extends BaseEntity
implements DocumentHolder

Created by gschwab on 1/14/15.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	FROM
static String	ID
static String	KEY
static String	REV
static String	TO

Constructor Summary

Constructors

Constructor and Description
BaseDocument() create an empty BaseDocument
BaseDocument(Map<String,Object> properties) create an BaseDocument with given attributes
BaseDocument(String documentKey) create an empty BaseDocument with a given key
BaseDocument(String documentKey, Map<String,Object> properties) create an BaseDocument with given key and attributes

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String key, Object value) add an attribute to the document.
Object	getAttribute(String key) get a single attribute of the document
String	getDocumentHandle()
String	getDocumentKey()
long	getDocumentRevision()
Map<String,Object>	getProperties()
void	setDocumentHandle(String documentHandle)
void	setDocumentKey(String documentKey)
void	setDocumentRevision(long documentRevision)
void	setProperties(Map<String,Object> properties)
String	toString()
void	updateAttribute(String key, Object value) update the value of the attribute with the given key

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

Methods inherited from class java.lang.Object

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

Field Detail

REV

public static final String REV

See Also:

Constant Field Values

KEY

public static final String KEY

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

FROM

public static final String FROM

See Also:

Constant Field Values

TO

public static final String TO

See Also:

Constant Field Values

Constructor Detail

BaseDocument

public BaseDocument()

create an empty BaseDocument

BaseDocument

public BaseDocument(String documentKey)

create an empty BaseDocument with a given key

Parameters:

documentKey - the unique key of the document

BaseDocument

public BaseDocument(Map<String,Object> properties)

create an BaseDocument with given attributes

Parameters:

properties - the attributes (key/value) of the document to be created

BaseDocument

public BaseDocument(String documentKey,
                    Map<String,Object> properties)

create an BaseDocument with given key and attributes

Parameters:

documentKey - the unique key of the document

properties - the attributes (key/value) of the document to be created

Method Detail

getDocumentRevision

public long getDocumentRevision()

Specified by:

getDocumentRevision in interface DocumentHolder

getDocumentHandle

public String getDocumentHandle()

Specified by:

getDocumentHandle in interface DocumentHolder

getDocumentKey

public String getDocumentKey()

Specified by:

getDocumentKey in interface DocumentHolder

setDocumentRevision

public void setDocumentRevision(long documentRevision)

Specified by:

setDocumentRevision in interface DocumentHolder

setDocumentHandle

public void setDocumentHandle(String documentHandle)

Specified by:

setDocumentHandle in interface DocumentHolder

setDocumentKey

public void setDocumentKey(String documentKey)

Specified by:

setDocumentKey in interface DocumentHolder

getProperties

public Map<String,Object> getProperties()

setProperties

public void setProperties(Map<String,Object> properties)

addAttribute

public void addAttribute(String key,
                         Object value)

add an attribute to the document. If the key already exists, the value of the attribute will be replaced,

Parameters:

key - the key of the attribute

value - the value of the attribute

updateAttribute

public void updateAttribute(String key,
                            Object value)

update the value of the attribute with the given key

Parameters:

key - the key of the attribute

value - the value of the attribute ti replace the old value

getAttribute

public Object getAttribute(String key)

get a single attribute of the document

Parameters:

key - the key of the attribute

Returns:

value of the attribute key

toString

public String toString()

Overrides:

toString in class BaseEntity