Package com.arangodb.internal

Class ArangoVertexCollectionImpl

java.lang.Object

com.arangodb.internal.ArangoExecuteable

com.arangodb.internal.InternalArangoVertexCollection

com.arangodb.internal.ArangoVertexCollectionImpl

All Implemented Interfaces:

ArangoSerdeAccessor, ArangoVertexCollection

public class ArangoVertexCollectionImpl
extends InternalArangoVertexCollection
implements ArangoVertexCollection

Author:

Mark Vollmary

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ArangoVertexCollectionImpl(ArangoGraphImpl graph, String name)

Method Summary

Modifier and Type	Method	Description
void	deleteVertex(String key)	Deletes the vertex with the given key from the collection.
void	deleteVertex(String key, VertexDeleteOptions options)	Deletes the vertex with the given key from the collection.
void	drop()	Deprecated.
void	drop(VertexCollectionDropOptions options)	Deprecated.
<T> T	getVertex(String key, Class<T> type)	Retrieves the vertex document with the given key from the collection.
<T> T	getVertex(String key, Class<T> type, GraphDocumentReadOptions options)	Retrieves the vertex document with the given key from the collection.
ArangoGraph	graph()	The handler of the named graph the edge collection is within
VertexEntity	insertVertex(Object value)	Creates a new vertex in the collection
VertexEntity	insertVertex(Object value, VertexCreateOptions options)	Creates a new vertex in the collection
void	remove()	Remove a vertex collection form the graph.
void	remove(VertexCollectionRemoveOptions options)	Remove a vertex collection form the graph.
VertexUpdateEntity	replaceVertex(String key, Object value)	Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated
VertexUpdateEntity	replaceVertex(String key, Object 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
VertexUpdateEntity	updateVertex(String key, Object value)	Partially updates the vertex identified by document-key.
VertexUpdateEntity	updateVertex(String key, Object value, VertexUpdateOptions options)	Partially updates the vertex identified by document-key.

Methods inherited from class com.arangodb.internal.InternalArangoVertexCollection

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

Methods inherited from class com.arangodb.internal.ArangoExecuteable

createPath, executorAsync, executorSync, getSerde, request

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.arangodb.ArangoSerdeAccessor

getSerde

Methods inherited from interface com.arangodb.ArangoVertexCollection

name

Constructor Details

ArangoVertexCollectionImpl

protected ArangoVertexCollectionImpl(ArangoGraphImpl graph,
 String name)

Method Details

graph

public ArangoGraph graph()

Description copied from interface: ArangoVertexCollection

The handler of the named graph the edge collection is within

Specified by:

graph in interface ArangoVertexCollection

Returns:

graph handler

drop

@Deprecated
public void drop()

Deprecated.

Description copied from interface: ArangoVertexCollection

Remove a vertex collection form the graph.

Specified by:

drop in interface ArangoVertexCollection

See Also:

• API Documentation

drop

@Deprecated
public void drop(VertexCollectionDropOptions options)

Deprecated.

Description copied from interface: ArangoVertexCollection

Remove a vertex collection form the graph.

Specified by:

drop in interface ArangoVertexCollection

Parameters:

options - options

See Also:

• API Documentation

remove

public void remove()

Description copied from interface: ArangoVertexCollection

Remove a vertex collection form the graph.

Specified by:

remove in interface ArangoVertexCollection

See Also:

• API Documentation

remove

public void remove(VertexCollectionRemoveOptions options)

Description copied from interface: ArangoVertexCollection

Remove a vertex collection form the graph.

Specified by:

remove in interface ArangoVertexCollection

Parameters:

options - options

See Also:

• API Documentation

insertVertex

public VertexEntity insertVertex(Object value)

Description copied from interface: ArangoVertexCollection

Creates a new vertex in the collection

Specified by:

insertVertex in interface ArangoVertexCollection

Parameters:

value - A representation of a single vertex (POJO or RawData)

Returns:

information about the vertex

See Also:

• API Documentation

insertVertex

public VertexEntity insertVertex(Object value,
 VertexCreateOptions options)

Description copied from interface: ArangoVertexCollection

Creates a new vertex in the collection

Specified by:

insertVertex in interface ArangoVertexCollection

Parameters:

value - A representation of a single vertex (POJO or RawData)

options - Additional options, can be null

Returns:

information about the vertex

See Also:

• API Documentation

getVertex

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

Description copied from interface: ArangoVertexCollection

Retrieves the vertex document with the given key from the collection.

Specified by:

getVertex in interface ArangoVertexCollection

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO or RawData)

Returns:

the vertex identified by the key

See Also:

• API Documentation

getVertex

public <T> T getVertex(String key,
 Class<T> type,
 GraphDocumentReadOptions options)

Description copied from interface: ArangoVertexCollection

Retrieves the vertex document with the given key from the collection.

Specified by:

getVertex in interface ArangoVertexCollection

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO or RawData)

options - Additional options, can be null

Returns:

the vertex identified by the key

See Also:

• API Documentation

replaceVertex

public VertexUpdateEntity replaceVertex(String key,
 Object value)

Description copied from interface: ArangoVertexCollection

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

Specified by:

replaceVertex in interface ArangoVertexCollection

Parameters:

key - The key of the vertex

value - A representation of a single vertex (POJO or RawData)

Returns:

information about the vertex

See Also:

• API Documentation

replaceVertex

public VertexUpdateEntity replaceVertex(String key,
 Object value,
 VertexReplaceOptions options)

Description copied from interface: ArangoVertexCollection

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

Specified by:

replaceVertex in interface ArangoVertexCollection

Parameters:

key - The key of the vertex

value - A representation of a single vertex (POJO or RawData)

options - Additional options, can be null

Returns:

information about the vertex

See Also:

• API Documentation

updateVertex

public VertexUpdateEntity updateVertex(String key,
 Object value)

Description copied from interface: ArangoVertexCollection

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.

Specified by:

updateVertex in interface ArangoVertexCollection

Parameters:

key - The key of the vertex

value - A representation of a single vertex (POJO or RawData)

Returns:

information about the vertex

See Also:

• API Documentation

updateVertex

public VertexUpdateEntity updateVertex(String key,
 Object value,
 VertexUpdateOptions options)

Description copied from interface: ArangoVertexCollection

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.

Specified by:

updateVertex in interface ArangoVertexCollection

Parameters:

key - The key of the vertex

value - A representation of a single vertex (POJO or RawData)

options - Additional options, can be null

Returns:

information about the vertex

See Also:

• API Documentation

deleteVertex

public void deleteVertex(String key)

Description copied from interface: ArangoVertexCollection

Deletes the vertex with the given key from the collection.

Specified by:

deleteVertex in interface ArangoVertexCollection

Parameters:

key - The key of the vertex

See Also:

• API Documentation

deleteVertex

public void deleteVertex(String key,
 VertexDeleteOptions options)

Description copied from interface: ArangoVertexCollection

Deletes the vertex with the given key from the collection.

Specified by:

deleteVertex in interface ArangoVertexCollection

Parameters:

key - The key of the vertex

options - Additional options, can be null

See Also:

• API Documentation