com.orientechnologies.orient.object.db

Class OObjectDatabaseTx

java.lang.Object

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

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

com.orientechnologies.orient.object.db.OObjectDatabaseTx

All Implemented Interfaces:

ODatabaseObject, ODatabase<Object>, ODatabaseInternal<Object>, ODatabaseSchemaAware<Object>, OUserObject2RecordHandler, OBackupable, Closeable, AutoCloseable

Direct Known Subclasses:

OObjectDatabaseTxPooled

public class OObjectDatabaseTx
extends ODatabasePojoAbstract<Object>
implements ODatabaseObject, ODatabaseInternal<Object>

Object Database instance. It's a wrapper to the class ODatabaseDocumentTx that handles conversion between ODocument instances and POJOs using javassist APIs.

Author:

Luca Molino

See Also:

ODatabaseDocumentTx

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 boolean	automaticSchemaGeneration
protected ODictionary<Object>	dictionary
protected OEntityManager	entityManager
protected boolean	lazyLoading
protected OMetadataObject	metadata
protected boolean	saveOnlyDirty
static String	TYPE

Fields inherited from class com.orientechnologies.orient.object.db.ODatabasePojoAbstract

objects2Records, records2Objects, retainObjects, rid2Records

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

databaseOwner, underlying

Constructor Summary

Constructors

Constructor and Description
OObjectDatabaseTx(ODatabaseDocumentTx iDatabase) Constructor to wrap an existing database connect for object connections
OObjectDatabaseTx(String iURL)

Method Summary

Modifier and Type	Method and Description
int	addBlobCluster(String iClusterName, Object... iParameters) Adds a new cluster for store blobs.
void	attach(Object iPojo)
<RET> RET	attachAndSave(Object iPojo)
<RET> OObjectIteratorClass<RET>	browseClass(Class<RET> iClusterClass) Browses all the records of the specified class.
<RET> OObjectIteratorClass<RET>	browseClass(Class<RET> iClusterClass, boolean iPolymorphic)
<RET> OObjectIteratorClass<RET>	browseClass(String iClassName)
<RET> OObjectIteratorClass<RET>	browseClass(String iClassName, boolean iPolymorphic)
<RET> OObjectIteratorCluster<RET>	browseCluster(String iClusterName) Browses all the records of the specified cluster.
<DBTYPE extends ODatabase> DBTYPE	checkSecurity(ORule.ResourceGeneric iResource, int iOperation, Object... iResourcesSpecific)
<DBTYPE extends ODatabase> DBTYPE	checkSecurity(ORule.ResourceGeneric iResource, int iOperation, Object iResourceSpecific)
<DBTYPE extends ODatabase> DBTYPE	checkSecurity(ORule.ResourceGeneric resourceGeneric, String resourceSpecific, byte iOperation)
ODatabase<Object>	cleanOutRecord(ORID iRID, int iVersion)
ODatabasePojoAbstract<Object>	commit() Commits the current transaction.
ODatabasePojoAbstract<Object>	commit(boolean force)
long	countClass(Class<?> iClass)
long	countClass(String iClassName) Counts the entities contained in the specified class and sub classes (polymorphic).
long	countClass(String iClassName, boolean iPolymorphic) Counts the entities contained in the specified class.
ODatabaseObject	delete(Object iPojo) Deletes an entity from the database in synchronous mode.
ODatabaseObject	delete(ORID iRID) Deletes the entity with the received RID from the database.
ODatabaseObject	delete(ORID iRID, int iVersion) Deletes the entity with the received RID from the database.
protected void	deleteCascade(ODocument record)
protected void	deleteOrphans(OObjectProxyMethodHandler handler)
void	deregisterClassMethodFilter(Class<?> iClass)
<RET> RET	detach(Object iPojo)
<RET> RET	detach(Object iPojo, boolean returnNonProxiedInstance) Method that detaches all fields contained in the document to the given object.
<RET> RET	detachAll(Object iPojo, boolean returnNonProxiedInstance) Method that detaches all fields contained in the document to the given object and recursively all object tree.
protected <RET> RET	detachAll(Object iPojo, boolean returnNonProxiedInstance, Map<Object,Object> alreadyDetached, Map<Object,Object> lazyObjects)
Set<Integer>	getBlobClusterIds() Retrieve the set of defined blob cluster.
ORecordConflictStrategy	getConflictStrategy() Returns the current record conflict strategy.
ODictionary<Object>	getDictionary() Returns the Dictionary manual index.
OEntityManager	getEntityManager() Returns the entity manager that handle the binding from ODocuments and POJOs.
ORID	getIdentity(Object iPojo) Returns the object unique identity.
Iterable<ODatabaseListener>	getListeners() Retrieves all the registered listeners.
OMetadataObject	getMetadata() Return the OMetadata instance.
ODocument	getRecordByUserObject(Object iPojo, boolean iCreateIfNotAvailable) Returns the record associated to a user object.
String	getType()
ODatabaseDocumentInternal	getUnderlying() Return the underlying database.
Object	getUserObjectByRecord(OIdentifiable iRecord, String iFetchPlan, boolean iCreate)
int	getVersion(Object iPojo) Returns the version number of the object.
boolean	hide(ORID rid) Hides records content by putting tombstone on the records position but does not delete record itself.
String	incrementalBackup(String path) Performs incremental backup of database content to the selected folder.
protected void	init()
boolean	isAutomaticSchemaGeneration()
boolean	isLazyLoading()
boolean	isSaveOnlyDirty()
<RET> RET	load(Object iPojo) Loads the entity and return it.
<RET> RET	load(Object iPojo, String iFetchPlan) Loads a record using a fetch plan.
<RET> RET	load(Object iPojo, String iFetchPlan, boolean iIgnoreCache) Loads a record using a fetch plan.
<RET> RET	load(Object iPojo, String iFetchPlan, boolean iIgnoreCache, boolean iUpdateCache, boolean loadTombstone, OStorage.LOCKING_STRATEGY iLockingStrategy) Deprecated.
<RET> RET	load(Object iPojo, String iFetchPlan, boolean iIgnoreCache, boolean loadTombstone, OStorage.LOCKING_STRATEGY iLockingStrategy) Deprecated.
<RET> RET	load(ORID recordId) Loads the entity by the Record ID.
<RET> RET	load(ORID iRecordId, String iFetchPlan) Loads the entity by the Record ID using a fetch plan.
<RET> RET	load(ORID iRecordId, String iFetchPlan, boolean iIgnoreCache) Loads the entity by the Record ID using a fetch plan and specifying if the cache must be ignored.
<RET> RET	load(ORID iRecordId, String iFetchPlan, boolean iIgnoreCache, boolean iUpdateCache, boolean loadTombstone, OStorage.LOCKING_STRATEGY iLockingStrategy) Deprecated.
<RET> RET	load(ORID iRecordId, String iFetchPlan, boolean iIgnoreCache, boolean loadTombstone, OStorage.LOCKING_STRATEGY iLockingStrategy) Deprecated.
Object	newInstance() Creates a new entity instance.
<T> T	newInstance(Class<T> iType) Creates a new entity of the specified class.
<T> T	newInstance(Class<T> iType, Object... iArgs)
<RET> RET	newInstance(String iClassName) Creates a new entity instance.
<RET> RET	newInstance(String iClassName, Object iEnclosingClass, Object... iArgs) Create a new POJO by its class name.
<RET> RET	newInstance(String iClassName, Object iEnclosingClass, ODocument iDocument, Object... iArgs) Create a new POJO by its class name.
<THISDB extends ODatabase> THISDB	open(OToken iToken) Opens a database using an authentication token received as an argument.
<THISDB extends ODatabase> THISDB	open(String iUserName, String iUserPassword) Opens a database using the user and password received as arguments.
ODocument	pojo2Stream(Object iPojo, ODocument iRecord)
void	registerClassMethodFilter(Class<?> iClass, OObjectMethodFilter iMethodFilter)
void	registerUserObject(Object iObject, ORecord iRecord) Register a new POJO
void	registerUserObjectAfterLinkSave(ORecord iRecord) Registers the saved linked record.
<RET> RET	reload(Object iPojo)
<RET> RET	reload(Object iPojo, boolean iIgnoreCache)
<RET> RET	reload(Object iPojo, String iFetchPlan, boolean iIgnoreCache) Force the reloading of the entity.
<RET> RET	reload(Object iObject, String iFetchPlan, boolean iIgnoreCache, boolean force) Force the reloading of the entity.
void	resetInitialization()
ODatabasePojoAbstract<Object>	rollback() Aborts the current running transaction.
ODatabasePojoAbstract<Object>	rollback(boolean force)
<RET> RET	save(Object iContent) Saves an object to the databasein synchronous mode .
<RET> RET	save(Object iContent, ODatabase.OPERATION_MODE iMode, boolean iForceCreate, ORecordCallback<? extends Number> iRecordCreatedCallback, ORecordCallback<Integer> iRecordUpdatedCallback) Saves an object to the database specifying the mode.
<RET> RET	save(Object iPojo, String iClusterName) Saves an object in synchronous mode to the database forcing a record cluster where to store it.
<RET> RET	save(Object iPojo, String iClusterName, ODatabase.OPERATION_MODE iMode, boolean iForceCreate, ORecordCallback<? extends Number> iRecordCreatedCallback, ORecordCallback<Integer> iRecordUpdatedCallback) Saves an object to the database forcing a record cluster where to store it.
void	setAutomaticSchemaGeneration(boolean automaticSchemaGeneration)
OObjectDatabaseTx	setConflictStrategy(ORecordConflictStrategy iResolver) Overrides record conflict strategy.
OObjectDatabaseTx	setConflictStrategy(String iStrategyName) Overrides record conflict strategy selecting the strategy by name.
void	setLazyLoading(boolean lazyLoading)
void	setSaveOnlyDirty(boolean saveOnlyDirty)
Object	stream2pojo(ODocument iRecord, Object iPojo, String iFetchPlan)
Object	stream2pojo(ODocument iRecord, Object iPojo, String iFetchPlan, boolean iReload)
void	unregisterPojo(Object iObject, ODocument iRecord)

Methods inherited from class com.orientechnologies.orient.object.db.ODatabasePojoAbstract

begin, begin, begin, callbackHooks, clearNewEntriesFromCache, close, command, convertParameter, convertParameters, delete, existsUserObjectByRID, getHooks, getRecordById, getTransaction, getUser, getUserObjectByRecord, isManaged, isMVCC, isRetainObjects, query, registerHook, registerHook, setDirty, setInternal, setMVCC, setRetainObjects, setUser, unregisterHook, unsetDirty

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, getURL, isActiveOnCurrentThread, isClosed, isFrozen, 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.object.ODatabaseObject

isRetainObjects, setDirty, setRetainObjects, unsetDirty

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

activateOnCurrentThread, addCluster, addCluster, alterCluster, alterCluster, begin, begin, begin, close, command, countClusterElements, countClusterElements, countClusterElements, countClusterElements, countClusterElements, create, create, create, declareIntent, drop, dropCluster, dropCluster, exists, existsCluster, freeze, freeze, get, getClusterIdByName, getClusterNameById, getClusterNames, getClusterRecordSizeById, getClusterRecordSizeByName, getClusters, getConfiguration, getDefaultClusterId, getHooks, getLocalCache, getName, getProperties, getProperty, getRecordMetadata, getSize, getStatus, getTransaction, getURL, getUser, isActiveOnCurrentThread, isClosed, isFrozen, isMVCC, query, registerHook, registerHook, registerListener, release, reload, set, setMVCC, setProperty, setStatus, truncateCluster, unregisterHook, unregisterListener

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

backup, restore

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

existsUserObjectByRID, getUserObjectByRecord

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

callInLock, getDatabaseOwner, getStorage, replaceStorage, setDatabaseOwner, setInternal, setUser

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

dictionary

protected ODictionary<Object> dictionary

entityManager

protected OEntityManager entityManager

saveOnlyDirty

protected boolean saveOnlyDirty

lazyLoading

protected boolean lazyLoading

automaticSchemaGeneration

protected boolean automaticSchemaGeneration

metadata

protected OMetadataObject metadata

Constructor Detail

OObjectDatabaseTx

public OObjectDatabaseTx(String iURL)

OObjectDatabaseTx

public OObjectDatabaseTx(ODatabaseDocumentTx iDatabase)

Constructor to wrap an existing database connect for object connections

Parameters:

iDatabase - an open database connection

Method Detail

newInstance

public <T> T newInstance(Class<T> iType)

Description copied from interface: ODatabaseObject

Creates a new entity of the specified class.

Specified by:

newInstance in interface ODatabaseObject

Parameters:

iType - Class name where to originate the instance

Returns:

New instance

newInstance

public <T> T newInstance(Class<T> iType,
                         Object... iArgs)

newInstance

public <RET> RET newInstance(String iClassName)

Description copied from interface: ODatabaseSchemaAware

Creates a new entity instance. Each database implementation will return the right type.

Specified by:

newInstance in interface ODatabaseSchemaAware<Object>

Returns:

The new instance.

open

public <THISDB extends ODatabase> THISDB open(String iUserName,
                                              String iUserPassword)

Description copied from interface: ODatabase

Opens a database using the user and password received as arguments.

Specified by:

open in interface ODatabase<Object>

Overrides:

open in class ODatabaseWrapperAbstract<ODatabaseDocumentTx,Object>

Parameters:

iUserName - Username to login

iUserPassword - Password associated to the user

Returns:

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

open

public <THISDB extends ODatabase> THISDB open(OToken iToken)

Description copied from interface: ODatabaseInternal

Opens a database using an authentication token received as an argument.

Specified by:

open in interface ODatabaseInternal<Object>

Overrides:

open in class ODatabaseWrapperAbstract<ODatabaseDocumentTx,Object>

Parameters:

iToken - Authentication token

Returns:

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

getMetadata

public OMetadataObject getMetadata()

Description copied from interface: ODatabase

Return the OMetadata instance. Cannot be null.

Specified by:

getMetadata in interface ODatabase<Object>

Overrides:

getMetadata in class ODatabasePojoAbstract<Object>

Returns:

The OMetadata instance.

getListeners

public Iterable<ODatabaseListener> getListeners()

Description copied from interface: ODatabase

Retrieves all the registered listeners.

Specified by:

getListeners in interface ODatabase<Object>

Returns:

An iterable of ODatabaseListener instances.

newInstance

public <RET> RET newInstance(String iClassName,
                             Object iEnclosingClass,
                             Object... iArgs)

Create a new POJO by its class name. Assure to have called the registerEntityClasses() declaring the packages that are part of entity classes.

See Also:

OEntityManager.registerEntityClasses(String)

newInstance

public <RET> RET newInstance(String iClassName,
                             Object iEnclosingClass,
                             ODocument iDocument,
                             Object... iArgs)

Create a new POJO by its class name. Assure to have called the registerEntityClasses() declaring the packages that are part of entity classes.

See Also:

OEntityManager.registerEntityClasses(String)

browseClass

public <RET> OObjectIteratorClass<RET> browseClass(Class<RET> iClusterClass)

Description copied from interface: ODatabaseObject

Browses all the records of the specified class.

Specified by:

browseClass in interface ODatabaseObject

Parameters:

iClusterClass - Class name to iterate

Returns:

Iterator of Object instances

browseClass

public <RET> OObjectIteratorClass<RET> browseClass(Class<RET> iClusterClass,
                                                   boolean iPolymorphic)

browseClass

public <RET> OObjectIteratorClass<RET> browseClass(String iClassName)

browseClass

public <RET> OObjectIteratorClass<RET> browseClass(String iClassName,
                                                   boolean iPolymorphic)

browseCluster

public <RET> OObjectIteratorCluster<RET> browseCluster(String iClusterName)

Description copied from interface: ODatabaseObject

Browses all the records of the specified cluster.

Specified by:

browseCluster in interface ODatabaseObject

Parameters:

iClusterName - Cluster name to iterate

Returns:

Iterator of Object instances

load

public <RET> RET load(Object iPojo)

Description copied from interface: ODatabase

Loads the entity and return it.

Specified by:

load in interface ODatabase<Object>

Parameters:

iPojo - The entity to load. If the entity was already loaded it will be reloaded and all the changes will be lost.

Returns:

reload

public <RET> RET reload(Object iPojo)

reload

public <RET> RET reload(Object iPojo,
                        boolean iIgnoreCache)

reload

public <RET> RET reload(Object iPojo,
                        String iFetchPlan,
                        boolean iIgnoreCache)

Description copied from interface: ODatabase

Force the reloading of the entity.

Specified by:

reload in interface ODatabase<Object>

Parameters:

iPojo - The entity to load. If the entity was already loaded it will be reloaded and all the changes will be lost.

iFetchPlan - Fetch plan used

iIgnoreCache - Ignore cache or use it

Returns:

The loaded entity

reload

public <RET> RET reload(Object iObject,
                        String iFetchPlan,
                        boolean iIgnoreCache,
                        boolean force)

Description copied from interface: ODatabase

Force the reloading of the entity.

Specified by:

reload in interface ODatabase<Object>

Parameters:

iObject - The entity to load. If the entity was already loaded it will be reloaded and all the changes will be lost.

iFetchPlan - Fetch plan used

iIgnoreCache - Ignore cache or use it

force - Force to reload record even if storage has the same record as reloaded record, it is useful if fetch plan is not null and alongside with root record linked records will be reloaded.

Returns:

The loaded entity

load

public <RET> RET load(Object iPojo,
                      String iFetchPlan)

Description copied from interface: ODatabase

Loads a record using a fetch plan.

Specified by:

load in interface ODatabase<Object>

Parameters:

iPojo - Record to load

iFetchPlan - Fetch plan used

Returns:

The record received

attach

public void attach(Object iPojo)

Overrides:

attach in class ODatabasePojoAbstract<Object>

attachAndSave

public <RET> RET attachAndSave(Object iPojo)

detach

public <RET> RET detach(Object iPojo)

Overrides:

detach in class ODatabasePojoAbstract<Object>

detach

public <RET> RET detach(Object iPojo,
                        boolean returnNonProxiedInstance)

Method that detaches all fields contained in the document to the given object.

Type Parameters:

RET -

Parameters:

iPojo - :- the object to detach

returnNonProxiedInstance - :- defines if the return object will be a proxied instance or not. If set to TRUE and the object does not contains @Id and @Version fields it could procude data replication

Returns:

the object serialized or with detached data

detachAll

public <RET> RET detachAll(Object iPojo,
                           boolean returnNonProxiedInstance)

Method that detaches all fields contained in the document to the given object and recursively all object tree. This may throw a StackOverflowError with big objects tree. To avoid it set the stack size with -Xss java option

Type Parameters:

RET -

Parameters:

iPojo - :- the object to detach

returnNonProxiedInstance - :- defines if the return object will be a proxied instance or not. If set to TRUE and the object does not contains @Id and @Version fields it could procude data replication

Returns:

the object serialized or with detached data

load

public <RET> RET load(Object iPojo,
                      String iFetchPlan,
                      boolean iIgnoreCache)

Description copied from interface: ODatabase

Loads a record using a fetch plan.

Specified by:

load in interface ODatabase<Object>

Parameters:

iPojo - Record to load

iFetchPlan - Fetch plan used

iIgnoreCache - Ignore cache or use it

Returns:

The record received

load

@Deprecated
public <RET> RET load(Object iPojo,
                                  String iFetchPlan,
                                  boolean iIgnoreCache,
                                  boolean loadTombstone,
                                  OStorage.LOCKING_STRATEGY iLockingStrategy)

Deprecated.

Description copied from interface: ODatabase

Loads a record using a fetch plan.

Specified by:

load in interface ODatabase<Object>

Parameters:

iPojo - Record to load

iFetchPlan - Fetch plan used

Returns:

The record received

load

@Deprecated
public <RET> RET load(Object iPojo,
                                  String iFetchPlan,
                                  boolean iIgnoreCache,
                                  boolean iUpdateCache,
                                  boolean loadTombstone,
                                  OStorage.LOCKING_STRATEGY iLockingStrategy)

Deprecated.

Description copied from interface: ODatabase

Loads a record using a fetch plan.

Specified by:

load in interface ODatabase<Object>

Parameters:

iPojo - Record to load

iFetchPlan - Fetch plan used

Returns:

The record received

load

public <RET> RET load(ORID recordId)

Description copied from interface: ODatabase

Loads the entity by the Record ID.

Specified by:

load in interface ODatabase<Object>

Parameters:

recordId - The unique record id of the entity to load.

Returns:

The loaded entity

load

public <RET> RET load(ORID iRecordId,
                      String iFetchPlan)

Description copied from interface: ODatabase

Loads the entity by the Record ID using a fetch plan.

Specified by:

load in interface ODatabase<Object>

Parameters:

iRecordId - The unique record id of the entity to load.

iFetchPlan - Fetch plan used

Returns:

The loaded entity

load

public <RET> RET load(ORID iRecordId,
                      String iFetchPlan,
                      boolean iIgnoreCache)

Description copied from interface: ODatabase

Loads the entity by the Record ID using a fetch plan and specifying if the cache must be ignored.

Specified by:

load in interface ODatabase<Object>

Parameters:

iRecordId - The unique record id of the entity to load.

iFetchPlan - Fetch plan used

iIgnoreCache - Ignore cache or use it

Returns:

The loaded entity

load

@Deprecated
public <RET> RET load(ORID iRecordId,
                                  String iFetchPlan,
                                  boolean iIgnoreCache,
                                  boolean loadTombstone,
                                  OStorage.LOCKING_STRATEGY iLockingStrategy)

Deprecated.

Specified by:

load in interface ODatabase<Object>

load

@Deprecated
public <RET> RET load(ORID iRecordId,
                                  String iFetchPlan,
                                  boolean iIgnoreCache,
                                  boolean iUpdateCache,
                                  boolean loadTombstone,
                                  OStorage.LOCKING_STRATEGY iLockingStrategy)

Deprecated.

Specified by:

load in interface ODatabase<Object>

save

public <RET> RET save(Object iContent)

Saves an object to the databasein synchronous mode . First checks if the object is new or not. In case it's new a new ODocument is created and bound to the object, otherwise the ODocument is retrieved and updated. The object is introspected using the Java Reflection to extract the field values.
If a multi value (array, collection or map of objects) is passed, then each single object is stored separately.

Specified by:

save in interface ODatabase<Object>

Parameters:

iContent - The entity to save

Returns:

The saved entity.

save

public <RET> RET save(Object iContent,
                      ODatabase.OPERATION_MODE iMode,
                      boolean iForceCreate,
                      ORecordCallback<? extends Number> iRecordCreatedCallback,
                      ORecordCallback<Integer> iRecordUpdatedCallback)

Saves an object to the database specifying the mode. First checks if the object is new or not. In case it's new a new ODocument is created and bound to the object, otherwise the ODocument is retrieved and updated. The object is introspected using the Java Reflection to extract the field values.
If a multi value (array, collection or map of objects) is passed, then each single object is stored separately.

Specified by:

save in interface ODatabase<Object>

Parameters:

iContent - The entity to save

iMode - Mode of save: synchronous (default) or asynchronous

iForceCreate - Flag that indicates that record should be created. If record with current rid already exists, exception is thrown

save

public <RET> RET save(Object iPojo,
                      String iClusterName)

Saves an object in synchronous mode to the database forcing a record cluster where to store it. First checks if the object is new or not. In case it's new a new ODocument is created and bound to the object, otherwise the ODocument is retrieved and updated. The object is introspected using the Java Reflection to extract the field values.
If a multi value (array, collection or map of objects) is passed, then each single object is stored separately.

Before to use the specified cluster a check is made to know if is allowed and figures in the configured and the record is valid following the constraints declared in the schema.

Specified by:

save in interface ODatabase<Object>

Parameters:

iPojo - The entity to save

iClusterName - Name of the cluster where to save

Returns:

The saved entity.

See Also:

ODocument.validate()

save

public <RET> RET save(Object iPojo,
                      String iClusterName,
                      ODatabase.OPERATION_MODE iMode,
                      boolean iForceCreate,
                      ORecordCallback<? extends Number> iRecordCreatedCallback,
                      ORecordCallback<Integer> iRecordUpdatedCallback)

Saves an object to the database forcing a record cluster where to store it. First checks if the object is new or not. In case it's new a new ODocument is created and bound to the object, otherwise the ODocument is retrieved and updated. The object is introspected using the Java Reflection to extract the field values.
If a multi value (array, collection or map of objects) is passed, then each single object is stored separately.

Before to use the specified cluster a check is made to know if is allowed and figures in the configured and the record is valid following the constraints declared in the schema.

Specified by:

save in interface ODatabase<Object>

Parameters:

iPojo - The entity to save

iClusterName - Name of the cluster where to save

iMode - Mode of save: synchronous (default) or asynchronous

iForceCreate - Flag that indicates that record should be created. If record with current rid already exists, exception is thrown

See Also:

ODocument.validate()

delete

public ODatabaseObject delete(Object iPojo)

Description copied from interface: ODatabase

Deletes an entity from the database in synchronous mode.

Specified by:

delete in interface ODatabase<Object>

Parameters:

iPojo - The entity to delete.

Returns:

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

delete

public ODatabaseObject delete(ORID iRID)

Description copied from interface: ODatabase

Deletes the entity with the received RID from the database.

Specified by:

delete in interface ODatabase<Object>

Overrides:

delete in class ODatabasePojoAbstract<Object>

Parameters:

iRID - The RecordID to delete.

Returns:

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

delete

public ODatabaseObject 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<Object>

Overrides:

delete in class ODatabasePojoAbstract<Object>

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.

hide

public boolean hide(ORID rid)

Description copied from interface: ODatabase

Hides records content by putting tombstone on the records position but does not delete record itself.

This method is used in case of record content itself is broken and cannot be read or deleted. So it is emergence method. This method can be used only if there is no active transaction in database.

Specified by:

hide in interface ODatabase<Object>

Parameters:

rid - record id.

Returns:

true if record was hidden and false if record does not exits in database.

cleanOutRecord

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

Specified by:

cleanOutRecord in interface ODatabase<Object>

Overrides:

cleanOutRecord in class ODatabasePojoAbstract<Object>

countClass

public long countClass(String iClassName)

Description copied from interface: ODatabaseSchemaAware

Counts the entities contained in the specified class and sub classes (polymorphic).

Specified by:

countClass in interface ODatabaseSchemaAware<Object>

Parameters:

iClassName - Class name

Returns:

Total entities

countClass

public long countClass(String iClassName,
                       boolean iPolymorphic)

Description copied from interface: ODatabaseSchemaAware

Counts the entities contained in the specified class.

Specified by:

countClass in interface ODatabaseSchemaAware<Object>

Parameters:

iClassName - Class name

iPolymorphic - True if consider also the sub classes, otherwise false

Returns:

Total entities

countClass

public long countClass(Class<?> iClass)

getDictionary

public ODictionary<Object> getDictionary()

Description copied from interface: ODatabase

Returns the Dictionary manual index.

Specified by:

getDictionary in interface ODatabase<Object>

Returns:

ODictionary instance

commit

public ODatabasePojoAbstract<Object> 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<Object>

Overrides:

commit in class ODatabasePojoAbstract<Object>

Returns:

commit

public ODatabasePojoAbstract<Object> commit(boolean force)
                                     throws OTransactionException

Specified by:

commit in interface ODatabase<Object>

Overrides:

commit in class ODatabasePojoAbstract<Object>

Throws:

OTransactionException

rollback

public ODatabasePojoAbstract<Object> 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<Object>

Overrides:

rollback in class ODatabasePojoAbstract<Object>

Returns:

rollback

public ODatabasePojoAbstract<Object> rollback(boolean force)
                                       throws OTransactionException

Specified by:

rollback in interface ODatabase<Object>

Overrides:

rollback in class ODatabasePojoAbstract<Object>

Throws:

OTransactionException

getEntityManager

public OEntityManager getEntityManager()

Description copied from interface: ODatabaseObject

Returns the entity manager that handle the binding from ODocuments and POJOs.

Specified by:

getEntityManager in interface ODatabaseObject

Returns:

getUnderlying

public ODatabaseDocumentInternal getUnderlying()

Description copied from interface: ODatabaseInternal

Return the underlying database. Used in wrapper instances to know the down level ODatabase instance.

Specified by:

getUnderlying in interface ODatabaseInternal<Object>

Overrides:

getUnderlying in class ODatabaseWrapperAbstract<ODatabaseDocumentTx,Object>

Returns:

The underlying ODatabase implementation.

getVersion

public int getVersion(Object iPojo)

Returns the version number of the object. Version starts from 0 assigned on creation.

Overrides:

getVersion in class ODatabasePojoAbstract<Object>

Parameters:

iPojo - User object

getIdentity

public ORID getIdentity(Object iPojo)

Returns the object unique identity.

Overrides:

getIdentity in class ODatabasePojoAbstract<Object>

Parameters:

iPojo - User object

isSaveOnlyDirty

public boolean isSaveOnlyDirty()

setSaveOnlyDirty

public void setSaveOnlyDirty(boolean saveOnlyDirty)

isAutomaticSchemaGeneration

public boolean isAutomaticSchemaGeneration()

setAutomaticSchemaGeneration

public void setAutomaticSchemaGeneration(boolean automaticSchemaGeneration)

newInstance

public Object newInstance()

Description copied from interface: ODatabase

Creates a new entity instance.

Specified by:

newInstance in interface ODatabase<Object>

Returns:

The new instance.

checkSecurity

public <DBTYPE extends ODatabase> DBTYPE checkSecurity(ORule.ResourceGeneric resourceGeneric,
                                                       String resourceSpecific,
                                                       byte iOperation)

checkSecurity

public <DBTYPE extends ODatabase> DBTYPE checkSecurity(ORule.ResourceGeneric iResource,
                                                       int iOperation,
                                                       Object iResourceSpecific)

checkSecurity

public <DBTYPE extends ODatabase> DBTYPE checkSecurity(ORule.ResourceGeneric iResource,
                                                       int iOperation,
                                                       Object... iResourcesSpecific)

pojo2Stream

public ODocument pojo2Stream(Object iPojo,
                             ODocument iRecord)

Specified by:

pojo2Stream in interface ODatabaseObject

Specified by:

pojo2Stream in class ODatabasePojoAbstract<Object>

stream2pojo

public Object stream2pojo(ODocument iRecord,
                          Object iPojo,
                          String iFetchPlan)

Specified by:

stream2pojo in interface ODatabaseObject

Specified by:

stream2pojo in class ODatabasePojoAbstract<Object>

stream2pojo

public Object stream2pojo(ODocument iRecord,
                          Object iPojo,
                          String iFetchPlan,
                          boolean iReload)

isLazyLoading

public boolean isLazyLoading()

Specified by:

isLazyLoading in interface ODatabaseObject

setLazyLoading

public void setLazyLoading(boolean lazyLoading)

Specified by:

setLazyLoading in interface ODatabaseObject

getType

public String getType()

Specified by:

getType in interface ODatabase<Object>

getConflictStrategy

public ORecordConflictStrategy getConflictStrategy()

Description copied from interface: ODatabase

Returns the current record conflict strategy.

Specified by:

getConflictStrategy in interface ODatabase<Object>

setConflictStrategy

public OObjectDatabaseTx setConflictStrategy(ORecordConflictStrategy iResolver)

Description copied from interface: ODatabase

Overrides record conflict strategy.

Specified by:

setConflictStrategy in interface ODatabase<Object>

Parameters:

iResolver - ORecordConflictStrategy implementation

Returns:

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

setConflictStrategy

public OObjectDatabaseTx setConflictStrategy(String iStrategyName)

Description copied from interface: ODatabase

Overrides record conflict strategy selecting the strategy by name.

Specified by:

setConflictStrategy in interface ODatabase<Object>

Parameters:

iStrategyName - ORecordConflictStrategy strategy name

Returns:

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

getRecordByUserObject

public ODocument getRecordByUserObject(Object iPojo,
                                       boolean iCreateIfNotAvailable)

Description copied from interface: OUserObject2RecordHandler

Returns the record associated to a user object. If iCreateIfNotAvailable is true, then a new record instance will be created transparently.

Specified by:

getRecordByUserObject in interface OUserObject2RecordHandler

Overrides:

getRecordByUserObject in class ODatabasePojoAbstract<Object>

Parameters:

iPojo - User object

iCreateIfNotAvailable - Create the record if not available

Returns:

The record associated

getUserObjectByRecord

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

Overrides:

getUserObjectByRecord in class ODatabasePojoAbstract<Object>

registerUserObject

public void registerUserObject(Object iObject,
                               ORecord iRecord)

Description copied from class: ODatabasePojoAbstract

Register a new POJO

Specified by:

registerUserObject in interface OUserObject2RecordHandler

Overrides:

registerUserObject in class ODatabasePojoAbstract<Object>

Parameters:

iObject - User object

iRecord - record

registerUserObjectAfterLinkSave

public void registerUserObjectAfterLinkSave(ORecord iRecord)

Description copied from interface: OUserObject2RecordHandler

Registers the saved linked record. Needed only to make the old object database implementation work

Specified by:

registerUserObjectAfterLinkSave in interface OUserObject2RecordHandler

Parameters:

iRecord - record

unregisterPojo

public void unregisterPojo(Object iObject,
                           ODocument iRecord)

Overrides:

unregisterPojo in class ODatabasePojoAbstract<Object>

registerClassMethodFilter

public void registerClassMethodFilter(Class<?> iClass,
                                      OObjectMethodFilter iMethodFilter)

deregisterClassMethodFilter

public void deregisterClassMethodFilter(Class<?> iClass)

incrementalBackup

public String incrementalBackup(String path)

Description copied from interface: ODatabase

Performs incremental backup of database content to the selected folder. This is thread safe operation and can be done in normal operational mode.

If it will be first backup of data full content of database will be copied into folder otherwise only changes after last backup in the same folder will be copied.

Specified by:

incrementalBackup in interface ODatabase<Object>

Parameters:

path - Path to backup folder.

Returns:

File name of the backup

resetInitialization

public void resetInitialization()

Specified by:

resetInitialization in interface ODatabaseInternal<Object>

detachAll

protected <RET> RET detachAll(Object iPojo,
                              boolean returnNonProxiedInstance,
                              Map<Object,Object> alreadyDetached,
                              Map<Object,Object> lazyObjects)

deleteCascade

protected void deleteCascade(ODocument record)

init

protected void init()

deleteOrphans

protected void deleteOrphans(OObjectProxyMethodHandler handler)

addBlobCluster

public int addBlobCluster(String iClusterName,
                          Object... iParameters)

Description copied from interface: ODatabase

Adds a new cluster for store blobs.

Specified by:

addBlobCluster in interface ODatabase<Object>

Parameters:

iClusterName - Cluster name

iParameters - Additional parameters to pass to the factories

Returns:

Cluster id

getBlobClusterIds

public Set<Integer> getBlobClusterIds()

Description copied from interface: ODatabase

Retrieve the set of defined blob cluster.

Specified by:

getBlobClusterIds in interface ODatabase<Object>

Returns:

the set of defined blob cluster ids.