org.castor.jdo.engine
Class DatabaseContext

java.lang.Object
  org.castor.jdo.engine.DatabaseContext

public final class DatabaseContext
extends Object

Since:

0.9.9

Version:

$Revision: 8994 $ $Date: 2011-08-02 01:40:59 +0200 (Di, 02 Aug 2011) $

Author:

Werner Guttmann, Ralf Joachim

Field Summary

static String

GENERIC_ENGINE The name of the generic SQL engine, if no SQL engine specified.

Constructor Summary

protected	DatabaseContext(JdoConf jdoConf, int index, Mapping mapping, ConnectionFactory factory) Constructs a new AbstractConnectionFactory with given database and mapping.
protected	DatabaseContext(String name, String engine, Mapping mapping, TransactionManager txManager, ConnectionFactory factory) Constructs a new AbstractConnectionFactory with given name, engine and mapping.

Method Summary

ConnectionFactory	getConnectionFactory()
Database	getDatabase() Get the database configuration.
LockEngine	getEngine() Get the LockEngine only available after initialization.
Mapping	getMapping() Get the mapping to load.
String	getName() Get the name of the database configuration.
TransactionManager	getTransactionManager() Get the transaction manager.
void	initialize() Initialize factory if it had not been initialized before.
void	initializeFactory() Method initializing ConnectionFactory.
void	setClassDescriptorResolver(JDOClassDescriptorResolver classDescriptorResolver) Sets a custom ClassDescriptorResolver instance.

Methods inherited from class java.lang.Object

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

Field Detail

GENERIC_ENGINE

public static final String GENERIC_ENGINE

The name of the generic SQL engine, if no SQL engine specified.

See Also:

Constant Field Values

Constructor Detail

DatabaseContext

protected DatabaseContext(String name,
                          String engine,
                          Mapping mapping,
                          TransactionManager txManager,
                          ConnectionFactory factory)
                   throws MappingException

Constructs a new AbstractConnectionFactory with given name, engine and mapping. Factory will be ready to use without calling initialize first.

Parameters:

name - The Name of the database configuration.

engine - The Name of the persistence factory to use.

txManager - The transaction manager to use.

mapping - The previously loaded mapping.

Throws:

MappingException - If LockEngine could not be initialized.

DatabaseContext

protected DatabaseContext(JdoConf jdoConf,
                          int index,
                          Mapping mapping,
                          ConnectionFactory factory)

Constructs a new AbstractConnectionFactory with given database and mapping. Initialize needs to be called before using the factory to create connections.

Parameters:

jdoConf - The JDO configuration.

index - Index of the database configuration in the JDO configuration.

mapping - The mapping to load.

Method Detail

initialize

public void initialize()
                throws MappingException

Initialize factory if it had not been initialized before.

Throws:

MappingException - If concrete factory or LockEngine fail to initialize or mapping could not be loaded.

initializeFactory

public void initializeFactory()
                       throws MappingException

Method initializing ConnectionFactory.

Throws:

MappingException - If concrete factory could not be initialized.

getConnectionFactory

public ConnectionFactory getConnectionFactory()

getName

public String getName()

Get the name of the database configuration.

Returns:

The name of the database configuration.

getDatabase

public Database getDatabase()

Get the database configuration.

Returns:

The database configuration.

getMapping

public Mapping getMapping()

Get the mapping to load.

Returns:

The mapping to load.

getTransactionManager

public TransactionManager getTransactionManager()

Get the transaction manager.

Returns:

The transaction manager.

getEngine

public LockEngine getEngine()

Get the LockEngine only available after initialization.

Returns:

The LockEngine.

setClassDescriptorResolver

public void setClassDescriptorResolver(JDOClassDescriptorResolver classDescriptorResolver)

Sets a custom ClassDescriptorResolver instance.

Parameters:

classDescriptorResolver - A custom ClassDescriptorResolver instance to be used.