OrientBaseGraph (OrientDB GraphDB 1.7 API)

java.lang.Object
- com.tinkerpop.blueprints.impls.orient.OrientBaseGraph

All Implemented Interfaces:

com.tinkerpop.blueprints.Graph, com.tinkerpop.blueprints.IndexableGraph, com.tinkerpop.blueprints.KeyIndexableGraph, com.tinkerpop.blueprints.MetaGraph<ODatabaseDocumentTx>

Direct Known Subclasses:

OrientGraphNoTx, OrientTransactionalGraph
```
public abstract class OrientBaseGraph
extends Object
implements com.tinkerpop.blueprints.IndexableGraph, com.tinkerpop.blueprints.MetaGraph<ODatabaseDocumentTx>, com.tinkerpop.blueprints.KeyIndexableGraph
```
A Blueprints implementation of the graph database OrientDB (http://www.orientechnologies.com)

Author:

Luca Garulli (http://www.orientechnologies.com)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class OrientBaseGraph.Settings

static class OrientBaseGraph.THREAD_MODE

Nested Classes
Modifier and Type	Class and Description
`class`	`OrientBaseGraph.Settings`
`static class`	`OrientBaseGraph.THREAD_MODE`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ADMIN`
`static String`	`CLASS_PREFIX`
`static String`	`CLUSTER_PREFIX`
`static String`	`CONNECTION_IN`
`static String`	`CONNECTION_OUT`
`protected OrientBaseGraph.Settings`	`settings`

Constructor Summary

Constructors
Constructor and Description
`OrientBaseGraph(org.apache.commons.configuration.Configuration configuration)` Builds a OrientGraph instance passing a configuration.
`OrientBaseGraph(ODatabaseDocumentPool pool)`
`OrientBaseGraph(ODatabaseDocumentTx iDatabase)` Constructs a new object using an existent database instance.
`OrientBaseGraph(String url)`
`OrientBaseGraph(String url, String username, String password)`

Method Summary

Methods
Modifier and Type	Method and Description
`OrientEdge`	`addEdge(Object id, com.tinkerpop.blueprints.Vertex outVertex, com.tinkerpop.blueprints.Vertex inVertex, String label)` Creates an edge between a source Vertex and a destination Vertex setting label as Edge's label.
`OrientVertex`	`addTemporaryVertex(String iClassName, Object... prop)` (Blueprints Extension) Creates a temporary vertex setting the initial field values.
`OrientVertex`	`addVertex(Object id)` Creates a new unconnected vertex with no fields in the Graph.
`OrientVertex`	`addVertex(Object id, Object... prop)` (Blueprints Extension) Creates a new unconnected vertex in the Graph setting the initial field values.
`OrientVertex`	`addVertex(String iClassName, String iClusterName)` (Blueprints Extension) Creates a new unconnected vertex with no fields of specific class in a cluster in the Graph.
`OrientElement`	`attach(OrientElement iElement)` Attaches a previously detached Graph Element to the current Graph.
`protected void`	`autoStartTransaction()`
`protected void`	`checkForGraphSchema(ODatabaseDocumentTx iDatabase)`
`OCommandRequest`	`command(OCommandRequest iCommand)` Executes commands against the graph.
`void`	`commit()` Commits the current active transaction.
`protected Object`	`convertKey(OIndex<?> idx, Object iValue)`
`protected Object[]`	`convertKeys(OIndex<?> idx, Object[] iValue)`
`long`	`countEdges()` Counts the edges in graph.
`long`	`countEdges(String iClassName)` Counts the edges in graph of a particular class.
`long`	`countVertices()` Counts the vertices in graph.
`long`	`countVertices(String iClassName)` Counts the vertices in graph of a particular class.
`OrientEdgeType`	`createEdgeType(String iClassName)` Creates a new Edge persistent class.
`OrientEdgeType`	`createEdgeType(String iClassName, OClass iSuperClass)` Creates a new Edge persistent class specifying the super class.
`OrientEdgeType`	`createEdgeType(String iClassName, String iSuperClassName)` Creates a new Edge persistent class specifying the super class.
`<T extends com.tinkerpop.blueprints.Element> com.tinkerpop.blueprints.Index<T>`	`createIndex(String indexName, Class<T> indexClass, com.tinkerpop.blueprints.Parameter... indexParameters)`
`<T extends com.tinkerpop.blueprints.Element> void`	`createKeyIndex(String key, Class<T> elementClass, com.tinkerpop.blueprints.Parameter... indexParameters)` Creates an automatic indexing structure for indexing provided key for element class.
`OrientVertexType`	`createVertexType(String iClassName)` Creates a new Vertex persistent class.
`OrientVertexType`	`createVertexType(String iClassName, OClass iSuperClass)` Creates a new Vertex persistent class specifying the super class.
`OrientVertexType`	`createVertexType(String iClassName, String iSuperClassName)` Creates a new Vertex persistent class specifying the super class.
`static String`	`decodeClassName(String iClassName)` (Internal)
`OrientElement`	`detach(OrientElement iElement)` Detaches a Graph Element to be used offline.
`void`	`drop()` (Blueprints Extension) Drops the database
`void`	`dropEdgeType(String iTypeName)` Drops an edge class.
`void`	`dropIndex(String indexName)` Drops an index by name.
`<T extends com.tinkerpop.blueprints.Element> void`	`dropKeyIndex(String key, Class<T> elementClass)` Drops the index against a field name.
`void`	`dropVertexType(String iTypeName)` Drop a vertex class.
`static String`	`encodeClassName(String iClassName)` (Internal)
`static void`	`encodeClassNames(String... iLabels)` (Internal)
`protected <RET> RET`	`executeOutsideTx(OCallable<RET,OrientBaseGraph> iCallable, String... iOperationStrings)`
`protected <T> String`	`getClassName(Class<T> elementClass)`
`protected com.tinkerpop.blueprints.impls.orient.OrientGraphContext`	`getContext(boolean create)`
`OrientEdge`	`getEdge(Object id)` Returns a edge by an ID.
`OrientEdgeType`	`getEdgeBaseType()` Returns the E persistent class as OrientEdgeType instance.
`Iterable<com.tinkerpop.blueprints.Edge>`	`getEdges()` Returns all the edges in Graph.
`Iterable<com.tinkerpop.blueprints.Edge>`	`getEdges(boolean iPolymorphic)` Get all the Edges in Graph specifying if consider or not sub-classes of E.
`Iterable<com.tinkerpop.blueprints.Edge>`	`getEdges(String iKey, Object iValue)` Get all the Edges in Graph filtering by field name and value.
`Iterable<com.tinkerpop.blueprints.Edge>`	`getEdgesOfClass(String iClassName)` Get all the Edges in Graph of a specific edge class and all sub-classes.
`Iterable<com.tinkerpop.blueprints.Edge>`	`getEdgesOfClass(String iClassName, boolean iPolymorphic)` Get all the Edges in Graph of a specific edges class and all sub-classes only if iPolymorphic is true.
`OrientEdgeType`	`getEdgeType(String iTypeName)` Returns the persistent class for type iTypeName as OrientEdgeType instance.
`OrientElement`	`getElement(Object id)` Returns a graph element, vertex or edge, starting from an ID.
`<T extends com.tinkerpop.blueprints.Element> com.tinkerpop.blueprints.Index<T>`	`getIndex(String indexName, Class<T> indexClass)` Returns an index by name and class
`<T extends com.tinkerpop.blueprints.Element> Set<String>`	`getIndexedKeys(Class<T> elementClass)` Returns the indexed properties.
`<T extends com.tinkerpop.blueprints.Element> Set<String>`	`getIndexedKeys(Class<T> elementClass, boolean includeClassNames)` Returns the indexed properties.
`Iterable<com.tinkerpop.blueprints.Index<? extends com.tinkerpop.blueprints.Element>>`	`getIndices()` Returns all the indices.
`ODatabaseDocumentTx`	`getRawGraph()` Returns the underlying Database instance as ODatabaseDocumentTx instance.
`OrientBaseGraph.THREAD_MODE`	`getThreadMode()` Returns the current thread mode: MANUAL the user has to manually invoke the current database in Thread Local: ODatabaseRecordThreadLocal.INSTANCE.set(graph.getRawGraph()); AUTOSET_IFNULL (default) each call assures the current graph instance is set in the Thread Local only if no one was set before ALWAYS_AUTOSET each call assures the current graph instance is set in the Thread Local
`OrientVertex`	`getVertex(Object id)` Returns a vertex by an ID.
`OrientVertexType`	`getVertexBaseType()` Returns the V persistent class as OrientVertexType instance.
`OrientVertexType`	`getVertexType(String iTypeName)` Returns the persistent class for type iTypeName as OrientVertexType instance.
`Iterable<com.tinkerpop.blueprints.Vertex>`	`getVertices()` Get all the Vertices in Graph.
`Iterable<com.tinkerpop.blueprints.Vertex>`	`getVertices(boolean iPolymorphic)` Get all the Vertices in Graph specifying if consider or not sub-classes of V.
`Iterable<com.tinkerpop.blueprints.Vertex>`	`getVertices(String iKey, Object iValue)` Get all the Vertices in Graph filtering by field name and value.
`Iterable<com.tinkerpop.blueprints.Vertex>`	`getVertices(String label, String[] iKey, Object[] iValue)` Get all the Vertices in Graph filtering by field name and value.
`Iterable<com.tinkerpop.blueprints.Vertex>`	`getVerticesOfClass(String iClassName)` Get all the Vertices in Graph of a specific vertex class and all sub-classes.
`Iterable<com.tinkerpop.blueprints.Vertex>`	`getVerticesOfClass(String iClassName, boolean iPolymorphic)` Get all the Vertices in Graph of a specific vertex class and all sub-classes only if iPolymorphic is true.
`boolean`	`isClosed()` Checks if the Graph has been closed.
`boolean`	`isKeepInMemoryReferences()` Returns true if the references are kept in memory.
`boolean`	`isSaveOriginalIds()` Returns true if it saves the original Id, otherwise false.
`boolean`	`isStandardElementConstraints()` Returns true if Blueprints standard constraints are applied to elements.
`boolean`	`isUseClassForEdgeLabel()` Returns true if the class are use for Edge labels.
`boolean`	`isUseClassForVertexLabel()` Returns true if the class are use for Vertex labels.
`boolean`	`isUseLightweightEdges()` Returns true if is using lightweight edges, otherwise false.
`boolean`	`isUseVertexFieldsForEdgeLabels()` Returns true if the out/in fields in vertex are post-fixed with edge labels.
`boolean`	`isWarnOnForceClosingTx()` Returns true if the warning is generated on force the graph closing.
`com.tinkerpop.blueprints.GraphQuery`	`query()` Returns a GraphQuery object to execute queries against the Graph.
`protected void`	`removeContext()` Removes the current context.
`void`	`removeEdge(com.tinkerpop.blueprints.Edge edge)` Removes an edge from the Graph.
`void`	`removeVertex(com.tinkerpop.blueprints.Vertex vertex)` Removes a vertex from the Graph.
`OrientBaseGraph`	`reuse(ODatabaseDocumentTx iDatabase)` Reuses the underlying database avoiding to create and open it every time.
`void`	`rollback()` Rollbacks the current active transaction.
`protected void`	`saveIndexConfiguration()`
`protected void`	`setCurrentGraphInThreadLocal()`
`void`	`setKeepInMemoryReferences(boolean useReferences)` Changes the setting about using references in memory.
`void`	`setSaveOriginalIds(boolean saveIds)` Changes the setting about usage of lightweight edges.
`void`	`setStandardElementConstraints(boolean allowsPropertyValueNull)` Changes the setting to apply the Blueprints standard constraints against elements.
`OrientBaseGraph`	`setThreadMode(OrientBaseGraph.THREAD_MODE iControl)` Changes the thread mode: MANUAL the user has to manually invoke the current database in Thread Local: ODatabaseRecordThreadLocal.INSTANCE.set(graph.getRawGraph()); AUTOSET_IFNULL (default) each call assures the current graph instance is set in the Thread Local only if no one was set before ALWAYS_AUTOSET each call assures the current graph instance is set in the Thread Local
`void`	`setUseClassForEdgeLabel(boolean useCustomClassesForEdges)` Changes the setting to use the Edge class for Edge labels.
`void`	`setUseClassForVertexLabel(boolean useCustomClassesForVertex)` Changes the setting to use the Vertex class for Vertex labels.
`void`	`setUseLightweightEdges(boolean useDynamicEdges)` Changes the setting about usage of lightweight edges.
`void`	`setUseVertexFieldsForEdgeLabels(boolean useVertexFieldsForEdgeLabels)` Changes the setting to postfix vertices fields with edge labels.
`OrientBaseGraph`	`setWarnOnForceClosingTx(boolean warnOnSchemaChangeInTx)` Changes the setting to generate a warning if the graph closing has been forced.
`void`	`shutdown()` Closes the Graph.
`String`	`toString()` Returns the Graph URL.
`OTraverse`	`traverse()` Returns a OTraverse object to start traversing the graph.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tinkerpop.blueprints.Graph
getFeatures

Field Detail

CONNECTION_OUT

public static final String CONNECTION_OUT

See Also:: Constant Field Values

CONNECTION_IN

public static final String CONNECTION_IN

See Also:: Constant Field Values

CLASS_PREFIX

public static final String CLASS_PREFIX

See Also:: Constant Field Values

CLUSTER_PREFIX

public static final String CLUSTER_PREFIX

See Also:: Constant Field Values

ADMIN
```
protected static final String ADMIN
```
See Also:
Constant Field Values

settings

protected OrientBaseGraph.Settings settings

Constructor Detail

OrientBaseGraph
```
public OrientBaseGraph(ODatabaseDocumentTx iDatabase)
```
Constructs a new object using an existent database instance.

Parameters:
iDatabase - Underlying database object to attach

OrientBaseGraph

public OrientBaseGraph(ODatabaseDocumentPool pool)

OrientBaseGraph
```
public OrientBaseGraph(String url)
```

OrientBaseGraph

public OrientBaseGraph(String url,
               String username,
               String password)

OrientBaseGraph

public OrientBaseGraph(org.apache.commons.configuration.Configuration configuration)

Builds a OrientGraph instance passing a configuration. Supported configuration settings are:

Name	Description	Default value
blueprints.orientdb.url	Database URL	-
blueprints.orientdb.username	User name	admin
blueprints.orientdb.password	User password	admin
blueprints.orientdb.saveOriginalIds	Saves the original element IDs by using the property origId. This could be useful on import of graph to preserve original ids	false
blueprints.orientdb.keepInMemoryReferences	Avoid to keep records in memory but only RIDs	false
blueprints.orientdb.useCustomClassesForEdges	Use Edge's label as OrientDB class. If doesn't exist create it under the hood	true
blueprints.orientdb.useCustomClassesForVertex	Use Vertex's label as OrientDB class. If doesn't exist create it under the hood	true
blueprints.orientdb.useVertexFieldsForEdgeLabels	Store the edge relationships in vertex by using the Edge's class. This allow to use multiple fields and make faster traversal by edge's label (class)	true
blueprints.orientdb.lightweightEdges	Uses lightweight edges. This avoid to create a physical document per edge. Documents are created only when they have properties	true

Parameters:: configuration - of graph

Method Detail
- encodeClassNames
```
public static void encodeClassNames(String... iLabels)
```
  (Internal)
- encodeClassName
```
public static String encodeClassName(String iClassName)
```
  (Internal)
- decodeClassName
```
public static String decodeClassName(String iClassName)
```
  (Internal)
- drop
```
public void drop()
```
  (Blueprints Extension) Drops the database
- createIndex
```
public <T extends com.tinkerpop.blueprints.Element> com.tinkerpop.blueprints.Index<T> createIndex(String indexName,
                                                                                         Class<T> indexClass,
                                                                                         com.tinkerpop.blueprints.Parameter... indexParameters)
```
  Specified by:
  
  createIndex in interface com.tinkerpop.blueprints.IndexableGraph
- getIndex
```
public <T extends com.tinkerpop.blueprints.Element> com.tinkerpop.blueprints.Index<T> getIndex(String indexName,
                                                                                      Class<T> indexClass)
```
  Returns an index by name and class
  
  Specified by:
  
  getIndex in interface com.tinkerpop.blueprints.IndexableGraph
  
  Parameters:
  indexName - Index name
  indexClass - Class as one or subclass of Vertex.class and Edge.class
  
  Returns:
  Index instance
- getIndices
```
public Iterable<com.tinkerpop.blueprints.Index<? extends com.tinkerpop.blueprints.Element>> getIndices()
```
  Returns all the indices.
  
  Specified by:
  
  getIndices in interface com.tinkerpop.blueprints.IndexableGraph
  
  Returns:
  Iterable of Index instances
- dropIndex
```
public void dropIndex(String indexName)
```
  Drops an index by name.
  
  Specified by:
  
  dropIndex in interface com.tinkerpop.blueprints.IndexableGraph
  
  Parameters:
  indexName - Index name
- addVertex
```
public OrientVertex addVertex(Object id)
```
  Creates a new unconnected vertex with no fields in the Graph.
  
  Specified by:
  
  addVertex in interface com.tinkerpop.blueprints.Graph
  
  Parameters:
  id - Optional, can contains the Edge's class name by prefixing with "class:"
  
  Returns:
  The new OrientVertex created
- addVertex
```
public OrientVertex addVertex(Object id,
                     Object... prop)
```
  (Blueprints Extension) Creates a new unconnected vertex in the Graph setting the initial field values.
  
  Parameters:
  id - Optional, can contains the Edge's class name by prefixing with "class:"
  prop - Fields must be a odd pairs of key/value or a single object as Map containing entries as key/value pairs
  
  Returns:
  The new OrientVertex created
- addVertex
```
public OrientVertex addVertex(String iClassName,
                     String iClusterName)
```
  (Blueprints Extension) Creates a new unconnected vertex with no fields of specific class in a cluster in the Graph.
  
  Parameters:
  iClassName - Vertex class name
  iClusterName - Vertex cluster name
  
  Returns:
  New vertex created
- addTemporaryVertex
```
public OrientVertex addTemporaryVertex(String iClassName,
                              Object... prop)
```
  (Blueprints Extension) Creates a temporary vertex setting the initial field values. The vertex is not saved and the transaction is not started.
  
  Parameters:
  iClassName - Vertex's class name
  prop - Fields must be a odd pairs of key/value or a single object as Map containing entries as key/value pairs
  
  Returns:
  added vertex
- addEdge
```
public OrientEdge addEdge(Object id,
                 com.tinkerpop.blueprints.Vertex outVertex,
                 com.tinkerpop.blueprints.Vertex inVertex,
                 String label)
```
  Creates an edge between a source Vertex and a destination Vertex setting label as Edge's label.
  
  Specified by:
  
  addEdge in interface com.tinkerpop.blueprints.Graph
  
  Parameters:
  id - Optional, can contains the Edge's class name by prefixing with "class:"
  outVertex - Source vertex
  inVertex - Destination vertex
  label - Edge's label
  
  Returns:
- getVertex
```
public OrientVertex getVertex(Object id)
```
  Returns a vertex by an ID.
  
  Specified by:
  
  getVertex in interface com.tinkerpop.blueprints.Graph
  
  Parameters:
  id - Can by a String, ODocument or an OIdentifiable object.
- removeVertex
```
public void removeVertex(com.tinkerpop.blueprints.Vertex vertex)
```
  Removes a vertex from the Graph. All the edges connected to the Vertex are automatically removed.
  
  Specified by:
  
  removeVertex in interface com.tinkerpop.blueprints.Graph
  
  Parameters:
  vertex - Vertex to remove
- getVertices
```
public Iterable<com.tinkerpop.blueprints.Vertex> getVertices()
```
  Get all the Vertices in Graph.
  
  Specified by:
  
  getVertices in interface com.tinkerpop.blueprints.Graph
  
  Returns:
  Vertices as Iterable
- getVertices
```
public Iterable<com.tinkerpop.blueprints.Vertex> getVertices(boolean iPolymorphic)
```
  Get all the Vertices in Graph specifying if consider or not sub-classes of V.
  
  Parameters:
  iPolymorphic - If true then get all the vertices of any sub-class
  
  Returns:
  Vertices as Iterable
- getVerticesOfClass
```
public Iterable<com.tinkerpop.blueprints.Vertex> getVerticesOfClass(String iClassName)
```
  Get all the Vertices in Graph of a specific vertex class and all sub-classes.
  
  Parameters:
  iClassName - Vertex class name to filter
  
  Returns:
  Vertices as Iterable
- getVerticesOfClass
```
public Iterable<com.tinkerpop.blueprints.Vertex> getVerticesOfClass(String iClassName,
                                                           boolean iPolymorphic)
```
  Get all the Vertices in Graph of a specific vertex class and all sub-classes only if iPolymorphic is true.
  
  Parameters:
  iClassName - Vertex class name to filter
  iPolymorphic - If true consider also Vertex iClassName sub-classes
  
  Returns:
  Vertices as Iterable
- getVertices
```
public Iterable<com.tinkerpop.blueprints.Vertex> getVertices(String iKey,
                                                    Object iValue)
```
  Get all the Vertices in Graph filtering by field name and value. Example:Iterable resultset = getVertices("name", "Jay");
  
  Specified by:
  
  getVertices in interface com.tinkerpop.blueprints.Graph
  
  Parameters:
  iKey - Field name
  iValue - Field value
  
  Returns:
  Vertices as Iterable
- getVertices
```
public Iterable<com.tinkerpop.blueprints.Vertex> getVertices(String label,
                                                    String[] iKey,
                                                    Object[] iValue)
```
  Get all the Vertices in Graph filtering by field name and value. Example:Iterable resultset = getVertices("Person",new String[] {"name","surname"},new Object[] { "Sherlock" ,"Holmes"});
  
  Parameters:
  iKey - Fields name
  iValue - Fields value
  
  Returns:
  Vertices as Iterable
- getEdges
```
public Iterable<com.tinkerpop.blueprints.Edge> getEdges()
```
  Returns all the edges in Graph.
  
  Specified by:
  
  getEdges in interface com.tinkerpop.blueprints.Graph
  
  Returns:
  Edges as Iterable
- getEdges
```
public Iterable<com.tinkerpop.blueprints.Edge> getEdges(boolean iPolymorphic)
```
  Get all the Edges in Graph specifying if consider or not sub-classes of E.
  
  Parameters:
  iPolymorphic - If true then get all the edge of any sub-class
  
  Returns:
  Edges as Iterable
- getEdgesOfClass
```
public Iterable<com.tinkerpop.blueprints.Edge> getEdgesOfClass(String iClassName)
```
  Get all the Edges in Graph of a specific edge class and all sub-classes.
  
  Parameters:
  iClassName - Edge class name to filter
  
  Returns:
  Edges as Iterable
- getEdgesOfClass
```
public Iterable<com.tinkerpop.blueprints.Edge> getEdgesOfClass(String iClassName,
                                                      boolean iPolymorphic)
```
  Get all the Edges in Graph of a specific edges class and all sub-classes only if iPolymorphic is true.
  
  Parameters:
  iClassName - Edge class name to filter
  iPolymorphic - If true consider also iClassName Edge sub-classes
  
  Returns:
  Edges as Iterable
- getEdges
```
public Iterable<com.tinkerpop.blueprints.Edge> getEdges(String iKey,
                                               Object iValue)
```
  Get all the Edges in Graph filtering by field name and value. Example:Iterable resultset = getEdges("name", "Jay");
  
  Specified by:
  
  getEdges in interface com.tinkerpop.blueprints.Graph
  
  Parameters:
  iKey - Field name
  iValue - Field value
  
  Returns:
  Edges as Iterable
- getEdge
```
public OrientEdge getEdge(Object id)
```
  Returns a edge by an ID.
  
  Specified by:
  
  getEdge in interface com.tinkerpop.blueprints.Graph
  
  Parameters:
  id - Can by a String, ODocument or an OIdentifiable object.
- removeEdge
```
public void removeEdge(com.tinkerpop.blueprints.Edge edge)
```
  Removes an edge from the Graph.
  
  Specified by:
  
  removeEdge in interface com.tinkerpop.blueprints.Graph
  
  Parameters:
  edge - Edge to remove
- reuse
```
public OrientBaseGraph reuse(ODatabaseDocumentTx iDatabase)
```
  Reuses the underlying database avoiding to create and open it every time.
  
  Parameters:
  iDatabase - Underlying database object
- isClosed
```
public boolean isClosed()
```
  Checks if the Graph has been closed.
  
  Returns:
  True if it is closed, otherwise false
- shutdown
```
public void shutdown()
```
  Closes the Graph. After closing the Graph cannot be used.
  
  Specified by:
  
  shutdown in interface com.tinkerpop.blueprints.Graph
- toString
```
public String toString()
```
  Returns the Graph URL.
  
  Overrides:
  
  toString in class Object
- getRawGraph
```
public ODatabaseDocumentTx getRawGraph()
```
  Returns the underlying Database instance as ODatabaseDocumentTx instance.
  
  Specified by:
  
  getRawGraph in interface com.tinkerpop.blueprints.MetaGraph<ODatabaseDocumentTx>
- commit
```
public void commit()
```
  Commits the current active transaction.
- rollback
```
public void rollback()
```
  Rollbacks the current active transaction. All the pending changes are rollbacked.
- getVertexBaseType
```
public OrientVertexType getVertexBaseType()
```
  Returns the V persistent class as OrientVertexType instance.
- getVertexType
```
public final OrientVertexType getVertexType(String iTypeName)
```
  Returns the persistent class for type iTypeName as OrientVertexType instance.
  
  Parameters:
  iTypeName - Vertex class name
- createVertexType
```
public OrientVertexType createVertexType(String iClassName)
```
  Creates a new Vertex persistent class.
  
  Parameters:
  iClassName - Vertex class name
  
  Returns:
  OrientVertexType instance representing the persistent class
- createVertexType
```
public OrientVertexType createVertexType(String iClassName,
                                String iSuperClassName)
```
  Creates a new Vertex persistent class specifying the super class.
  
  Parameters:
  iClassName - Vertex class name
  iSuperClassName - Vertex class name to extend
  
  Returns:
  OrientVertexType instance representing the persistent class
- createVertexType
```
public OrientVertexType createVertexType(String iClassName,
                                OClass iSuperClass)
```
  Creates a new Vertex persistent class specifying the super class.
  
  Parameters:
  iClassName - Vertex class name
  iSuperClass - OClass Vertex to extend
  
  Returns:
  OrientVertexType instance representing the persistent class
- dropVertexType
```
public final void dropVertexType(String iTypeName)
```
  Drop a vertex class.
  
  Parameters:
  iTypeName - Vertex class name
- getEdgeBaseType
```
public OrientEdgeType getEdgeBaseType()
```
  Returns the E persistent class as OrientEdgeType instance.
- getEdgeType
```
public final OrientEdgeType getEdgeType(String iTypeName)
```
  Returns the persistent class for type iTypeName as OrientEdgeType instance.
  
  Parameters:
  iTypeName - Edge class name
- createEdgeType
```
public OrientEdgeType createEdgeType(String iClassName)
```
  Creates a new Edge persistent class.
  
  Parameters:
  iClassName - Edge class name
  
  Returns:
  OrientEdgeType instance representing the persistent class
- createEdgeType
```
public OrientEdgeType createEdgeType(String iClassName,
                            String iSuperClassName)
```
  Creates a new Edge persistent class specifying the super class.
  
  Parameters:
  iClassName - Edge class name
  iSuperClassName - Edge class name to extend
  
  Returns:
  OrientEdgeType instance representing the persistent class
- createEdgeType
```
public OrientEdgeType createEdgeType(String iClassName,
                            OClass iSuperClass)
```
  Creates a new Edge persistent class specifying the super class.
  
  Parameters:
  iClassName - Edge class name
  iSuperClass - OClass Edge to extend
  
  Returns:
  OrientEdgeType instance representing the persistent class
- dropEdgeType
```
public final void dropEdgeType(String iTypeName)
```
  Drops an edge class.
  
  Parameters:
  iTypeName - Edge class name
- detach
```
public OrientElement detach(OrientElement iElement)
```
  Detaches a Graph Element to be used offline. All the changes will be committed on further @attach call.
  
  Parameters:
  iElement - Graph element to detach
  
  Returns:
  The detached element
  See Also:
  attach(OrientElement)
- attach
```
public OrientElement attach(OrientElement iElement)
```
  Attaches a previously detached Graph Element to the current Graph. All the pending changes will be committed.
  
  Parameters:
  iElement - Graph element to attach
  
  Returns:
  The attached element
  See Also:
  detach(OrientElement)
- getElement
```
public OrientElement getElement(Object id)
```
  Returns a graph element, vertex or edge, starting from an ID.
  
  Parameters:
  id - Can by a String, ODocument or an OIdentifiable object.
  
  Returns:
  OrientElement subclass such as OrientVertex or OrientEdge
- dropKeyIndex
```
public <T extends com.tinkerpop.blueprints.Element> void dropKeyIndex(String key,
                                                             Class<T> elementClass)
```
  Drops the index against a field name.
  
  Specified by:
  
  dropKeyIndex in interface com.tinkerpop.blueprints.KeyIndexableGraph
  
  Parameters:
  key - Field name
  elementClass - Element class as instances of Vertex and Edge
- createKeyIndex
```
public <T extends com.tinkerpop.blueprints.Element> void createKeyIndex(String key,
                                                               Class<T> elementClass,
                                                               com.tinkerpop.blueprints.Parameter... indexParameters)
```
  Creates an automatic indexing structure for indexing provided key for element class.
  Specified by:
  
  createKeyIndex in interface com.tinkerpop.blueprints.KeyIndexableGraph
  
  Type Parameters:
  T - the element class specification
  Parameters:
  key - the key to create the index for
  elementClass - the element class that the index is for
  indexParameters - a collection of parameters for the underlying index implementation:
  - "type" is the index type between the supported types (UNIQUE, NOTUNIQUE, FULLTEXT). The default type is NOT_UNIQUE
  - "class" is the class to index when it's a custom type derived by Vertex (V) or Edge (E)
  - "keytype" to use a key type different by OType.STRING,
- getIndexedKeys
```
public <T extends com.tinkerpop.blueprints.Element> Set<String> getIndexedKeys(Class<T> elementClass)
```
  Returns the indexed properties.
  
  Specified by:
  
  getIndexedKeys in interface com.tinkerpop.blueprints.KeyIndexableGraph
  
  Parameters:
  elementClass - the element class that the index is for
  
  Returns:
  Set of String containing the indexed properties
- getIndexedKeys
```
public <T extends com.tinkerpop.blueprints.Element> Set<String> getIndexedKeys(Class<T> elementClass,
                                                                      boolean includeClassNames)
```
  Returns the indexed properties.
  
  Parameters:
  elementClass - the element class that the index is for
  includeClassNames - If true includes also the class name as prefix of fields
  
  Returns:
  Set of String containing the indexed properties
- query
```
public com.tinkerpop.blueprints.GraphQuery query()
```
  Returns a GraphQuery object to execute queries against the Graph.
  
  Specified by:
  
  query in interface com.tinkerpop.blueprints.Graph
  
  Returns:
  new GraphQuery instance
- traverse
```
public OTraverse traverse()
```
  Returns a OTraverse object to start traversing the graph.
- command
```
public OCommandRequest command(OCommandRequest iCommand)
```
  Executes commands against the graph. Commands are executed outside transaction.
  
  Parameters:
  iCommand - Command request between SQL, GREMLIN and SCRIPT commands
- countVertices
```
public long countVertices()
```
  Counts the vertices in graph.
  
  Returns:
  Long as number of total vertices
- countVertices
```
public long countVertices(String iClassName)
```
  Counts the vertices in graph of a particular class.
  
  Returns:
  Long as number of total vertices
- countEdges
```
public long countEdges()
```
  Counts the edges in graph. Edge counting works only if useLightweightEdges is false.
  
  Returns:
  Long as number of total edges
- countEdges
```
public long countEdges(String iClassName)
```
  Counts the edges in graph of a particular class. Edge counting works only if useLightweightEdges is false.
  
  Returns:
  Long as number of total edges
- isUseLightweightEdges
```
public boolean isUseLightweightEdges()
```
  Returns true if is using lightweight edges, otherwise false.
- setUseLightweightEdges
```
public void setUseLightweightEdges(boolean useDynamicEdges)
```
  Changes the setting about usage of lightweight edges.
- isSaveOriginalIds
```
public boolean isSaveOriginalIds()
```
  Returns true if it saves the original Id, otherwise false.
- setSaveOriginalIds
```
public void setSaveOriginalIds(boolean saveIds)
```
  Changes the setting about usage of lightweight edges.
- isKeepInMemoryReferences
```
public boolean isKeepInMemoryReferences()
```
  Returns true if the references are kept in memory.
- setKeepInMemoryReferences
```
public void setKeepInMemoryReferences(boolean useReferences)
```
  Changes the setting about using references in memory.
- isUseClassForEdgeLabel
```
public boolean isUseClassForEdgeLabel()
```
  Returns true if the class are use for Edge labels.
- setUseClassForEdgeLabel
```
public void setUseClassForEdgeLabel(boolean useCustomClassesForEdges)
```
  Changes the setting to use the Edge class for Edge labels.
- isUseClassForVertexLabel
```
public boolean isUseClassForVertexLabel()
```
  Returns true if the class are use for Vertex labels.
- setUseClassForVertexLabel
```
public void setUseClassForVertexLabel(boolean useCustomClassesForVertex)
```
  Changes the setting to use the Vertex class for Vertex labels.
- isUseVertexFieldsForEdgeLabels
```
public boolean isUseVertexFieldsForEdgeLabels()
```
  Returns true if the out/in fields in vertex are post-fixed with edge labels. This improves traversal time by partitioning edges on different collections, one per Edge's class.
- setUseVertexFieldsForEdgeLabels
```
public void setUseVertexFieldsForEdgeLabels(boolean useVertexFieldsForEdgeLabels)
```
  Changes the setting to postfix vertices fields with edge labels. This improves traversal time by partitioning edges on different collections, one per Edge's class.
- isStandardElementConstraints
```
public boolean isStandardElementConstraints()
```
  Returns true if Blueprints standard constraints are applied to elements.
- setStandardElementConstraints
```
public void setStandardElementConstraints(boolean allowsPropertyValueNull)
```
  Changes the setting to apply the Blueprints standard constraints against elements.
- isWarnOnForceClosingTx
```
public boolean isWarnOnForceClosingTx()
```
  Returns true if the warning is generated on force the graph closing.
- setWarnOnForceClosingTx
```
public OrientBaseGraph setWarnOnForceClosingTx(boolean warnOnSchemaChangeInTx)
```
  Changes the setting to generate a warning if the graph closing has been forced.
- getThreadMode
```
public OrientBaseGraph.THREAD_MODE getThreadMode()
```
  Returns the current thread mode:
  - MANUAL the user has to manually invoke the current database in Thread Local: ODatabaseRecordThreadLocal.INSTANCE.set(graph.getRawGraph());
  - AUTOSET_IFNULL (default) each call assures the current graph instance is set in the Thread Local only if no one was set before
  - ALWAYS_AUTOSET each call assures the current graph instance is set in the Thread Local
  Returns:
  Current Graph instance to allow calls in chain (fluent interface)
  See Also:
  setThreadMode(THREAD_MODE)
- setThreadMode
```
public OrientBaseGraph setThreadMode(OrientBaseGraph.THREAD_MODE iControl)
```
  Changes the thread mode:
  - MANUAL the user has to manually invoke the current database in Thread Local: ODatabaseRecordThreadLocal.INSTANCE.set(graph.getRawGraph());
  - AUTOSET_IFNULL (default) each call assures the current graph instance is set in the Thread Local only if no one was set before
  - ALWAYS_AUTOSET each call assures the current graph instance is set in the Thread Local
  Parameters:
  iControl - Value to set
  
  Returns:
  Current Graph instance to allow calls in chain (fluent interface)
  See Also:
  getThreadMode()
- removeContext
```
protected void removeContext()
```
  Removes the current context.
- checkForGraphSchema
```
protected void checkForGraphSchema(ODatabaseDocumentTx iDatabase)
```
- autoStartTransaction
```
protected void autoStartTransaction()
```
- saveIndexConfiguration
```
protected void saveIndexConfiguration()
```
- getContext
```
protected com.tinkerpop.blueprints.impls.orient.OrientGraphContext getContext(boolean create)
```
- getClassName
```
protected <T> String getClassName(Class<T> elementClass)
```
- executeOutsideTx
```
protected <RET> RET executeOutsideTx(OCallable<RET,OrientBaseGraph> iCallable,
                         String... iOperationStrings)
                        throws RuntimeException
```
  Throws:
  
  RuntimeException
- convertKey
```
protected Object convertKey(OIndex<?> idx,
                Object iValue)
```
- convertKeys
```
protected Object[] convertKeys(OIndex<?> idx,
                   Object[] iValue)
```
- setCurrentGraphInThreadLocal
```
protected void setCurrentGraphInThreadLocal()
```

Class OrientBaseGraph

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.tinkerpop.blueprints.Graph

Field Detail

CONNECTION_OUT

CONNECTION_IN

CLASS_PREFIX

CLUSTER_PREFIX

ADMIN

settings

Constructor Detail

OrientBaseGraph

OrientBaseGraph

OrientBaseGraph

OrientBaseGraph

OrientBaseGraph

Method Detail

encodeClassNames

encodeClassName

decodeClassName

drop

createIndex

getIndex

getIndices

dropIndex

addVertex

addVertex

addVertex

addTemporaryVertex

addEdge

getVertex

removeVertex

getVertices

getVertices

getVerticesOfClass

getVerticesOfClass

getVertices

getVertices

getEdges

getEdges

getEdgesOfClass

getEdgesOfClass

getEdges

getEdge

removeEdge

reuse

isClosed

shutdown

toString

getRawGraph

commit

rollback

getVertexBaseType

getVertexType

createVertexType

createVertexType

createVertexType

dropVertexType

getEdgeBaseType

getEdgeType

createEdgeType

createEdgeType

createEdgeType

dropEdgeType

detach

attach

getElement

dropKeyIndex

createKeyIndex

getIndexedKeys

getIndexedKeys

query

traverse

command

countVertices

countVertices