org.castor.jdo.engine

Class AbstractConnectionFactory

java.lang.Object

org.castor.jdo.engine.AbstractConnectionFactory

All Implemented Interfaces:

ConnectionFactory

Direct Known Subclasses:

DataSourceConnectionFactory, DriverConnectionFactory, JNDIConnectionFactory

public abstract class AbstractConnectionFactory
extends java.lang.Object
implements ConnectionFactory

Since:

0.9.9

Version:

$Revision: 6028 $ $Date: 2006-04-10 16:39:24 -0600 (Mon, 10 Apr 2006) $

Author:

Werner Guttmann, Ralf Joachim

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GENERIC_ENGINE The name of the generic SQL engine, if no SQL engine specified.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConnectionFactory(JdoConf jdoConf, int index, Mapping mapping) Constructs a new AbstractConnectionFactory with given database and mapping.
protected	AbstractConnectionFactory(java.lang.String name, java.lang.String engine, Mapping mapping, javax.transaction.TransactionManager txManager) Constructs a new AbstractConnectionFactory with given name, engine and mapping.

Method Summary

Modifier and Type	Method and Description
Database	getDatabase() Get the database configuration.
LockEngine	getEngine() Get the LockEngine only available after initialization.
Mapping	getMapping() Get the mapping to load.
java.lang.String	getName() Get the name of the database configuration.
javax.transaction.TransactionManager	getTransactionManager() Get the transaction manager.
void	initialize() Initialize factory if it had not been initialized before.
protected abstract void	initializeFactory() Initialize the concrete factory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.castor.jdo.engine.ConnectionFactory

createConnection

Field Detail

GENERIC_ENGINE

public static final java.lang.String GENERIC_ENGINE

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

See Also:

Constant Field Values

Constructor Detail

AbstractConnectionFactory

protected AbstractConnectionFactory(java.lang.String name,
                                    java.lang.String engine,
                                    Mapping mapping,
                                    javax.transaction.TransactionManager txManager)
                             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.

AbstractConnectionFactory

protected AbstractConnectionFactory(JdoConf jdoConf,
                                    int index,
                                    Mapping mapping)

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 configuartion.

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

mapping - The mapping to load.

Method Detail

initialize

public final 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

protected abstract void initializeFactory()
                                   throws MappingException

Initialize the concrete factory.

Throws:

MappingException - If concrete factory could not be initialized.

getName

public final java.lang.String getName()

Get the name of the database configuration.

Returns:

The name of the database configuration.

getDatabase

public final Database getDatabase()

Get the database configuration.

Returns:

The database configuration.

getMapping

public final Mapping getMapping()

Get the mapping to load.

Returns:

The mapping to load.

getTransactionManager

public final javax.transaction.TransactionManager getTransactionManager()

Get the transaction manager.

Returns:

The transaction manager.

getEngine

public final LockEngine getEngine()

Get the LockEngine only available after initialization.

Returns:

The LockEngine.