com.arangodb.internal

Class ArangoGraphImpl

java.lang.Object

com.arangodb.internal.ArangoExecuteable<E>

com.arangodb.internal.InternalArangoGraph<ArangoDBImpl,ArangoDatabaseImpl,ArangoExecutorSync>

com.arangodb.internal.ArangoGraphImpl

All Implemented Interfaces:

ArangoGraph, ArangoSerdeAccessor

public class ArangoGraphImpl
extends InternalArangoGraph<ArangoDBImpl,ArangoDatabaseImpl,ArangoExecutorSync>
implements ArangoGraph

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArangoGraphImpl(ArangoDatabaseImpl db, String name)

Method Summary

Modifier and Type	Method and Description
GraphEntity	addEdgeDefinition(EdgeDefinition definition) Adds the given edge definition to the graph.
GraphEntity	addVertexCollection(String name) Adds a vertex collection to the set of collections of the graph.
GraphEntity	addVertexCollection(String name, VertexCollectionCreateOptions options) Adds a vertex collection to the set of collections of the graph.
GraphEntity	create(Collection<EdgeDefinition> edgeDefinitions) Creates the graph in the graph module.
GraphEntity	create(Collection<EdgeDefinition> edgeDefinitions, GraphCreateOptions options) Creates the graph in the graph module.
void	drop() Deletes the graph from the database.
void	drop(boolean dropCollections) Deletes the graph from the database.
ArangoEdgeCollection	edgeCollection(String name) Returns a ArangoEdgeCollection instance for the given edge collection name.
boolean	exists() Checks whether the graph exists
Collection<String>	getEdgeDefinitions() Fetches all edge collections from the graph and returns a list of collection names.
GraphEntity	getInfo() Retrieves general information about the graph.
Collection<String>	getVertexCollections() Fetches all vertex collections from the graph and returns a list of collection names.
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 ArangoVertexCollection instance for the given vertex collection 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.ArangoGraph

db, name

Methods inherited from interface com.arangodb.ArangoSerdeAccessor

getSerde

Constructor Detail

ArangoGraphImpl

protected ArangoGraphImpl(ArangoDatabaseImpl db,
                          String name)

Method Detail

exists

public boolean exists()

Description copied from interface: ArangoGraph

Checks whether the graph exists

Specified by:

exists in interface ArangoGraph

Returns:

true if the graph exists, otherwise false

create

public GraphEntity create(Collection<EdgeDefinition> edgeDefinitions)

Description copied from interface: ArangoGraph

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 ArangoGraph

Parameters:

edgeDefinitions - An array of definitions for the edge

Returns:

information about the graph

See Also:

API Documentation

create

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

Description copied from interface: ArangoGraph

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 ArangoGraph

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 void drop()

Description copied from interface: ArangoGraph

Deletes the graph from the database.

Specified by:

drop in interface ArangoGraph

See Also:

API Documentation

drop

public void drop(boolean dropCollections)

Description copied from interface: ArangoGraph

Deletes the graph from the database.

Specified by:

drop in interface ArangoGraph

Parameters:

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

See Also:

API Documentation

getInfo

public GraphEntity getInfo()

Description copied from interface: ArangoGraph

Retrieves general information about the graph.

Specified by:

getInfo in interface ArangoGraph

Returns:

the definition content of this graph

See Also:

API Documentation

getVertexCollections

public Collection<String> getVertexCollections()

Description copied from interface: ArangoGraph

Fetches all vertex collections from the graph and returns a list of collection names.

Specified by:

getVertexCollections in interface ArangoGraph

Returns:

all vertex collections within this graph

See Also:

API Documentation

addVertexCollection

public GraphEntity addVertexCollection(String name)

Description copied from interface: ArangoGraph

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 ArangoGraph

Parameters:

name - Name of the vertex collection

Returns:

information about the graph

See Also:

API Documentation

addVertexCollection

public GraphEntity addVertexCollection(String name,
                                       VertexCollectionCreateOptions options)

Description copied from interface: ArangoGraph

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 ArangoGraph

Parameters:

name - Name of the vertex collection

options - additional options

Returns:

information about the graph

See Also:

API Documentation

vertexCollection

public ArangoVertexCollection vertexCollection(String name)

Description copied from interface: ArangoGraph

Returns a ArangoVertexCollection instance for the given vertex collection name.

Specified by:

vertexCollection in interface ArangoGraph

Parameters:

name - Name of the vertex collection

Returns:

collection handler

edgeCollection

public ArangoEdgeCollection edgeCollection(String name)

Description copied from interface: ArangoGraph

Returns a ArangoEdgeCollection instance for the given edge collection name.

Specified by:

edgeCollection in interface ArangoGraph

Parameters:

name - Name of the edge collection

Returns:

collection handler

getEdgeDefinitions

public Collection<String> getEdgeDefinitions()

Description copied from interface: ArangoGraph

Fetches all edge collections from the graph and returns a list of collection names.

Specified by:

getEdgeDefinitions in interface ArangoGraph

Returns:

all edge collections within this graph

See Also:

API Documentation

addEdgeDefinition

public GraphEntity addEdgeDefinition(EdgeDefinition definition)

Description copied from interface: ArangoGraph

Adds the given edge definition to the graph.

Specified by:

addEdgeDefinition in interface ArangoGraph

Parameters:

definition - The edge definition

Returns:

information about the graph

See Also:

API Documentation

replaceEdgeDefinition

public GraphEntity replaceEdgeDefinition(EdgeDefinition definition)

Description copied from interface: ArangoGraph

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 ArangoGraph

Parameters:

definition - The edge definition

Returns:

information about the graph

See Also:

API Documentation

removeEdgeDefinition

public GraphEntity removeEdgeDefinition(String definitionName)

Description copied from interface: ArangoGraph

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 ArangoGraph

Parameters:

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

Returns:

information about the graph

See Also:

API Documentation