com.arangodb.async.internal

Class ArangoGraphAsyncImpl

java.lang.Object

com.arangodb.internal.ArangoExecuteable<E>

com.arangodb.internal.InternalArangoGraph<ArangoDBAsyncImpl,ArangoDatabaseAsyncImpl,ArangoExecutorAsync>

com.arangodb.async.internal.ArangoGraphAsyncImpl

All Implemented Interfaces:

ArangoSerdeAccessor, ArangoGraphAsync

public class ArangoGraphAsyncImpl
extends InternalArangoGraph<ArangoDBAsyncImpl,ArangoDatabaseAsyncImpl,ArangoExecutorAsync>
implements ArangoGraphAsync

Author:

Mark Vollmary

Field Summary

Fields inherited from class com.arangodb.internal.InternalArangoGraph

PATH_API_GHARIAL

Fields inherited from class com.arangodb.internal.ArangoExecuteable

executor, serde

Method Summary

Modifier and Type	Method and Description
CompletableFuture<GraphEntity>	addEdgeDefinition(EdgeDefinition definition) Add a new edge definition to the graph
CompletableFuture<GraphEntity>	addVertexCollection(String name) Adds a vertex collection to the set of collections of the graph.
CompletableFuture<GraphEntity>	addVertexCollection(String name, VertexCollectionCreateOptions options) Adds a vertex collection to the set of collections of the graph.
CompletableFuture<GraphEntity>	create(Collection<EdgeDefinition> edgeDefinitions) Creates the graph in the graph module.
CompletableFuture<GraphEntity>	createGraph(Collection<EdgeDefinition> edgeDefinitions, GraphCreateOptions options) Creates the graph in the graph module.
CompletableFuture<Void>	drop() Delete an existing graph
CompletableFuture<Void>	drop(boolean dropCollections) Delete an existing graph including
ArangoEdgeCollectionAsync	edgeCollection(String name) Returns a handler of the edge collection by the given name
CompletableFuture<Boolean>	exists() Checks whether the graph exists
CompletableFuture<Collection<String>>	getEdgeDefinitions() Lists all edge collections used in this graph
CompletableFuture<GraphEntity>	getInfo() Get a graph from the graph module
CompletableFuture<Collection<String>>	getVertexCollections() Lists all vertex collections used in this graph
CompletableFuture<GraphEntity>	removeEdgeDefinition(String definitionName) Remove one edge definition from the graph.
CompletableFuture<GraphEntity>	replaceEdgeDefinition(EdgeDefinition definition) Change one specific edge definition.
ArangoVertexCollectionAsync	vertexCollection(String name) Returns a handler of the vertex collection by the given name

Methods inherited from class com.arangodb.internal.InternalArangoGraph

addEdgeDefinitionRequest, addEdgeDefinitionResponseDeserializer, addVertexCollectionRequest, addVertexCollectionResponseDeserializer, db, dropRequest, dropRequest, getEdgeDefinitionsDeserializer, getEdgeDefinitionsRequest, getInfoRequest, getInfoResponseDeserializer, getVertexCollectionsRequest, getVertexCollectionsResponseDeserializer, name, removeEdgeDefinitionRequest, removeEdgeDefinitionResponseDeserializer, replaceEdgeDefinitionRequest, replaceEdgeDefinitionResponseDeserializer

Methods inherited from class com.arangodb.internal.ArangoExecuteable

createPath, executor, 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.async.ArangoGraphAsync

db, name

Methods inherited from interface com.arangodb.ArangoSerdeAccessor

getSerde

Method Detail

exists

public CompletableFuture<Boolean> exists()

Description copied from interface: ArangoGraphAsync

Checks whether the graph exists

Specified by:

exists in interface ArangoGraphAsync

Returns:

true if the graph exists, otherwise false

create

public CompletableFuture<GraphEntity> create(Collection<EdgeDefinition> edgeDefinitions)

Description copied from interface: ArangoGraphAsync

Creates the graph in the graph module. The creation of a graph requires the name of the graph and a definition of its edges.

Specified by:

create in interface ArangoGraphAsync

Parameters:

edgeDefinitions - An array of definitions for the edge

Returns:

information about the graph

See Also:

API Documentation

createGraph

public CompletableFuture<GraphEntity> createGraph(Collection<EdgeDefinition> edgeDefinitions,
                                                  GraphCreateOptions options)

Description copied from interface: ArangoGraphAsync

Creates the graph in the graph module. The creation of a graph requires the name of the graph and a definition of its edges.

Specified by:

createGraph in interface ArangoGraphAsync

Parameters:

edgeDefinitions - An array of definitions for the edge

options - Additional options, can be null

Returns:

information about the graph

See Also:

API Documentation

drop

public CompletableFuture<Void> drop()

Description copied from interface: ArangoGraphAsync

Delete an existing graph

Specified by:

drop in interface ArangoGraphAsync

Returns:

void

See Also:

API Documentation

drop

public CompletableFuture<Void> drop(boolean dropCollections)

Description copied from interface: ArangoGraphAsync

Delete an existing graph including

Specified by:

drop in interface ArangoGraphAsync

Parameters:

dropCollections - Drop collections of this graph as well. Collections will only be dropped if they are not used in other graphs.

Returns:

void

See Also:

API Documentation

getInfo

public CompletableFuture<GraphEntity> getInfo()

Description copied from interface: ArangoGraphAsync

Get a graph from the graph module

Specified by:

getInfo in interface ArangoGraphAsync

Returns:

the definition content of this graph

See Also:

API Documentation

getVertexCollections

public CompletableFuture<Collection<String>> getVertexCollections()

Description copied from interface: ArangoGraphAsync

Lists all vertex collections used in this graph

Specified by:

getVertexCollections in interface ArangoGraphAsync

Returns:

all vertex collections within this graph

See Also:

API Documentation

addVertexCollection

public CompletableFuture<GraphEntity> addVertexCollection(String name)

Description copied from interface: ArangoGraphAsync

Adds a vertex collection to the set of collections of the graph. If the collection does not exist, it will be created.

Specified by:

addVertexCollection in interface ArangoGraphAsync

Parameters:

name - The name of the collection

Returns:

information about the graph

See Also:

API Documentation

addVertexCollection

public CompletableFuture<GraphEntity> addVertexCollection(String name,
                                                          VertexCollectionCreateOptions options)

Description copied from interface: ArangoGraphAsync

Adds a vertex collection to the set of collections of the graph. If the collection does not exist, it will be created.

Specified by:

addVertexCollection in interface ArangoGraphAsync

Parameters:

name - The name of the collection

options - additional options

Returns:

information about the graph

See Also:

API Documentation

vertexCollection

public ArangoVertexCollectionAsync vertexCollection(String name)

Description copied from interface: ArangoGraphAsync

Returns a handler of the vertex collection by the given name

Specified by:

vertexCollection in interface ArangoGraphAsync

Parameters:

name - Name of the vertex collection

Returns:

collection handler

edgeCollection

public ArangoEdgeCollectionAsync edgeCollection(String name)

Description copied from interface: ArangoGraphAsync

Returns a handler of the edge collection by the given name

Specified by:

edgeCollection in interface ArangoGraphAsync

Parameters:

name - Name of the edge collection

Returns:

collection handler

getEdgeDefinitions

public CompletableFuture<Collection<String>> getEdgeDefinitions()

Description copied from interface: ArangoGraphAsync

Lists all edge collections used in this graph

Specified by:

getEdgeDefinitions in interface ArangoGraphAsync

Returns:

all edge collections within this graph

See Also:

API Documentation

addEdgeDefinition

public CompletableFuture<GraphEntity> addEdgeDefinition(EdgeDefinition definition)

Description copied from interface: ArangoGraphAsync

Add a new edge definition to the graph

Specified by:

addEdgeDefinition in interface ArangoGraphAsync

Returns:

information about the graph

See Also:

API Documentation

replaceEdgeDefinition

public CompletableFuture<GraphEntity> replaceEdgeDefinition(EdgeDefinition definition)

Description copied from interface: ArangoGraphAsync

Change one specific edge definition. This will modify all occurrences of this definition in all graphs known to your database

Specified by:

replaceEdgeDefinition in interface ArangoGraphAsync

Parameters:

definition - The edge definition

Returns:

information about the graph

See Also:

API Documentation

removeEdgeDefinition

public CompletableFuture<GraphEntity> removeEdgeDefinition(String definitionName)

Description copied from interface: ArangoGraphAsync

Remove one edge definition from the graph. This will only remove the edge collection, the vertex collections remain untouched and can still be used in your queries

Specified by:

removeEdgeDefinition in interface ArangoGraphAsync

Parameters:

definitionName - The name of the edge collection used in the definition

Returns:

information about the graph

See Also:

API Documentation