Package com.arangodb

Interface ArangoEdgeCollection

All Superinterfaces:

ArangoSerdeAccessor

@ThreadSafe
public interface ArangoEdgeCollection
extends ArangoSerdeAccessor

Interface for operations on ArangoDB edge collection level.

Author:

Mark Vollmary

See Also:

API Documentation

Method Summary

Modifier and Type	Method	Description
void	deleteEdge(String key)	Removes a edge
void	deleteEdge(String key, EdgeDeleteOptions options)	Removes a edge
void	drop()	Deprecated. use remove() instead
void	drop(EdgeCollectionDropOptions options)	Deprecated. use remove(EdgeCollectionRemoveOptions) instead
<T> T	getEdge(String key, Class<T> type)	Fetches an existing edge
<T> T	getEdge(String key, Class<T> type, GraphDocumentReadOptions options)	Fetches an existing edge
ArangoGraph	graph()	The the handler of the named graph the edge collection is within
EdgeEntity	insertEdge(Object value)	Creates a new edge in the collection
EdgeEntity	insertEdge(Object value, EdgeCreateOptions options)	Creates a new edge in the collection
String	name()	The name of the edge collection
void	remove()	Remove one edge definition from the graph.
void	remove(EdgeCollectionRemoveOptions options)	Remove one edge definition from the graph.
EdgeUpdateEntity	replaceEdge(String key, Object value)	Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is violated
EdgeUpdateEntity	replaceEdge(String key, Object value, EdgeReplaceOptions options)	Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is violated
EdgeUpdateEntity	updateEdge(String key, Object value)	Partially updates the edge identified by document-key.
EdgeUpdateEntity	updateEdge(String key, Object value, EdgeUpdateOptions options)	Partially updates the edge identified by document-key.

Methods inherited from interface com.arangodb.ArangoSerdeAccessor

getSerde

Method Detail

graph

ArangoGraph graph()

The the handler of the named graph the edge collection is within

Returns:

graph handler

name

String name()

The name of the edge collection

Returns:

collection name

drop

@Deprecated
void drop()

Deprecated.

use remove() instead

Remove one edge definition from the graph.

See Also:

API Documentation

drop

@Deprecated
void drop(EdgeCollectionDropOptions options)

Deprecated.

use remove(EdgeCollectionRemoveOptions) instead

Remove one edge definition from the graph.

Parameters:

options - options

See Also:

API Documentation

remove

void remove()

Remove one edge definition from the graph.

See Also:

API Documentation

remove

void remove(EdgeCollectionRemoveOptions options)

Remove one edge definition from the graph.

Parameters:

options - options

See Also:

API Documentation

insertEdge

EdgeEntity insertEdge(Object value)

Creates a new edge in the collection

Parameters:

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

Returns:

information about the edge

See Also:

API Documentation

insertEdge

EdgeEntity insertEdge(Object value,
                      EdgeCreateOptions options)

Creates a new edge in the collection

Parameters:

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

options - Additional options, can be null

Returns:

information about the edge

See Also:

API Documentation

getEdge

<T> T getEdge(String key,
              Class<T> type)

Fetches an existing edge

Parameters:

key - The key of the edge

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

Returns:

the edge identified by the key

See Also:

API Documentation

getEdge

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

Fetches an existing edge

Parameters:

key - The key of the edge

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

options - Additional options, can be null

Returns:

the edge identified by the key

See Also:

API Documentation

replaceEdge

EdgeUpdateEntity replaceEdge(String key,
                             Object value)

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

Parameters:

key - The key of the edge

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

Returns:

information about the edge

See Also:

API Documentation

replaceEdge

EdgeUpdateEntity replaceEdge(String key,
                             Object value,
                             EdgeReplaceOptions options)

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

Parameters:

key - The key of the edge

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

options - Additional options, can be null

Returns:

information about the edge

See Also:

API Documentation

updateEdge

EdgeUpdateEntity updateEdge(String key,
                            Object value)

Partially updates the edge 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 edge

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

Returns:

information about the edge

See Also:

API Documentation

updateEdge

EdgeUpdateEntity updateEdge(String key,
                            Object value,
                            EdgeUpdateOptions options)

Partially updates the edge 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 edge

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

options - Additional options, can be null

Returns:

information about the edge

See Also:

API Documentation

deleteEdge

void deleteEdge(String key)

Removes a edge

Parameters:

key - The key of the edge

See Also:

API Documentation

deleteEdge

void deleteEdge(String key,
                EdgeDeleteOptions options)

Removes a edge

Parameters:

key - The key of the edge

options - Additional options, can be null

See Also:

API Documentation