OrientGraphFactory (OrientDB 2.2.1-SNAPSHOT API)

java.lang.Object
- com.tinkerpop.blueprints.impls.orient.OrientConfigurableGraph
- - com.tinkerpop.blueprints.impls.orient.OrientGraphFactory

public class OrientGraphFactory
extends OrientConfigurableGraph

Nested Class Summary
- Nested classes/interfaces inherited from class com.tinkerpop.blueprints.impls.orient.OrientConfigurableGraph
  OrientConfigurableGraph.Settings, OrientConfigurableGraph.THREAD_MODE

Field Summary

Fields
Modifier and Type	Field and Description
`protected OIntent`	`intent`
`protected String`	`password`
`protected OPartitionedDatabasePool`	`pool`
`protected String`	`url`
`protected AtomicBoolean`	`used`
`protected String`	`user`

Constructor Summary

Constructors
Constructor and Description
`OrientGraphFactory(String iURL)` Creates a factory that use default admin credentials and pool with maximum amount of connections equal to amount of CPU cores.
`OrientGraphFactory(String iURL, boolean createPool)` Creates a factory that use default admin credentials and pool with maximum amount of connections equal to amount of CPU cores if needed.
`OrientGraphFactory(String iURL, String iUser, String iPassword)` Creates a factory with given credentials and pool with maximum amount of connections equal to amount of CPU cores.
`OrientGraphFactory(String iURL, String iUser, String iPassword, boolean createPool)` Creates a factory with given credentials and pool with maximum amount of connections equal to amount of CPU cores if that is needed.
`OrientGraphFactory(String iURL, String iUser, String iPassword, OPartitionedDatabasePool pool)` Creates a factory with given credentials also you may pass pool which you already use in "document part" of your application.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes all pooled databases and clear the pool.
`void`	`declareIntent(OIntent iIntent)`
`void`	`drop()` Drops current database if such one exists.
`boolean`	`exists()` Check if the database with path given to the factory exists.
`int`	`getAvailableInstancesInPool()` Returns the number of available instances in the pool.
`int`	`getCreatedInstancesInPool()` Returns the total number of instances created in the pool.
`ODatabaseDocumentTx`	`getDatabase()` Gives new connection to database.
`ODatabaseDocumentTx`	`getDatabase(boolean iCreate, boolean iOpen)` 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.
`protected void`	`initGraph(OrientBaseGraph g)`
`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 com.tinkerpop.blueprints.impls.orient.OrientConfigurableGraph
getConnectionStrategy, getEdgeContainerEmbedded2TreeThreshold, getEdgeContainerTree2EmbeddedThreshold, getMaxRetries, getThreadMode, init, isAutoScaleEdgeType, isAutoStartTx, isKeepInMemoryReferences, isRequireTransaction, isSaveOriginalIds, isStandardElementConstraints, isStandardExceptions, isTxRequiredForSQLGraphOperations, isUseClassForEdgeLabel, isUseClassForVertexLabel, isUseLightweightEdges, isUseVertexFieldsForEdgeLabels, isWarnOnForceClosingTx, setAutoScaleEdgeType, setAutoStartTx, setConnectionStrategy, setEdgeContainerEmbedded2TreeThreshold, setEdgeContainerTree2EmbeddedThreshold, setKeepInMemoryReferences, setMaxRetries, setRequireTransaction, setSaveOriginalIds, setStandardElementConstraints, setStandardExceptions, setThreadMode, setTxRequiredForSQLGraphOperations, setUseClassForEdgeLabel, setUseClassForVertexLabel, setUseLightweightEdges, setUseLog, setUseVertexFieldsForEdgeLabels, setWarnOnForceClosingTx

Methods inherited from class java.lang.Object
clone, equals, finalize, 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 OPartitionedDatabasePool pool
```
  - intent
```
protected OIntent intent
```
  - used
```
protected AtomicBoolean used
```
- Constructor Detail
  - OrientGraphFactory
```
public OrientGraphFactory(String iURL)
```
    Creates a factory that use default admin credentials and pool with maximum amount of connections equal to amount of CPU cores.
    
    Parameters:
    
    iURL - to the database
  - OrientGraphFactory
```
public OrientGraphFactory(String iURL,
                          boolean createPool)
```
    Creates a factory that use default admin credentials and pool with maximum amount of connections equal to amount of CPU cores if needed.
    
    Parameters:
    
    iURL - to the database
    
    createPool - flag which indicates whether pool should be created.
  - OrientGraphFactory
```
public OrientGraphFactory(String iURL,
                          String iUser,
                          String iPassword)
```
    Creates a factory with given credentials and pool with maximum amount of connections equal to amount of CPU cores.
    If you wish to change pool settings call com.tinkerpop.blueprints.impls.orient.OrientGraphFactory#setupPool(int, int) method.
    
    Parameters:
    
    iURL - to the database
    
    iUser - name of the user
    
    iPassword - of the user
  - OrientGraphFactory
```
public OrientGraphFactory(String iURL,
                          String iUser,
                          String iPassword,
                          boolean createPool)
```
    Creates a factory with given credentials and pool with maximum amount of connections equal to amount of CPU cores if that is needed.
    If you wish to change pool settings call com.tinkerpop.blueprints.impls.orient.OrientGraphFactory#setupPool(int, int) method.
    
    Parameters:
    
    iURL - to the database
    
    iUser - name of the user
    
    iPassword - of the user
    
    createPool - flag which indicates whether pool should be created.
  - OrientGraphFactory
```
public OrientGraphFactory(String iURL,
                          String iUser,
                          String iPassword,
                          OPartitionedDatabasePool pool)
```
    Creates a factory with given credentials also you may pass pool which you already use in "document part" of your application. It is mandatory to use the same pool for document and graph databases.
    
    Parameters:
    
    iURL - to the database
    
    iUser - name of the user
    
    iPassword - password of the user
    
    pool - Pool which is used in "document part" of your application.
- 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.
  - getTx
```
public OrientGraph getTx()
```
    Gets transactional graph with the database from pool if pool is configured. Otherwise creates a graph with new db instance. The Graph instance inherits the factory's configuration.
    
    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. The Graph instance inherits the factory's configuration.
    
    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,
                                       boolean iOpen)
```
    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
    
    iOpen - if true automatically opens the database
    
    Returns:
    
    database
  - exists
```
public boolean exists()
```
    Check if the database with path given to the factory exists.
    this api can be used only in embedded mode, and has no need of authentication.
    
    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
  - getAvailableInstancesInPool
```
public int getAvailableInstancesInPool()
```
    Returns the number of available instances in the pool.
  - getCreatedInstancesInPool
```
public int getCreatedInstancesInPool()
```
    Returns the total number of instances created in the pool.
  - declareIntent
```
public void declareIntent(OIntent iIntent)
```
    Specified by:
    
    declareIntent in class OrientConfigurableGraph
  - initGraph
```
protected void initGraph(OrientBaseGraph g)
```

Class OrientGraphFactory

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

url

user

password

pool

intent

used

Constructor Detail

OrientGraphFactory

OrientGraphFactory

OrientGraphFactory

OrientGraphFactory

OrientGraphFactory

Method Detail

close

drop

getTx

getNoTx

getDatabase

getDatabase

exists

setupPool

getAvailableInstancesInPool

getCreatedInstancesInPool

declareIntent

initGraph