com.arangodb.impl

Class InternalGraphDriverImpl

java.lang.Object

com.arangodb.BaseArangoDriver

com.arangodb.impl.InternalGraphDriverImpl

All Implemented Interfaces:

BaseDriverInterface, InternalGraphDriver

public class InternalGraphDriverImpl
extends BaseArangoDriver
implements InternalGraphDriver

Author:

tamtam180 - kirscheless at gmail.com, gschwab, a-brandt

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotationHandler	annotationHandler
protected static String	COLLECTION
protected ArangoConfigure	configure
protected InternalCursorDriver	cursorDriver
protected HttpManager	httpManager

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 ifMatchRevision, Long ifNoneMatchRevision) 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 databaseName, 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) Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph.
<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
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.
HttpManager	getHttpManager()
<T> VertexEntity<T>	getVertex(String databaseName, 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, boolean excludeOrphan) 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, String fromHandle, String toHandle, 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 databaseName, 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.
void	setHttpManager(HttpManager httpManager)
<T> EdgeEntity<T>	updateEdge(String database, String graphName, String edgeCollectionName, String key, String fromHandle, String toHandle, 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 class com.arangodb.BaseArangoDriver

createDocumentEndpointUrl, createDocumentHandle, createDocumentHandle, createEndpointUrl, createEndpointUrl, createEntity, createEntity, createEntity, createEntity, createEntityImpl, createGharialEndpointUrl, createIndexEndpointUrl, createJobEndpointUrl, createUserEndpointUrl, getJSONResponseText, setKeyValueHeader, setStatusCode, toReplicationDumpHeader, validate, validateCollectionName, validateDatabaseName, validateDocumentHandle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.arangodb.impl.BaseDriverInterface

getHttpManager, setHttpManager

Field Detail

cursorDriver

protected InternalCursorDriver cursorDriver

COLLECTION

protected static final String COLLECTION

See Also:

Constant Field Values

configure

protected ArangoConfigure configure

httpManager

protected HttpManager httpManager

annotationHandler

protected AnnotationHandler annotationHandler

Method Detail

createGraph

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

Description copied from interface: InternalGraphDriver

Creates an empty graph.

Specified by:

createGraph in interface InternalGraphDriver

Returns:

GraphEntity

Throws:

ArangoException

createGraph

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

Description copied from interface: InternalGraphDriver

Creates a graph.

Specified by:

createGraph in interface InternalGraphDriver

Returns:

GraphEntity

Throws:

ArangoException

getGraphs

public GraphsEntity getGraphs(String databaseName)
                       throws ArangoException

Description copied from interface: InternalGraphDriver

Returns a GraphsEntity containing all graph as GraphEntity object.

Specified by:

getGraphs in interface InternalGraphDriver

Returns:

GraphsEntity

Throws:

ArangoException

getGraphList

public List<String> getGraphList(String databaseName)
                          throws ArangoException

Description copied from interface: InternalGraphDriver

Creates a list of the names of all available graphs.

Specified by:

getGraphList in interface InternalGraphDriver

Returns:

List

Throws:

ArangoException

getGraph

public GraphEntity getGraph(String databaseName,
                            String graphName)
                     throws ArangoException

Description copied from interface: InternalGraphDriver

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

Specified by:

getGraph in interface InternalGraphDriver

Returns:

GraphEntity

Throws:

ArangoException

deleteGraph

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

Description copied from interface: InternalGraphDriver

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.

Specified by:

deleteGraph in interface InternalGraphDriver

Returns:

DeletedEntity

Throws:

ArangoException

getVertexCollections

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

Description copied from interface: InternalGraphDriver

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

Specified by:

getVertexCollections in interface InternalGraphDriver

Returns:

List

Throws:

ArangoException

deleteVertexCollection

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

Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph.

Specified by:

deleteVertexCollection in interface InternalGraphDriver

Parameters:

databaseName -

graphName -

collectionName -

dropCollection -

Returns:

DeletedEntity

Throws:

ArangoException

createVertexCollection

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

Specified by:

createVertexCollection in interface InternalGraphDriver

Returns:

GraphEntity

Throws:

ArangoException

getEdgeCollections

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

Description copied from interface: InternalGraphDriver

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

Specified by:

getEdgeCollections in interface InternalGraphDriver

Returns:

List

Throws:

ArangoException

createEdgeDefinition

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

Description copied from interface: InternalGraphDriver

Adds a new edge definition to an existing graph.

Specified by:

createEdgeDefinition in interface InternalGraphDriver

Returns:

GraphEntity

Throws:

ArangoException

replaceEdgeDefinition

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

Description copied from interface: InternalGraphDriver

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.

Specified by:

replaceEdgeDefinition in interface InternalGraphDriver

Returns:

GraphEntity

Throws:

ArangoException

deleteEdgeDefinition

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

Description copied from interface: InternalGraphDriver

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.

Specified by:

deleteEdgeDefinition in interface InternalGraphDriver

Returns:

GraphEntity

Throws:

ArangoException

createVertex

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

Description copied from interface: InternalGraphDriver

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

Specified by:

createVertex in interface InternalGraphDriver

Returns:

DocumentEntity

Throws:

ArangoException

createVertex

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

Description copied from interface: InternalGraphDriver

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

Specified by:

createVertex in interface InternalGraphDriver

Returns:

DocumentEntity

Throws:

ArangoException

getVertex

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

Description copied from interface: InternalGraphDriver

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

Specified by:

getVertex in interface InternalGraphDriver

Returns:

a VertexEntity object

Throws:

ArangoException

replaceVertex

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

Description copied from interface: InternalGraphDriver

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.

Specified by:

replaceVertex in interface InternalGraphDriver

Returns:

DocumentEntity

Throws:

ArangoException

updateVertex

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

Description copied from interface: InternalGraphDriver

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.

Specified by:

updateVertex in interface InternalGraphDriver

Returns:

a VertexEntity object

Throws:

ArangoException

deleteVertex

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

Description copied from interface: InternalGraphDriver

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

Specified by:

deleteVertex in interface InternalGraphDriver

Returns:

a DeletedEntity object

Throws:

ArangoException

createEdge

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

Specified by:

createEdge in interface InternalGraphDriver

Returns:

a EdgeEntity object

Throws:

ArangoException

getEdge

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

Description copied from interface: InternalGraphDriver

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

Specified by:

getEdge in interface InternalGraphDriver

Returns:

a EdgeEntity object

Throws:

ArangoException

deleteEdge

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

Description copied from interface: InternalGraphDriver

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

Specified by:

deleteEdge in interface InternalGraphDriver

Returns:

DeletedEntity

Throws:

ArangoException

replaceEdge

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

Description copied from interface: InternalGraphDriver

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.

Specified by:

replaceEdge in interface InternalGraphDriver

Returns:

EdgeEntity

Throws:

ArangoException

updateEdge

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

Description copied from interface: InternalGraphDriver

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.

Specified by:

updateEdge in interface InternalGraphDriver

Returns:

EdgeEntity

Throws:

ArangoException

getHttpManager

public HttpManager getHttpManager()

Specified by:

getHttpManager in interface BaseDriverInterface

setHttpManager

public void setHttpManager(HttpManager httpManager)

Specified by:

setHttpManager in interface BaseDriverInterface