Package com.c8db.internal

Class C8GraphImpl

java.lang.Object

com.c8db.internal.C8Executeable<E>

com.c8db.internal.InternalC8Graph<C8DBImpl,C8DatabaseImpl,C8ExecutorSync>

com.c8db.internal.C8GraphImpl

All Implemented Interfaces:

C8Graph, C8SerializationAccessor

public class C8GraphImpl
extends InternalC8Graph<C8DBImpl,C8DatabaseImpl,C8ExecutorSync>
implements C8Graph

Field Summary

Fields inherited from class com.c8db.internal.InternalC8Graph

EDGE, PATH_API_GHARIAL, VERTEX

Fields inherited from class com.c8db.internal.C8Executeable

context, executor, util

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	C8GraphImpl(C8DatabaseImpl db, String name)

Method Summary

Modifier and Type	Method	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	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.
C8EdgeCollection	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.
C8VertexCollection	vertexCollection(String name)	Returns a ArangoVertexCollection instance for the given vertex collection name.

Methods inherited from class com.c8db.internal.InternalC8Graph

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

Methods inherited from class com.c8db.internal.C8Executeable

createPath, executor, request, util, util

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.c8db.C8Graph

db, name

Methods inherited from interface com.c8db.C8SerializationAccessor

util, util

Constructor Detail

C8GraphImpl

protected C8GraphImpl(C8DatabaseImpl db,
                      String name)

Method Detail

exists

public boolean exists()
               throws C8DBException

Description copied from interface: C8Graph

Checks whether the graph exists

Specified by:

exists in interface C8Graph

Returns:

true if the graph exists, otherwise false

Throws:

C8DBException

create

public GraphEntity create(Collection<EdgeDefinition> edgeDefinitions)
                   throws C8DBException

Description copied from interface: C8Graph

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 C8Graph

Parameters:

edgeDefinitions - An array of definitions for the edge

Returns:

information about the graph

Throws:

C8DBException

See Also:

API Documentation

create

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

Description copied from interface: C8Graph

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 C8Graph

Parameters:

edgeDefinitions - An array of definitions for the edge

options - Additional options, can be null

Returns:

information about the graph

Throws:

C8DBException

See Also:

API Documentation

drop

public void drop()
          throws C8DBException

Description copied from interface: C8Graph

Deletes the graph from the database.

Specified by:

drop in interface C8Graph

Throws:

C8DBException

See Also:

API Documentation

drop

public void drop(boolean dropCollections)
          throws C8DBException

Description copied from interface: C8Graph

Deletes the graph from the database.

Specified by:

drop in interface C8Graph

Parameters:

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

Throws:

C8DBException

See Also:

API Documentation

getInfo

public GraphEntity getInfo()
                    throws C8DBException

Description copied from interface: C8Graph

Retrieves general information about the graph.

Specified by:

getInfo in interface C8Graph

Returns:

the definition content of this graph

Throws:

C8DBException

See Also:

API Documentation

edgeCollection

public C8EdgeCollection edgeCollection(String name)

Description copied from interface: C8Graph

Returns a ArangoEdgeCollection instance for the given edge collection name.

Specified by:

edgeCollection in interface C8Graph

Parameters:

name - Name of the edge collection

Returns:

collection handler

getEdgeDefinitions

public Collection<String> getEdgeDefinitions()
                                      throws C8DBException

Description copied from interface: C8Graph

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

Specified by:

getEdgeDefinitions in interface C8Graph

Returns:

all edge collections within this graph

Throws:

C8DBException

See Also:

API Documentation

addEdgeDefinition

public GraphEntity addEdgeDefinition(EdgeDefinition definition)
                              throws C8DBException

Description copied from interface: C8Graph

Adds the given edge definition to the graph.

Specified by:

addEdgeDefinition in interface C8Graph

Parameters:

definition - The edge definition

Returns:

information about the graph

Throws:

C8DBException

See Also:

API Documentation

replaceEdgeDefinition

public GraphEntity replaceEdgeDefinition(EdgeDefinition definition)
                                  throws C8DBException

Description copied from interface: C8Graph

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 C8Graph

Parameters:

definition - The edge definition

Returns:

information about the graph

Throws:

C8DBException

See Also:

API Documentation

removeEdgeDefinition

public GraphEntity removeEdgeDefinition(String definitionName)
                                 throws C8DBException

Description copied from interface: C8Graph

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 C8Graph

Parameters:

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

Returns:

information about the graph

Throws:

C8DBException

See Also:

API Documentation

getVertexCollections

public Collection<String> getVertexCollections()
                                        throws C8DBException

Description copied from interface: C8Graph

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

Specified by:

getVertexCollections in interface C8Graph

Returns:

all vertex collections within this graph

Throws:

C8DBException

See Also:

API Documentation

addVertexCollection

public GraphEntity addVertexCollection(String name)
                                throws C8DBException

Description copied from interface: C8Graph

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 C8Graph

Parameters:

name - Name of the vertex collection

Returns:

information about the graph

Throws:

C8DBException

See Also:

API Documentation

vertexCollection

public C8VertexCollection vertexCollection(String name)

Description copied from interface: C8Graph

Returns a ArangoVertexCollection instance for the given vertex collection name.

Specified by:

vertexCollection in interface C8Graph

Parameters:

name - Name of the vertex collection

Returns:

collection handler