com.arangodb

Class ArangoGraph

java.lang.Object

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

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

com.arangodb.ArangoGraph

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

Author:

Mark - mark at arangodb.com

Field Summary

Fields inherited from class com.arangodb.internal.ArangoExecuteable

executor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArangoGraph(ArangoDatabase db, String name)

Method Summary

Modifier and Type	Method and Description
GraphEntity	addEdgeDefinition(EdgeDefinition definition) Add a new edge definition to the graph
GraphEntity	addVertexCollection(String name) Adds a vertex collection to the set of collections of the graph.
void	drop() Delete an existing graph
ArangoEdgeCollection	edgeCollection(String name) Returns a handler of the edge collection by the given name
Collection<String>	getEdgeDefinitions() Lists all edge collections used in this graph
GraphEntity	getInfo() Get a graph from the graph module
Collection<String>	getVertexCollections() Lists all vertex collections used in this graph
GraphEntity	removeEdgeDefinition(String definitionName) Remove one edge definition from the graph.
GraphEntity	replaceEdgeDefinition(EdgeDefinition definition) Change one specific edge definition.
ArangoVertexCollection	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, getEdgeDefinitionsDeserializer, getEdgeDefinitionsRequest, getInfoRequest, getInfoResponseDeserializer, getVertexCollectionsRequest, getVertexCollectionsResponseDeserializer, name, removeEdgeDefinitionRequest, removeEdgeDefinitionResponseDeserializer, replaceEdgeDefinitionRequest, replaceEdgeDefinitionResponseDeserializer

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

ArangoGraph

protected ArangoGraph(ArangoDatabase db,
                      String name)

Method Detail

drop

public void drop()
          throws ArangoDBException

Delete an existing graph

Throws:

ArangoDBException

See Also:

API Documentation

getInfo

public GraphEntity getInfo()
                    throws ArangoDBException

Get a graph from the graph module

Returns:

the definition content of this graph

Throws:

ArangoDBException

See Also:

API Documentation

getVertexCollections

public Collection<String> getVertexCollections()
                                        throws ArangoDBException

Lists all vertex collections used in this graph

Returns:

all vertex collections within this graph

Throws:

ArangoDBException

See Also:

API Documentation

addVertexCollection

public GraphEntity addVertexCollection(String name)
                                throws ArangoDBException

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

Parameters:

name - The name of the collection

Returns:

information about the graph

Throws:

ArangoDBException

See Also:

API Documentation

vertexCollection

public ArangoVertexCollection vertexCollection(String name)

Returns a handler of the vertex collection by the given name

Parameters:

name - Name of the vertex collection

Returns:

collection handler

edgeCollection

public ArangoEdgeCollection edgeCollection(String name)

Returns a handler of the edge collection by the given name

Parameters:

name - Name of the edge collection

Returns:

collection handler

getEdgeDefinitions

public Collection<String> getEdgeDefinitions()
                                      throws ArangoDBException

Lists all edge collections used in this graph

Returns:

all edge collections within this graph

Throws:

ArangoDBException

See Also:

API Documentation

addEdgeDefinition

public GraphEntity addEdgeDefinition(EdgeDefinition definition)
                              throws ArangoDBException

Add a new edge definition to the graph

Parameters:

definition -

Returns:

information about the graph

Throws:

ArangoDBException

See Also:

API Documentation

replaceEdgeDefinition

public GraphEntity replaceEdgeDefinition(EdgeDefinition definition)
                                  throws ArangoDBException

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

Parameters:

definition - The edge definition

Returns:

information about the graph

Throws:

ArangoDBException

See Also:

API Documentation

removeEdgeDefinition

public GraphEntity removeEdgeDefinition(String definitionName)
                                 throws ArangoDBException

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

Parameters:

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

Returns:

information about the graph

Throws:

ArangoDBException

See Also:

API Documentation