com.arangodb

Class ArangoVertexCollection

java.lang.Object

com.arangodb.internal.ArangoExecuteable<E,R,C>

com.arangodb.internal.InternalArangoVertexCollection<ArangoDB,ArangoDatabase,ArangoGraph,ArangoExecutorSync,Response,ConnectionSync>

com.arangodb.ArangoVertexCollection

public class ArangoVertexCollection
extends InternalArangoVertexCollection<ArangoDB,ArangoDatabase,ArangoGraph,ArangoExecutorSync,Response,ConnectionSync>

Author:

Mark Vollmary

Field Summary

Fields inherited from class com.arangodb.internal.ArangoExecuteable

executor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArangoVertexCollection(ArangoGraph graph, String name)

Method Summary

Modifier and Type	Method and Description
void	deleteVertex(String key) Removes a vertex
void	deleteVertex(String key, VertexDeleteOptions options) Removes a vertex
void	drop() Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph
<T> T	getVertex(String key, Class<T> type) Fetches an existing vertex
<T> T	getVertex(String key, Class<T> type, DocumentReadOptions options) Fetches an existing vertex
<T> VertexEntity	insertVertex(T value) Creates a new vertex in the collection
<T> VertexEntity	insertVertex(T value, VertexCreateOptions options) Creates a new vertex in the collection
<T> VertexUpdateEntity	replaceVertex(String key, T value) Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated
<T> VertexUpdateEntity	replaceVertex(String key, T value, VertexReplaceOptions options) Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated
<T> VertexUpdateEntity	updateVertex(String key, T value) Partially updates the vertex identified by document-key.
<T> VertexUpdateEntity	updateVertex(String key, T value, VertexUpdateOptions options) Partially updates the vertex identified by document-key.

Methods inherited from class com.arangodb.internal.InternalArangoVertexCollection

deleteVertexRequest, dropRequest, getVertexRequest, getVertexResponseDeserializer, graph, insertVertexRequest, insertVertexResponseDeserializer, name, replaceVertexRequest, replaceVertexResponseDeserializer, updateVertexRequest, updateVertexResponseDeserializer

Methods inherited from class com.arangodb.internal.ArangoExecuteable

executor, util

Methods inherited from class java.lang.Object

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

Constructor Detail

ArangoVertexCollection

protected ArangoVertexCollection(ArangoGraph graph,
                                 String name)

Method Detail

drop

public void drop()
          throws ArangoDBException

Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph

Throws:

ArangoDBException

See Also:

API Documentation

insertVertex

public <T> VertexEntity insertVertex(T value)
                              throws ArangoDBException

Creates a new vertex in the collection

Parameters:

value - A representation of a single vertex (POJO, VPackSlice or String for Json)

Returns:

information about the vertex

Throws:

ArangoDBException

See Also:

API Documentation

insertVertex

public <T> VertexEntity insertVertex(T value,
                                     VertexCreateOptions options)
                              throws ArangoDBException

Creates a new vertex in the collection

Parameters:

value - A representation of a single vertex (POJO, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the vertex

Throws:

ArangoDBException

See Also:

API Documentation

getVertex

public <T> T getVertex(String key,
                       Class<T> type)
                throws ArangoDBException

Fetches an existing vertex

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

Returns:

the vertex identified by the key

Throws:

ArangoDBException

See Also:

API Documentation

getVertex

public <T> T getVertex(String key,
                       Class<T> type,
                       DocumentReadOptions options)
                throws ArangoDBException

Fetches an existing vertex

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

the vertex identified by the key

Throws:

ArangoDBException

See Also:

API Documentation

replaceVertex

public <T> VertexUpdateEntity replaceVertex(String key,
                                            T value)
                                     throws ArangoDBException

Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

Returns:

information about the vertex

Throws:

ArangoDBException

See Also:

API Documentation

replaceVertex

public <T> VertexUpdateEntity replaceVertex(String key,
                                            T value,
                                            VertexReplaceOptions options)
                                     throws ArangoDBException

Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the vertex

Throws:

ArangoDBException

See Also:

API Documentation

updateVertex

public <T> VertexUpdateEntity updateVertex(String key,
                                           T value)
                                    throws ArangoDBException

Partially updates the vertex identified by document-key. The value must contain a document with the attributes to patch (the patch document). All attributes from the patch document will be added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there.

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

Returns:

information about the vertex

Throws:

ArangoDBException

See Also:

API Documentation

updateVertex

public <T> VertexUpdateEntity updateVertex(String key,
                                           T value,
                                           VertexUpdateOptions options)
                                    throws ArangoDBException

Partially updates the vertex identified by document-key. The value must contain a document with the attributes to patch (the patch document). All attributes from the patch document will be added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there.

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the vertex

Throws:

ArangoDBException

See Also:

API Documentation

deleteVertex

public void deleteVertex(String key)
                  throws ArangoDBException

Removes a vertex

Parameters:

key - The key of the vertex

Throws:

ArangoDBException

See Also:

API Documentation

deleteVertex

public void deleteVertex(String key,
                         VertexDeleteOptions options)
                  throws ArangoDBException

Removes a vertex

Parameters:

key - The key of the vertex

options - Additional options, can be null

Throws:

ArangoDBException

See Also:

API Documentation