org.exolab.castor.jdo.engine

Class AbstractDatabaseImpl

public abstract class AbstractDatabaseImpl extends Object implements Database

An implementation of the JDO database supporting explicit transaction demarcation.

Version: $Revision: 6230 $ $Date: 2006-04-22 11:05:30 -0600 (Sat, 22 Apr 2006) $

Field Summary
protected boolean	_autoStore True if user prefer all reachable object to be stored automatically.
protected CallbackInterceptor	_callback The default callback interceptor for transaction
protected ClassLoader	_classLoader The class loader for application classes (may be null).
protected TransactionContext	_ctx The transaction context is this database was accessed with an javax.transaction.xa.XAResource.
protected String	_dbName The name of this database.
protected InstanceFactory	_instanceFactory The instance factory to that creates new instances of data object
protected int	_lockTimeout The lock timeout for this database.
protected PersistenceInfoGroup	_scope The database engine used to access the underlying SQL database.

Constructor Summary
	AbstractDatabaseImpl(String dbName, int lockTimeout, CallbackInterceptor callback, InstanceFactory instanceFactory, ClassLoader classLoader, boolean autoStore) Creates an instance of this class

Method Summary
abstract void	begin()
abstract void	close()
abstract void	commit()
void	create(Object object)
CacheManager	getCacheManager()
ClassLoader	getClassLoader() Gets the current application ClassLoader's instance.
TransactionContext	getCurrentTransaction() Gets the current Castor transaction in use.
String	getDatabaseName() Return the name of the database
Identity	getIdentity(Object object)
abstract Connection	getJdbcConnection()
LockEngine	getLockEngine() Returns the LockEngine in use by this database instance.
OQLQuery	getNamedQuery(String name)
OQLQuery	getOQLQuery()
OQLQuery	getOQLQuery(String oql)
Query	getQuery()
PersistenceInfoGroup	getScope()
protected TransactionContext	getTransaction() Returns the currently active transaction, if any.
boolean	isActive()
boolean	isAutoStore() Return if the current transaction is set to autoStore, it there is transaction active.
boolean	isClosed()
boolean	isLocked(Class cls, Object identity)
boolean	isPersistent(Object object)
Object	load(Class type, Object identity)
Object	load(Class type, Object identity, Object object)
Object	load(Class type, Object identity, AccessMode mode)
protected void	loadSynchronizables() Load the TxSynchronizable implementations from the properties file, if not loaded before.
void	lock(Object object)
protected void	registerSynchronizables() Register the TxSynchronizable implementations at the TransactionContect at end of begin().
void	remove(Object object)
abstract void	rollback()
void	setAutoStore(boolean autoStore) Indicates whether user prefer all reachable object to be stored automatically; false if user wants dependent object only to be stored.
String	toString()
protected void	unregisterSynchronizables() Unregister the TxSynchronizable implementations at the TransactionContect after commit() or rollback().
void	update(Object object)

Field Detail

_autoStore

protected boolean _autoStore

True if user prefer all reachable object to be stored automatically. False if user want only dependent object to be stored.

_callback

protected CallbackInterceptor _callback

The default callback interceptor for transaction

_classLoader

protected ClassLoader _classLoader

The class loader for application classes (may be null).

_ctx

protected TransactionContext _ctx

The transaction context is this database was accessed with an javax.transaction.xa.XAResource.

_dbName

protected String _dbName

The name of this database.

_instanceFactory

protected InstanceFactory _instanceFactory

The instance factory to that creates new instances of data object

_lockTimeout

protected int _lockTimeout

The lock timeout for this database. Zero for immediate timeout, an infinite value for no timeout. The timeout is specified in seconds.

_scope

protected PersistenceInfoGroup _scope

The database engine used to access the underlying SQL database.

Constructor Detail

AbstractDatabaseImpl

public AbstractDatabaseImpl(String dbName, int lockTimeout, CallbackInterceptor callback, InstanceFactory instanceFactory, ClassLoader classLoader, boolean autoStore)

Creates an instance of this class

Parameters: dbName Name of the database. lockTimeout Lock timeout to use callback Callback interceptors instanceFactory Instance factory classLoader Current class loader. autoStore True if auto storing is enabled.

Throws: DatabaseNotFoundException If there's no database configuration for the given name.

Method Detail

begin

public abstract void begin()

close

public abstract void close()

commit

public abstract void commit()

create

public void create(Object object)

See Also: Database

UNKNOWN:

getCacheManager

public CacheManager getCacheManager()

getClassLoader

public ClassLoader getClassLoader()

Gets the current application ClassLoader's instance.

Returns: the current ClassLoader's instance, or null if not provided

getCurrentTransaction

public TransactionContext getCurrentTransaction()

Gets the current Castor transaction in use.

Returns: the current Castor

Throws: TransactionNotInProgressException If there's no transaction in progress.

getDatabaseName

public String getDatabaseName()

Return the name of the database

Returns: Name of the database.

getIdentity

public Identity getIdentity(Object object)

See Also: Database

UNKNOWN:

getJdbcConnection

public abstract Connection getJdbcConnection()

getLockEngine

LockEngine getLockEngine()

Returns the LockEngine in use by this database instance.

Returns: the LockEngine in use by this database instance.

getNamedQuery

public OQLQuery getNamedQuery(String name)

See Also: Database

UNKNOWN:

getOQLQuery

public OQLQuery getOQLQuery()

getOQLQuery

public OQLQuery getOQLQuery(String oql)

See Also: Database

UNKNOWN:

getQuery

public Query getQuery()

getScope

public PersistenceInfoGroup getScope()

getTransaction

protected TransactionContext getTransaction()

Returns the currently active transaction, if any.

Returns: The current active transaction.

Throws: TransactionNotInProgressException If there's no active transaction.

isActive

public boolean isActive()

isAutoStore

public boolean isAutoStore()

Return if the current transaction is set to autoStore, it there is transaction active. If there is no active transaction, return if the next transaction will be set to autoStore.

Returns: True if 'auto-store' mode is in use.