com.tinkerpop.blueprints.impls.orient

Class OrientGraphFactory

java.lang.Object

com.tinkerpop.blueprints.impls.orient.OrientGraphFactory

public class OrientGraphFactory
extends Object

A factory to create instances of OrientGraph. OrientGraph is a Blueprints implementation of the graph database OrientDB (http://www.orientechnologies.com). By default creates new connection for each graph, but could be configured to use database pool. Thread safe after set up.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	password
protected ODatabaseDocumentPool	pool
protected boolean	transactional
protected String	url
protected String	user

Constructor Summary

Constructors

Constructor and Description
OrientGraphFactory(String iURL) Creates a factory that use default admin credentials.
OrientGraphFactory(String iURL, String iUser, String iPassword) Creates a factory with given credentials.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes all pooled databases and clear the pool.
void	drop() Drops current database if such one exists.
boolean	exists() Check if the database with path given to the factory exists.
protected void	finalize()
OrientBaseGraph	get() Depends of configuration work like getTx() or getNoTx().
int	getAvailableInstancesInPool() Returns the number of available instances in the pool.
ODatabaseDocumentTx	getDatabase() Gives new connection to database.
ODatabaseDocumentTx	getDatabase(boolean iCreate) Gives new connection to database.
OrientGraphNoTx	getNoTx() Gets non transactional graph with the database from pool if pool is configured.
OrientGraph	getTx() Gets transactional graph with the database from pool if pool is configured.
boolean	isTransactional()
OrientGraphFactory	setTransactional(boolean transactional) Configure current factory to create transactional of non transactional graphs by default.
OrientGraphFactory	setupPool(int iMin, int iMax) Setting up the factory to use database pool instead of creation a new instance of database connection each time.

Methods inherited from class java.lang.Object

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

Field Detail

url

protected final String url

user

protected final String user

password

protected final String password

pool

protected volatile ODatabaseDocumentPool pool

transactional

protected volatile boolean transactional

Constructor Detail

OrientGraphFactory

public OrientGraphFactory(String iURL)

Creates a factory that use default admin credentials.

Parameters:

iURL - to the database

OrientGraphFactory

public OrientGraphFactory(String iURL,
                  String iUser,
                  String iPassword)

Creates a factory with given credentials.

Parameters:

iURL - to the database

iUser - name of the user

iPassword - of the user

Method Detail

close

public void close()

Closes all pooled databases and clear the pool.

drop

public void drop()

Drops current database if such one exists.

Throws:

ODatabaseException - if there is no current database.

get

public OrientBaseGraph get()

Depends of configuration work like getTx() or getNoTx(). By default the factory configured to return transactional graph. Use setTransactional(boolean) to change the behaviour

Returns:

orient graph

getTx

public OrientGraph getTx()

Gets transactional graph with the database from pool if pool is configured. Otherwise creates a graph with new db instance.

Returns:

transactional graph

getNoTx

public OrientGraphNoTx getNoTx()

Gets non transactional graph with the database from pool if pool is configured. Otherwise creates a graph with new db instance.

Returns:

non transactional graph

getDatabase

public ODatabaseDocumentTx getDatabase()

Gives new connection to database. If current factory configured to use pool (see setupPool(int, int) method), retrieves connection from pool. Otherwise creates new connection each time. Automatically creates database if database with given URL does not exist Shortcut for getDatabase(true)

Returns:

database.

getDatabase

public ODatabaseDocumentTx getDatabase(boolean iCreate)

Gives new connection to database. If current factory configured to use pool (see setupPool(int, int) method), retrieves connection from pool. Otherwise creates new connection each time.

Parameters:

iCreate - if true automatically creates database if database with given URL does not exist

Returns:

database

exists

public boolean exists()

Check if the database with path given to the factory exists.

Returns:

true if database is exists

setupPool

public OrientGraphFactory setupPool(int iMin,
                           int iMax)

Setting up the factory to use database pool instead of creation a new instance of database connection each time.

Parameters:

iMin - minimum size of pool

iMax - maximum size of pool

Returns:

this

isTransactional

public boolean isTransactional()

Returns:

true if current factory configured to create transactional graphs by default.

See Also:

get()

setTransactional

public OrientGraphFactory setTransactional(boolean transactional)

Configure current factory to create transactional of non transactional graphs by default.

Parameters:

transactional - defines should the factory return transactional graph by default.

Returns:

this

See Also:

get()

getAvailableInstancesInPool

public int getAvailableInstancesInPool()

Returns the number of available instances in the pool.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable