com.tinkerpop.blueprints.impls.orient

Class OrientGraph

java.lang.Object

com.tinkerpop.blueprints.impls.orient.OrientBaseGraph

com.tinkerpop.blueprints.impls.orient.OrientTransactionalGraph

com.tinkerpop.blueprints.impls.orient.OrientGraph

All Implemented Interfaces:

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

public class OrientGraph
extends OrientTransactionalGraph

A Blueprints implementation of the graph database OrientDB (http://www.orientechnologies.com)

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class com.tinkerpop.blueprints.impls.orient.OrientBaseGraph

OrientBaseGraph.Settings, OrientBaseGraph.THREAD_MODE

Nested classes/interfaces inherited from interface com.tinkerpop.blueprints.TransactionalGraph

com.tinkerpop.blueprints.TransactionalGraph.Conclusion

Field Summary

Fields

Modifier and Type	Field and Description
protected com.tinkerpop.blueprints.Features	FEATURES

Fields inherited from class com.tinkerpop.blueprints.impls.orient.OrientTransactionalGraph

autoStartTx

Fields inherited from class com.tinkerpop.blueprints.impls.orient.OrientBaseGraph

ADMIN, CLASS_PREFIX, CLUSTER_PREFIX, CONNECTION_IN, CONNECTION_OUT, settings

Constructor Summary

Constructors

Constructor and Description
OrientGraph(org.apache.commons.configuration.Configuration configuration) Builds a OrientGraph instance passing a configuration.
OrientGraph(ODatabaseDocumentPool pool) Creates a new Transactional Graph from a pool.
OrientGraph(ODatabaseDocumentTx iDatabase) Creates a new Transactional Graph using an existent database instance.
OrientGraph(ODatabaseDocumentTx iDatabase, boolean iAutoStartTx) Creates a new Transactional Graph using an existent database instance and the auto-start setting to determine if auto start a transaction.
OrientGraph(String url) Creates a new Transactional Graph from an URL using default user (admin) and password (admin).
OrientGraph(String url, boolean iAutoStartTx) Creates a new Transactional Graph from an URL using default user (admin) and password (admin).
OrientGraph(String url, String username, String password) Creates a new Transactional Graph from an URL using a username and a password.
OrientGraph(String url, String username, String password, boolean iAutoStartTx) Creates a new Transactional Graph from an URL using a username and a password.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	config()
com.tinkerpop.blueprints.Features	getFeatures() Returns the current Graph settings.

Methods inherited from class com.tinkerpop.blueprints.impls.orient.OrientTransactionalGraph

autoStartTransaction, commit, isAutoStartTx, rollback, setAutoStartTx, stopTransaction

Methods inherited from class com.tinkerpop.blueprints.impls.orient.OrientBaseGraph

addEdge, addTemporaryVertex, addVertex, addVertex, addVertex, attach, checkForGraphSchema, command, convertKey, convertKeys, countEdges, countEdges, countVertices, countVertices, createEdgeType, createEdgeType, createEdgeType, createIndex, createKeyIndex, createVertexType, createVertexType, createVertexType, decodeClassName, detach, drop, dropEdgeType, dropIndex, dropKeyIndex, dropVertexType, encodeClassName, encodeClassNames, executeOutsideTx, getClassName, getContext, getEdge, getEdgeBaseType, getEdges, getEdges, getEdges, getEdgesOfClass, getEdgesOfClass, getEdgeType, getElement, getIndex, getIndexedKeys, getIndexedKeys, getIndices, getRawGraph, getThreadMode, getVertex, getVertexBaseType, getVertexType, getVertices, getVertices, getVertices, getVertices, getVerticesOfClass, getVerticesOfClass, isClosed, isKeepInMemoryReferences, isSaveOriginalIds, isStandardElementConstraints, isUseClassForEdgeLabel, isUseClassForVertexLabel, isUseLightweightEdges, isUseVertexFieldsForEdgeLabels, isWarnOnForceClosingTx, query, removeContext, removeEdge, removeVertex, reuse, saveIndexConfiguration, setCurrentGraphInThreadLocal, setKeepInMemoryReferences, setSaveOriginalIds, setStandardElementConstraints, setThreadMode, setUseClassForEdgeLabel, setUseClassForVertexLabel, setUseLightweightEdges, setUseVertexFieldsForEdgeLabels, setWarnOnForceClosingTx, shutdown, toString, traverse

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.blueprints.TransactionalGraph

shutdown

Methods inherited from interface com.tinkerpop.blueprints.Graph

addEdge, addVertex, getEdge, getEdges, getEdges, getVertex, getVertices, getVertices, query, removeEdge, removeVertex

Field Detail

FEATURES

protected final com.tinkerpop.blueprints.Features FEATURES

Constructor Detail

OrientGraph

public OrientGraph(ODatabaseDocumentTx iDatabase)

Creates a new Transactional Graph using an existent database instance.

Parameters:

iDatabase - Underlying database object to attach

OrientGraph

public OrientGraph(ODatabaseDocumentTx iDatabase,
           boolean iAutoStartTx)

Creates a new Transactional Graph using an existent database instance and the auto-start setting to determine if auto start a transaction.

Parameters:

iDatabase - Underlying database object to attach

iAutoStartTx - True to auto start a transaction at the beginning and after each commit/rollback

OrientGraph

public OrientGraph(String url)

Creates a new Transactional Graph from an URL using default user (admin) and password (admin).

Parameters:

url - OrientDB URL

OrientGraph

public OrientGraph(String url,
           boolean iAutoStartTx)

Creates a new Transactional Graph from an URL using default user (admin) and password (admin). It receives also the auto-start setting to determine if auto start a transaction.

Parameters:

url - OrientDB URL

iAutoStartTx - True to auto start a transaction at the beginning and after each commit/rollback

OrientGraph

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

Creates a new Transactional Graph from an URL using a username and a password.

Parameters:

url - OrientDB URL

username - Database user name

password - Database user password

OrientGraph

public OrientGraph(String url,
           String username,
           String password,
           boolean iAutoStartTx)

Creates a new Transactional Graph from an URL using a username and a password. It receives also the auto-start setting to determine if auto start a transaction.

Parameters:

url - OrientDB URL

username - Database user name

password - Database user password

iAutoStartTx - True to auto start a transaction at the beginning and after each commit/rollback

OrientGraph

public OrientGraph(ODatabaseDocumentPool pool)

Creates a new Transactional Graph from a pool.

Parameters:

pool - Database pool where to acquire a database instance

OrientGraph

public OrientGraph(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 _id. 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
blueprints.orientdb.autoStartTx	Auto start a transaction as soon the graph is changed by adding/remote vertices and edges and properties	true

Parameters:

configuration -

Method Detail

getFeatures

public com.tinkerpop.blueprints.Features getFeatures()

Returns the current Graph settings.

Returns:

Features object

config

protected void config()