com.arangodb

Interface InternalGraphDriver

All Superinterfaces:

BaseDriverInterface

All Known Implementing Classes:

InternalGraphDriverImpl

public interface InternalGraphDriver
extends BaseDriverInterface

Method Summary

Modifier and Type	Method and Description
<T> EdgeEntity<T>	createEdge(String database, String graphName, String edgeCollectionName, String key, String fromHandle, String toHandle, T value, Boolean waitForSync)
GraphEntity	createEdgeDefinition(String databaseName, String graphName, EdgeDefinitionEntity edgeDefinition) Adds a new edge definition to an existing graph.
GraphEntity	createGraph(String databaseName, String graphName, Boolean waitForSync) Creates an empty graph.
GraphEntity	createGraph(String databaseName, String graphName, List<EdgeDefinitionEntity> edgeDefinitions, List<String> orphanCollections, Boolean waitForSync) Creates a graph.
<T> VertexEntity<T>	createVertex(String database, String graphName, String collectionName, String key, T vertex, Boolean waitForSync) Stores a new vertex with the information contained within the document into the given collection.
<T> VertexEntity<T>	createVertex(String database, String graphName, String collectionName, T vertex, Boolean waitForSync) Stores a new vertex with the information contained within the document into the given collection.
GraphEntity	createVertexCollection(String databaseName, String graphName, String collectionName)
DeletedEntity	deleteEdge(String database, String graphName, String edgeCollectionName, String key, Boolean waitForSync, Long rev, Long ifMatchRevision) Deletes an edge with the given id, if it is contained within the graph.
GraphEntity	deleteEdgeDefinition(String databaseName, String graphName, String edgeName, Boolean dropCollection) Removes an existing edge definition from this graph.
DeletedEntity	deleteGraph(String databaseName, String graphName, Boolean dropCollections) Delete a graph by its name.
DeletedEntity	deleteVertex(String database, String graphName, String collectionName, String key, Boolean waitForSync, Long ifMatchRevision, Long ifNoneMatchRevision) Deletes a vertex with the given key, if it is contained within the graph.
DeletedEntity	deleteVertexCollection(String databaseName, String graphName, String collectionName, Boolean dropCollection)
<T> EdgeEntity<T>	getEdge(String database, String graphName, String edgeCollectionName, String key, Class<T> clazz, Long ifMatchRevision, Long ifNoneMatchRevision) Loads an edge with the given key if it is contained within your graph.
List<String>	getEdgeCollections(String databaseName, String graphName) Returns a list of names of all edge collections of a graph that are defined in the graphs edgeDefinitions
<T> CursorEntity<EdgeEntity<T>>	getEdges(String database, String graphName, String vertexKey, Class<T> clazz, Integer batchSize, Integer limit, Boolean count, Direction direction, Collection<String> labels, ArangoDriver driver, FilterCondition... properties) Deprecated.
GraphEntity	getGraph(String databaseName, String graphName) Get graph object by name, including its edge definitions and vertex collections.
List<String>	getGraphList(String databaseName) Creates a list of the names of all available graphs.
GraphsEntity	getGraphs(String databaseName) Returns a GraphsEntity containing all graph as GraphEntity object.
<T> VertexEntity<T>	getVertex(String database, String graphName, String collectionName, String key, Class<T> clazz, Long ifMatchRevision, Long ifNoneMatchRevision) Gets a vertex with the given key if it is contained within your graph.
List<String>	getVertexCollections(String databaseName, String graphName) Returns a list of names of all vertex collections of a graph, defined in the graphs edgeDefinitions (in "from", "to", and "orphanCollections")
<T> EdgeEntity<T>	replaceEdge(String database, String graphName, String edgeCollectionName, String key, T value, Boolean waitForSync, Long ifMatchRevision, Long ifNoneMatchRevision) Replaces an edge with the given key by the content in the body.
GraphEntity	replaceEdgeDefinition(String databaseName, String graphName, String edgeName, EdgeDefinitionEntity edgeDefinition) Replaces an existing edge definition to an existing graph.
<T> VertexEntity<T>	replaceVertex(String database, String graphName, String collectionName, String key, T vertex, Boolean waitForSync, Long ifMatchRevision, Long ifNoneMatchRevision) Replaces a vertex with the given key by the content in the body.
<T> EdgeEntity<T>	updateEdge(String database, String graphName, String edgeCollectionName, String key, T value, Boolean waitForSync, Boolean keepNull, Long ifMatchRevision, Long ifNoneMatchRevision) Updates an edge with the given key by adding the content in the body.
<T> VertexEntity<T>	updateVertex(String databaseName, String graphName, String collectionName, String key, T vertex, Boolean keepNull, Boolean waitForSync, Long ifMatchRevision, Long ifNoneMatchRevision) Updates a vertex with the given key by adding the content in the body.

Methods inherited from interface com.arangodb.impl.BaseDriverInterface

getHttpManager, setHttpManager

Method Detail

createGraph

GraphEntity createGraph(String databaseName,
                        String graphName,
                        Boolean waitForSync)
                 throws ArangoException

Creates an empty graph.

Parameters:

databaseName -

graphName -

waitForSync -

Returns:

GraphEntity

Throws:

ArangoException

createGraph

GraphEntity createGraph(String databaseName,
                        String graphName,
                        List<EdgeDefinitionEntity> edgeDefinitions,
                        List<String> orphanCollections,
                        Boolean waitForSync)
                 throws ArangoException

Creates a graph.

Parameters:

databaseName -

graphName -

edgeDefinitions -

orphanCollections -

waitForSync -

Returns:

GraphEntity

Throws:

ArangoException

getGraphs

GraphsEntity getGraphs(String databaseName)
                throws ArangoException

Returns a GraphsEntity containing all graph as GraphEntity object.

Parameters:

databaseName -

Returns:

GraphsEntity

Throws:

ArangoException

getGraphList

List<String> getGraphList(String databaseName)
                   throws ArangoException

Creates a list of the names of all available graphs.

Parameters:

databaseName -

Returns:

List

Throws:

ArangoException

getGraph

GraphEntity getGraph(String databaseName,
                     String graphName)
              throws ArangoException

Get graph object by name, including its edge definitions and vertex collections.

Parameters:

databaseName -

graphName -

Returns:

GraphEntity

Throws:

ArangoException

deleteGraph

DeletedEntity deleteGraph(String databaseName,
                          String graphName,
                          Boolean dropCollections)
                   throws ArangoException

Delete a graph by its name. If dropCollections is true, all collections of the graph will be dropped, if they are not used in another graph.

Parameters:

databaseName -

graphName -

dropCollections -

Returns:

DeletedEntity

Throws:

ArangoException

getVertexCollections

List<String> getVertexCollections(String databaseName,
                                  String graphName)
                           throws ArangoException

Returns a list of names of all vertex collections of a graph, defined in the graphs edgeDefinitions (in "from", "to", and "orphanCollections")

Parameters:

databaseName -

graphName -

Returns:

List

Throws:

ArangoException

createVertexCollection

GraphEntity createVertexCollection(String databaseName,
                                   String graphName,
                                   String collectionName)
                            throws ArangoException

Parameters:

databaseName -

graphName -

collectionName -

Returns:

GraphEntity

Throws:

ArangoException

deleteVertexCollection

DeletedEntity deleteVertexCollection(String databaseName,
                                     String graphName,
                                     String collectionName,
                                     Boolean dropCollection)
                              throws ArangoException

Parameters:

databaseName -

graphName -

collectionName -

dropCollection -

Returns:

DeletedEntity

Throws:

ArangoException

getEdgeCollections

List<String> getEdgeCollections(String databaseName,
                                String graphName)
                         throws ArangoException

Returns a list of names of all edge collections of a graph that are defined in the graphs edgeDefinitions

Parameters:

databaseName -

graphName -

Returns:

List

Throws:

ArangoException

createEdgeDefinition

GraphEntity createEdgeDefinition(String databaseName,
                                 String graphName,
                                 EdgeDefinitionEntity edgeDefinition)
                          throws ArangoException

Adds a new edge definition to an existing graph.

Parameters:

databaseName -

graphName -

edgeDefinition -

Returns:

GraphEntity

Throws:

ArangoException

replaceEdgeDefinition

GraphEntity replaceEdgeDefinition(String databaseName,
                                  String graphName,
                                  String edgeName,
                                  EdgeDefinitionEntity edgeDefinition)
                           throws ArangoException

Replaces an existing edge definition to an existing graph. This will also change the edge definitions of all other graphs using this definition as well.

Parameters:

databaseName -

graphName -

edgeName -

edgeDefinition -

Returns:

GraphEntity

Throws:

ArangoException

deleteEdgeDefinition

GraphEntity deleteEdgeDefinition(String databaseName,
                                 String graphName,
                                 String edgeName,
                                 Boolean dropCollection)
                          throws ArangoException

Removes an existing edge definition from this graph. All data stored in the collections is dropped as well as long as it is not used in other graphs.

Parameters:

databaseName -

graphName -

edgeName -

dropCollection -

Returns:

GraphEntity

Throws:

ArangoException

createVertex

<T> VertexEntity<T> createVertex(String database,
                                 String graphName,
                                 String collectionName,
                                 T vertex,
                                 Boolean waitForSync)
                          throws ArangoException

Stores a new vertex with the information contained within the document into the given collection.

Parameters:

database -

graphName -

collectionName -

vertex -

waitForSync -

Returns:

DocumentEntity

Throws:

ArangoException

createVertex

<T> VertexEntity<T> createVertex(String database,
                                 String graphName,
                                 String collectionName,
                                 String key,
                                 T vertex,
                                 Boolean waitForSync)
                          throws ArangoException

Stores a new vertex with the information contained within the document into the given collection.

Parameters:

database -

graphName -

collectionName -

key -

vertex -

waitForSync -

Returns:

DocumentEntity

Throws:

ArangoException

getVertex

<T> VertexEntity<T> getVertex(String database,
                              String graphName,
                              String collectionName,
                              String key,
                              Class<T> clazz,
                              Long ifMatchRevision,
                              Long ifNoneMatchRevision)
                       throws ArangoException

Gets a vertex with the given key if it is contained within your graph.

Parameters:

database -

graphName -

collectionName -

key -

clazz -

ifMatchRevision -

ifNoneMatchRevision -

Returns:

a VertexEntity object

Throws:

ArangoException

replaceVertex

<T> VertexEntity<T> replaceVertex(String database,
                                  String graphName,
                                  String collectionName,
                                  String key,
                                  T vertex,
                                  Boolean waitForSync,
                                  Long ifMatchRevision,
                                  Long ifNoneMatchRevision)
                           throws ArangoException

Replaces a vertex with the given key by the content in the body. This will only run successfully if the vertex is contained within the graph.

Parameters:

database -

graphName -

collectionName -

key -

vertex -

waitForSync -

ifMatchRevision -

ifNoneMatchRevision -

Returns:

DocumentEntity

Throws:

ArangoException

updateVertex

<T> VertexEntity<T> updateVertex(String databaseName,
                                 String graphName,
                                 String collectionName,
                                 String key,
                                 T vertex,
                                 Boolean keepNull,
                                 Boolean waitForSync,
                                 Long ifMatchRevision,
                                 Long ifNoneMatchRevision)
                          throws ArangoException

Updates a vertex with the given key by adding the content in the body. This will only run successfully if the vertex is contained within the graph.

Parameters:

databaseName -

graphName -

collectionName -

key -

vertex -

keepNull -

waitForSync -

ifMatchRevision -

ifNoneMatchRevision -

Returns:

a VertexEntity object

Throws:

ArangoException

deleteVertex

DeletedEntity deleteVertex(String database,
                           String graphName,
                           String collectionName,
                           String key,
                           Boolean waitForSync,
                           Long ifMatchRevision,
                           Long ifNoneMatchRevision)
                    throws ArangoException

Deletes a vertex with the given key, if it is contained within the graph. Furthermore all edges connected to this vertex will be deleted.

Parameters:

database -

graphName -

collectionName -

key -

waitForSync -

ifMatchRevision -

ifNoneMatchRevision -

Returns:

a DeletedEntity object

Throws:

ArangoException

createEdge

<T> EdgeEntity<T> createEdge(String database,
                             String graphName,
                             String edgeCollectionName,
                             String key,
                             String fromHandle,
                             String toHandle,
                             T value,
                             Boolean waitForSync)
                      throws ArangoException

Parameters:

database -

graphName -

edgeCollectionName -

key -

fromHandle -

toHandle -

value -

waitForSync -

Returns:

a EdgeEntity object

Throws:

ArangoException

getEdge

<T> EdgeEntity<T> getEdge(String database,
                          String graphName,
                          String edgeCollectionName,
                          String key,
                          Class<T> clazz,
                          Long ifMatchRevision,
                          Long ifNoneMatchRevision)
                   throws ArangoException

Loads an edge with the given key if it is contained within your graph.

Parameters:

database -

graphName -

edgeCollectionName -

key -

clazz -

ifNoneMatchRevision -

ifMatchRevision -

Returns:

a EdgeEntity object

Throws:

ArangoException

deleteEdge

DeletedEntity deleteEdge(String database,
                         String graphName,
                         String edgeCollectionName,
                         String key,
                         Boolean waitForSync,
                         Long rev,
                         Long ifMatchRevision)
                  throws ArangoException

Deletes an edge with the given id, if it is contained within the graph.

Parameters:

database -

graphName -

edgeCollectionName -

key -

waitForSync -

rev -

ifMatchRevision -

Returns:

DeletedEntity

Throws:

ArangoException

replaceEdge

<T> EdgeEntity<T> replaceEdge(String database,
                              String graphName,
                              String edgeCollectionName,
                              String key,
                              T value,
                              Boolean waitForSync,
                              Long ifMatchRevision,
                              Long ifNoneMatchRevision)
                       throws ArangoException

Replaces an edge with the given key by the content in the body. This will only run successfully if the edge is contained within the graph.

Parameters:

database -

graphName -

edgeCollectionName -

key -

value -

waitForSync -

ifMatchRevision -

ifNoneMatchRevision -

Returns:

EdgeEntity

Throws:

ArangoException

updateEdge

<T> EdgeEntity<T> updateEdge(String database,
                             String graphName,
                             String edgeCollectionName,
                             String key,
                             T value,
                             Boolean waitForSync,
                             Boolean keepNull,
                             Long ifMatchRevision,
                             Long ifNoneMatchRevision)
                      throws ArangoException

Updates an edge with the given key by adding the content in the body. This will only run successfully if the edge is contained within the graph.

Parameters:

database -

graphName -

edgeCollectionName -

key -

value -

waitForSync -

keepNull -

ifMatchRevision -

ifNoneMatchRevision -

Returns:

EdgeEntity

Throws:

ArangoException

getEdges

@Deprecated
<T> CursorEntity<EdgeEntity<T>> getEdges(String database,
                                                     String graphName,
                                                     String vertexKey,
                                                     Class<T> clazz,
                                                     Integer batchSize,
                                                     Integer limit,
                                                     Boolean count,
                                                     Direction direction,
                                                     Collection<String> labels,
                                                     ArangoDriver driver,
                                                     FilterCondition... properties)
                                              throws ArangoException

Deprecated.

Parameters:

database -

graphName -

vertexKey -

clazz -

batchSize -

limit -

count -

direction -

labels -

driver -

properties -

Returns:

a CursorEntity object

Throws:

ArangoException