com.orientechnologies.orient.object.db

Class ODatabasePojoAbstract<T>

java.lang.Object

com.orientechnologies.orient.core.db.ODatabaseWrapperAbstract<ODatabaseDocumentTx,T>

com.orientechnologies.orient.object.db.ODatabasePojoAbstract<T>

All Implemented Interfaces:

ODatabase<T>, ODatabaseInternal<T>, ODatabaseSchemaAware<T>, OBackupable, Closeable, AutoCloseable

Direct Known Subclasses:

OObjectDatabaseTx

public abstract class ODatabasePojoAbstract<T>
extends ODatabaseWrapperAbstract<ODatabaseDocumentTx,T>
implements ODatabaseSchemaAware<T>, ODatabaseInternal<T>

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.db.ODatabase

ODatabase.ATTRIBUTES, ODatabase.OPERATION_MODE, ODatabase.OPTIONS, ODatabase.STATUS

Field Summary

Fields

Modifier and Type	Field and Description
protected IdentityHashMap<Object,ODocument>	objects2Records
protected IdentityHashMap<ODocument,T>	records2Objects
protected boolean	retainObjects
protected HashMap<ORID,ODocument>	rid2Records

Fields inherited from class com.orientechnologies.orient.core.db.ODatabaseWrapperAbstract

databaseOwner, underlying

Constructor Summary

Constructors

Constructor and Description
ODatabasePojoAbstract(ODatabaseDocumentTx iDatabase)

Method Summary

Modifier and Type	Method and Description
void	attach(Object iPojo)
ODatabase<T>	begin() Begins a new transaction.
ODatabase<T>	begin(OTransaction.TXTYPE iType) Begins a new transaction specifying the transaction type.
ODatabase<T>	begin(OTransaction iTx) Attaches a transaction as current.
ORecordHook.RESULT	callbackHooks(ORecordHook.TYPE iType, OIdentifiable iObject)
ODatabase<T>	cleanOutRecord(ORID iRID, int iVersion)
protected void	clearNewEntriesFromCache()
void	close() Closes an opened database.
<RET extends OCommandRequest> RET	command(OCommandRequest iCommand) Returns a wrapped OCommandRequest instance to catch the result-set by converting it before to return to the user application.
ODatabase<T>	commit() Commits the current transaction.
ODatabase<T>	commit(boolean force)
protected Object	convertParameter(Object iParameter) Convert a parameter: if a POJO is used, then replace it with its record id.
protected void	convertParameters(Object... iArgs) Converts an array of parameters: if a POJO is used, then replace it with its record id.
ODatabase<T>	delete(ORecord iRecord)
ODatabase<T>	delete(ORID iRID) Deletes the entity with the received RID from the database.
ODatabase<T>	delete(ORID iRID, int iVersion) Deletes the entity with the received RID from the database.
<RET> RET	detach(Object iPojo)
boolean	existsUserObjectByRID(ORID iRID)
Map<ORecordHook,ORecordHook.HOOK_POSITION>	getHooks() Retrieves all the registered hooks.
ORID	getIdentity(Object iPojo) Returns the object unique identity.
OMetadata	getMetadata() Return the OMetadata instance.
ODocument	getRecordById(ORID iRecordId)
ODocument	getRecordByUserObject(Object iPojo, boolean iCreateIfNotAvailable)
OTransaction	getTransaction() Return active transaction.
OSecurityUser	getUser() Returns the current user logged into the database.
T	getUserObjectByRecord(OIdentifiable iRecord, String iFetchPlan)
T	getUserObjectByRecord(OIdentifiable iRecord, String iFetchPlan, boolean iCreate)
int	getVersion(Object iPojo) Returns the version number of the object.
boolean	isManaged(Object iEntity)
boolean	isMVCC() Returns if the Multi Version Concurrency Control is enabled or not.
boolean	isRetainObjects() Returns true if current configuration retains objects, otherwise false
abstract ODocument	pojo2Stream(T iPojo, ODocument record)
<RET extends List<?>> RET	query(OQuery<?> iCommand, Object... iArgs) Execute a query against the database.
<DBTYPE extends ODatabase<?>> DBTYPE	registerHook(ORecordHook iHookImpl) Registers a hook to listen all events for Records.
<DBTYPE extends ODatabase<?>> DBTYPE	registerHook(ORecordHook iHookImpl, ORecordHook.HOOK_POSITION iPosition)
void	registerUserObject(Object iObject, ORecord iRecord) Register a new POJO
ODatabase<T>	rollback() Aborts the current running transaction.
ODatabase<T>	rollback(boolean force)
void	setDirty(Object iPojo) Sets as dirty a POJO.
void	setInternal(ODatabase.ATTRIBUTES attribute, Object iValue) Internal method.
<DBTYPE extends ODatabase<?>> DBTYPE	setMVCC(boolean iMvcc) Enables or disables the Multi-Version Concurrency Control.
ODatabasePojoAbstract<T>	setRetainObjects(boolean iValue) Specifies if retain handled objects in memory or not.
void	setUser(OSecurityUser user) Set user for current database instance.
abstract Object	stream2pojo(ODocument record, Object iPojo, String iFetchPlan)
<DBTYPE extends ODatabase<?>> DBTYPE	unregisterHook(ORecordHook iHookImpl) Unregisters a previously registered hook.
void	unregisterPojo(T iObject, ODocument iRecord)
void	unsetDirty(Object iPojo) Sets as not dirty a POJO.

Methods inherited from class com.orientechnologies.orient.core.db.ODatabaseWrapperAbstract

activateOnCurrentThread, addCluster, addCluster, alterCluster, alterCluster, backup, callInLock, checkOpeness, countClusterElements, countClusterElements, countClusterElements, countClusterElements, countClusterElements, create, create, create, declareIntent, drop, dropCluster, dropCluster, equals, exists, existsCluster, freeze, freeze, get, getClusterIdByName, getClusterNameById, getClusterNames, getClusterRecordSizeById, getClusterRecordSizeByName, getClusters, getConfiguration, getDatabaseOwner, getDefaultClusterId, getLocalCache, getName, getProperties, getProperty, getRecordMetadata, getSize, getStatus, getStorage, getUnderlying, getURL, isActiveOnCurrentThread, isClosed, isFrozen, open, open, registerListener, release, reload, replaceStorage, restore, set, setDatabaseOwner, setProperty, setStatus, toString, truncateCluster, unregisterListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabaseSchemaAware

countClass, countClass, newInstance

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabaseInternal

callInLock, getDatabaseOwner, getStorage, getUnderlying, open, replaceStorage, resetInitialization, setDatabaseOwner

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabase

activateOnCurrentThread, addBlobCluster, addCluster, addCluster, alterCluster, alterCluster, countClusterElements, countClusterElements, countClusterElements, countClusterElements, countClusterElements, create, create, create, declareIntent, delete, drop, dropCluster, dropCluster, exists, existsCluster, freeze, freeze, get, getBlobClusterIds, getClusterIdByName, getClusterNameById, getClusterNames, getClusterRecordSizeById, getClusterRecordSizeByName, getClusters, getConfiguration, getConflictStrategy, getDefaultClusterId, getDictionary, getListeners, getLocalCache, getName, getProperties, getProperty, getRecordMetadata, getSize, getStatus, getType, getURL, hide, incrementalBackup, isActiveOnCurrentThread, isClosed, isFrozen, load, load, load, load, load, load, load, load, load, load, newInstance, open, registerListener, release, reload, reload, reload, save, save, save, save, set, setConflictStrategy, setConflictStrategy, setProperty, setStatus, truncateCluster, unregisterListener

Methods inherited from interface com.orientechnologies.orient.core.util.OBackupable

backup, restore

Field Detail

objects2Records

protected IdentityHashMap<Object,ODocument> objects2Records

records2Objects

protected IdentityHashMap<ODocument,T> records2Objects

rid2Records

protected HashMap<ORID,ODocument> rid2Records

retainObjects

protected boolean retainObjects

Constructor Detail

ODatabasePojoAbstract

public ODatabasePojoAbstract(ODatabaseDocumentTx iDatabase)

Method Detail

pojo2Stream

public abstract ODocument pojo2Stream(T iPojo,
                                      ODocument record)

stream2pojo

public abstract Object stream2pojo(ODocument record,
                                   Object iPojo,
                                   String iFetchPlan)

close

public void close()

Description copied from interface: ODatabase

Closes an opened database.

Specified by:

close in interface ODatabase<T>

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class ODatabaseWrapperAbstract<ODatabaseDocumentTx,T>

getTransaction

public OTransaction getTransaction()

Description copied from interface: ODatabase

Return active transaction. Cannot be null. If no transaction is active, then a OTransactionNoTx instance is returned.

Specified by:

getTransaction in interface ODatabase<T>

Returns:

OTransaction implementation

begin

public ODatabase<T> begin()

Description copied from interface: ODatabase

Begins a new transaction. By default the type is OPTIMISTIC. If a previous transaction was started it will be rollbacked and closed before to start a new one. A transaction once begun has to be closed by calling the ODatabase.commit() or ODatabase.rollback().

Specified by:

begin in interface ODatabase<T>

Returns:

The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.

begin

public ODatabase<T> begin(OTransaction.TXTYPE iType)

Description copied from interface: ODatabase

Begins a new transaction specifying the transaction type. If a previous transaction was started it will be rollbacked and closed before to start a new one. A transaction once begun has to be closed by calling the ODatabase.commit() or ODatabase.rollback().

Specified by:

begin in interface ODatabase<T>

Returns:

The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.

begin

public ODatabase<T> begin(OTransaction iTx)

Description copied from interface: ODatabase

Attaches a transaction as current.

Specified by:

begin in interface ODatabase<T>

Returns:

The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.

commit

public ODatabase<T> commit()

Description copied from interface: ODatabase

Commits the current transaction. The approach is all or nothing. All changes will be permanent following the storage type. If the operation succeed all the entities changed inside the transaction context will be effectives. If the operation fails, all the changed entities will be restored in the datastore. Memory instances are not guaranteed to being restored as well.

Specified by:

commit in interface ODatabase<T>

Returns:

commit

public ODatabase<T> commit(boolean force)
                    throws OTransactionException

Specified by:

commit in interface ODatabase<T>

Throws:

OTransactionException

rollback

public ODatabase<T> rollback()

Description copied from interface: ODatabase

Aborts the current running transaction. All the pending changed entities will be restored in the datastore. Memory instances are not guaranteed to being restored as well.

Specified by:

rollback in interface ODatabase<T>

Returns:

rollback

public ODatabase<T> rollback(boolean force)
                      throws OTransactionException

Specified by:

rollback in interface ODatabase<T>

Throws:

OTransactionException

setDirty

public void setDirty(Object iPojo)

Sets as dirty a POJO. This is useful when you change the object and need to tell to the engine to treat as dirty.

Parameters:

iPojo - User object

unsetDirty

public void unsetDirty(Object iPojo)

Sets as not dirty a POJO. This is useful when you change some other object and need to tell to the engine to treat this one as not dirty.

Parameters:

iPojo - User object

setInternal

public void setInternal(ODatabase.ATTRIBUTES attribute,
                        Object iValue)

Description copied from interface: ODatabaseInternal

Internal method. Don't call it directly unless you're building an internal component.

Specified by:

setInternal in interface ODatabaseInternal<T>

getVersion

public int getVersion(Object iPojo)

Returns the version number of the object.

Parameters:

iPojo - User object

getIdentity

public ORID getIdentity(Object iPojo)

Returns the object unique identity.

Parameters:

iPojo - User object

getUser

public OSecurityUser getUser()

Description copied from interface: ODatabase

Returns the current user logged into the database.

Specified by:

getUser in interface ODatabase<T>

See Also:

OSecurity

setUser

public void setUser(OSecurityUser user)

Description copied from interface: ODatabaseInternal

Set user for current database instance.

Specified by:

setUser in interface ODatabaseInternal<T>

getMetadata

public OMetadata getMetadata()

Description copied from interface: ODatabase

Return the OMetadata instance. Cannot be null.

Specified by:

getMetadata in interface ODatabase<T>

Returns:

The OMetadata instance.

command

public <RET extends OCommandRequest> RET command(OCommandRequest iCommand)

Returns a wrapped OCommandRequest instance to catch the result-set by converting it before to return to the user application.

Specified by:

command in interface ODatabase<T>

Parameters:

iCommand - Command request to execute.

Returns:

The same Command request received as parameter.

query

public <RET extends List<?>> RET query(OQuery<?> iCommand,
                                       Object... iArgs)

Description copied from interface: ODatabase

Execute a query against the database. If the OStorage used is remote (OStorageRemote) then the command will be executed remotely and the result returned back to the calling client.

Specified by:

query in interface ODatabase<T>

Parameters:

iCommand - Query command

iArgs - Optional parameters to bind to the query

Returns:

List of POJOs

delete

public ODatabase<T> delete(ORecord iRecord)

delete

public ODatabase<T> delete(ORID iRID)

Description copied from interface: ODatabase

Deletes the entity with the received RID from the database.

Specified by:

delete in interface ODatabase<T>

Parameters:

iRID - The RecordID to delete.

Returns:

The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.

delete

public ODatabase<T> delete(ORID iRID,
                           int iVersion)

Description copied from interface: ODatabase

Deletes the entity with the received RID from the database.

Specified by:

delete in interface ODatabase<T>

Parameters:

iRID - The RecordID to delete.

iVersion - for MVCC

Returns:

The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.

cleanOutRecord

public ODatabase<T> cleanOutRecord(ORID iRID,
                                   int iVersion)

Specified by:

cleanOutRecord in interface ODatabase<T>

registerHook

public <DBTYPE extends ODatabase<?>> DBTYPE registerHook(ORecordHook iHookImpl)

Description copied from interface: ODatabase

Registers a hook to listen all events for Records.

Specified by:

registerHook in interface ODatabase<T>

Parameters:

iHookImpl - ORecordHook implementation

Returns:

The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.

registerHook

public <DBTYPE extends ODatabase<?>> DBTYPE registerHook(ORecordHook iHookImpl,
                                                         ORecordHook.HOOK_POSITION iPosition)

Specified by:

registerHook in interface ODatabase<T>

callbackHooks

public ORecordHook.RESULT callbackHooks(ORecordHook.TYPE iType,
                                        OIdentifiable iObject)

getHooks

public Map<ORecordHook,ORecordHook.HOOK_POSITION> getHooks()

Description copied from interface: ODatabase

Retrieves all the registered hooks.

Specified by:

getHooks in interface ODatabase<T>

Returns:

A not-null unmodifiable map of ORecordHook and position instances. If there are no hooks registered, the Map is empty.

unregisterHook

public <DBTYPE extends ODatabase<?>> DBTYPE unregisterHook(ORecordHook iHookImpl)

Description copied from interface: ODatabase

Unregisters a previously registered hook.

Specified by:

unregisterHook in interface ODatabase<T>

Parameters:

iHookImpl - ORecordHook implementation

Returns:

The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain. deprecated since 2.2

isMVCC

public boolean isMVCC()

Description copied from interface: ODatabase

Returns if the Multi Version Concurrency Control is enabled or not. If enabled the version of the record is checked before each update and delete against the records.

Specified by:

isMVCC in interface ODatabase<T>

Returns:

true if enabled, otherwise false

See Also:

deprecated since 2.2

setMVCC

public <DBTYPE extends ODatabase<?>> DBTYPE setMVCC(boolean iMvcc)

Description copied from interface: ODatabase

Enables or disables the Multi-Version Concurrency Control. If enabled the version of the record is checked before each update and delete against the records.

Specified by:

setMVCC in interface ODatabase<T>

Returns:

The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain. deprecated since 2.2

See Also:

ODatabase.isMVCC()

isRetainObjects

public boolean isRetainObjects()

Returns true if current configuration retains objects, otherwise false

See Also:

setRetainObjects(boolean)

setRetainObjects

public ODatabasePojoAbstract<T> setRetainObjects(boolean iValue)

Specifies if retain handled objects in memory or not. Setting it to false can improve performance on large inserts. Default is enabled.

Parameters:

iValue - True to enable, false to disable it.

See Also:

isRetainObjects()

getRecordByUserObject

public ODocument getRecordByUserObject(Object iPojo,
                                       boolean iCreateIfNotAvailable)

existsUserObjectByRID

public boolean existsUserObjectByRID(ORID iRID)

getRecordById

public ODocument getRecordById(ORID iRecordId)

isManaged

public boolean isManaged(Object iEntity)

getUserObjectByRecord

public T getUserObjectByRecord(OIdentifiable iRecord,
                               String iFetchPlan)

getUserObjectByRecord

public T getUserObjectByRecord(OIdentifiable iRecord,
                               String iFetchPlan,
                               boolean iCreate)

attach

public void attach(Object iPojo)

detach

public <RET> RET detach(Object iPojo)

registerUserObject

public void registerUserObject(Object iObject,
                               ORecord iRecord)

Register a new POJO

unregisterPojo

public void unregisterPojo(T iObject,
                           ODocument iRecord)

clearNewEntriesFromCache

protected void clearNewEntriesFromCache()

convertParameters

protected void convertParameters(Object... iArgs)

Converts an array of parameters: if a POJO is used, then replace it with its record id.

Parameters:

iArgs - Array of parameters as Object

See Also:

convertParameter(Object)

convertParameter

protected Object convertParameter(Object iParameter)

Convert a parameter: if a POJO is used, then replace it with its record id.

Parameters:

iParameter - Parameter to convert, if applicable

See Also:

convertParameters(Object...)