Package com.arangodb.internal

Class ArangoEdgeCollectionImpl

java.lang.Object

com.arangodb.internal.ArangoExecuteable

com.arangodb.internal.InternalArangoEdgeCollection

com.arangodb.internal.ArangoEdgeCollectionImpl

All Implemented Interfaces:

ArangoEdgeCollection, ArangoSerdeAccessor

public class ArangoEdgeCollectionImpl
extends InternalArangoEdgeCollection
implements ArangoEdgeCollection

Author:

Mark Vollmary

Constructor Summary

Constructors

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

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.
void	drop(EdgeCollectionDropOptions options)	Deprecated.
<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
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 class com.arangodb.internal.InternalArangoEdgeCollection

deleteEdgeRequest, getEdgeRequest, getEdgeResponseDeserializer, insertEdgeRequest, insertEdgeResponseDeserializer, name, removeEdgeDefinitionRequest, removeEdgeDefinitionRequest, replaceEdgeRequest, replaceEdgeResponseDeserializer, updateEdgeRequest, updateEdgeResponseDeserializer

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.ArangoEdgeCollection

name

Methods inherited from interface com.arangodb.ArangoSerdeAccessor

getSerde

Constructor Details

ArangoEdgeCollectionImpl

protected ArangoEdgeCollectionImpl(ArangoGraphImpl graph,
 String name)

Method Details

graph

public ArangoGraph graph()

Description copied from interface: ArangoEdgeCollection

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

Specified by:

graph in interface ArangoEdgeCollection

Returns:

graph handler

drop

@Deprecated
public void drop()

Deprecated.

Description copied from interface: ArangoEdgeCollection

Remove one edge definition from the graph.

Specified by:

drop in interface ArangoEdgeCollection

See Also:

• API Documentation

drop

@Deprecated
public void drop(EdgeCollectionDropOptions options)

Deprecated.

Description copied from interface: ArangoEdgeCollection

Remove one edge definition from the graph.

Specified by:

drop in interface ArangoEdgeCollection

Parameters:

options - options

See Also:

• API Documentation

remove

public void remove()

Description copied from interface: ArangoEdgeCollection

Remove one edge definition from the graph.

Specified by:

remove in interface ArangoEdgeCollection

See Also:

• API Documentation

remove

public void remove(EdgeCollectionRemoveOptions options)

Description copied from interface: ArangoEdgeCollection

Remove one edge definition from the graph.

Specified by:

remove in interface ArangoEdgeCollection

Parameters:

options - options

See Also:

• API Documentation

insertEdge

public EdgeEntity insertEdge(Object value)

Description copied from interface: ArangoEdgeCollection

Creates a new edge in the collection

Specified by:

insertEdge in interface ArangoEdgeCollection

Parameters:

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

Returns:

information about the edge

See Also:

• API Documentation

insertEdge

public EdgeEntity insertEdge(Object value,
 EdgeCreateOptions options)

Description copied from interface: ArangoEdgeCollection

Creates a new edge in the collection

Specified by:

insertEdge in interface ArangoEdgeCollection

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

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

Description copied from interface: ArangoEdgeCollection

Fetches an existing edge

Specified by:

getEdge in interface ArangoEdgeCollection

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

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

Description copied from interface: ArangoEdgeCollection

Fetches an existing edge

Specified by:

getEdge in interface ArangoEdgeCollection

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

public EdgeUpdateEntity replaceEdge(String key,
 Object value)

Description copied from interface: ArangoEdgeCollection

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

Specified by:

replaceEdge in interface ArangoEdgeCollection

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

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

Description copied from interface: ArangoEdgeCollection

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

Specified by:

replaceEdge in interface ArangoEdgeCollection

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

public EdgeUpdateEntity updateEdge(String key,
 Object value)

Description copied from interface: ArangoEdgeCollection

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.

Specified by:

updateEdge in interface ArangoEdgeCollection

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

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

Description copied from interface: ArangoEdgeCollection

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.

Specified by:

updateEdge in interface ArangoEdgeCollection

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

public void deleteEdge(String key)

Description copied from interface: ArangoEdgeCollection

Removes a edge

Specified by:

deleteEdge in interface ArangoEdgeCollection

Parameters:

key - The key of the edge

See Also:

• API Documentation

deleteEdge

public void deleteEdge(String key,
 EdgeDeleteOptions options)

Description copied from interface: ArangoEdgeCollection

Removes a edge

Specified by:

deleteEdge in interface ArangoEdgeCollection

Parameters:

key - The key of the edge

options - Additional options, can be null

See Also:

• API Documentation