xdoclet.modules.hibernate

Class HibernateCfgSubTask

public class HibernateCfgSubTask extends XmlSubTask implements HibernateProperties

Generate the hibernate.cfg.xml file. It lists all of the properties as well as a property for each hbm.xml file. This file can be used for creating and installing a SessionFactory in JNDI as well as launching Hibern8IDE.

Version: $Revision: 1.10 $

Author: Frederick N. Brier David Channon

UNKNOWN: February 6, 2004 name = "hibernatecfg" display-name = "Hibernate Configuration File Generation" parent = "xdoclet.modules.hibernate.HibernateDocletTask"

Nested Class Summary
static class	HibernateCfgSubTask.HibernateCFGVersion Based on Matt Raible's code for the Hibernate sub-task.

Constructor Summary
	HibernateCfgSubTask() Constructor for the HibernateSubTask object

Method Summary
void	addConfiguredJndiProperty(Parameter jndiProperty) These elements allow you to add properties to the JNDI context.
void	addOtherMapping(Parameter otherMapping) These elements allow you to add arbitrary mappings to cfg.xml file.
void	addOtherProperty(Parameter otherProperty) These elements allow you to add arbitrary properties to cfg.xml file.
protected void	engineStarted() Called when the engine is started
void	execute() Generate Hibernate Configuration file (hibernate.cfg.xml).
String	getCacheProviderClass()
String	getCglibUseReflectionOptimizer()
String	getDataSource()
String	getDefaultSchema()
String	getDialect()
String	getDriver()
String	getHbm2ddl()
String	getJdbcUrl()
String	getJndiName()
Collection	getJndiProperties()
Collection	getOtherMappings()
Collection	getOtherProperties()
String	getPassword()
String	getPoolSize()
boolean	getShowSql()
String	getTransactionManagerFactory()
String	getTransactionManagerLookup()
String	getTransactionManagerStrategy()
boolean	getUseOuterJoin()
String	getUserName()
String	getUserTransactionName()
String	getVersion() Get the Hibernate configuration DTD version.
void	setCacheProviderClass(String string) The classname of a custom CacheProvider.
void	setCglibUseReflectionOptimizer(String string) Enables use of CGLIB instead of runtime reflection (System-level property, default is to use CGLIB where possible).
void	setDataSource(String dataSource) JNDI name of data source to use in the session factory.
void	setDefaultSchema(String string) Qualify unqualified tablenames with the given schema/tablespace in generated SQL.
void	setDialect(String dialect) SQL dialect of the database.
void	setDriver(String driver) JDBC Driver to make database connection.
void	setHbm2ddl(String hbm2ddl) Automatically export schema DDL to the database when the SessionFactory is created.
void	setJdbcUrl(String jdbcUrl) URL for the JDBC Driver to make the connection to the database.
void	setJndiName(String jndiName) JNDI name to bind to the `SessionFactory`
void	setPassword(String password) Use this password to login to the database
void	setPoolSize(String poolSize) Hibernate connection pool size.
void	setShowSql(boolean showSql) Log sql statements.
void	setTransactionManagerFactory(String string) The classname of a TransactionFactory to use with Hibernate Transaction API (defaults to JDBCTransactionFactory). eg. classname.of.TransactionFactory
void	setTransactionManagerLookup(String transactionManagerLookup) The fully qualified class name of the Hibernate `TransactionFactory` implementation.
void	setTransactionManagerStrategy(String transactionManagerStrategy) Strategy for obtaining the JTA `TransactionManager`
void	setUseOuterJoin(boolean useOuterJoin) Whether to use outer join
void	setUserName(String userName) Use this user name to login to the database
void	setUserTransactionName(String userTransactionName) The JNDI name of the JTA UserTransaction object
void	setVersion(HibernateCfgSubTask.HibernateCFGVersion version) Sets the hibernate configuration DTD version to use.
void	validateOptions()

Constructor Detail

HibernateCfgSubTask

public HibernateCfgSubTask()

Constructor for the HibernateSubTask object

Method Detail

addConfiguredJndiProperty

public void addConfiguredJndiProperty(Parameter jndiProperty)

These elements allow you to add properties to the JNDI context. For instance, if you do not want Weblogic clustering to replicate the Hibernate SessionFactory, add a jndiProperty element with a "name" attribute of "weblogic.jndi.replicateBindings" and a "value" attribute of "false".

Parameters: jndiProperty

UNKNOWN: No.Emptyarray ofelements.

addOtherMapping

public void addOtherMapping(Parameter otherMapping)

These elements allow you to add arbitrary mappings to cfg.xml file. For instance, if you want to specify that a jar contains /example/myHibernate.hbm.xml file then specify a other mapping with the name="resource" and the value being the path to the mapping.

Parameters: otherMapping The feature to be added to the OtherMapping attribute

UNKNOWN: No.Emptyarray ofelements.

addOtherProperty

public void addOtherProperty(Parameter otherProperty)

These elements allow you to add arbitrary properties to cfg.xml file. For instance, if you want to provide your own "connection.provider_class" class then add a property called connection.provider_class with a value of whatever you want passed in.

Parameters: otherProperty The feature to be added to the OtherProperty attribute

UNKNOWN: No.Emptyarray ofelements.

engineStarted

protected void engineStarted()

Called when the engine is started

Throws: XDocletException Thrown in case of problem

execute

public void execute()

Generate Hibernate Configuration file (hibernate.cfg.xml).

Throws: XDocletException

getCacheProviderClass

public String getCacheProviderClass()

Returns:

getCglibUseReflectionOptimizer

public String getCglibUseReflectionOptimizer()

Returns:

getDataSource

public String getDataSource()

getDefaultSchema

public String getDefaultSchema()

Returns:

getDialect

public String getDialect()

getDriver

public String getDriver()

getHbm2ddl

public String getHbm2ddl()

getJdbcUrl

public String getJdbcUrl()

getJndiName

public String getJndiName()

getJndiProperties

public Collection getJndiProperties()

getOtherMappings

public Collection getOtherMappings()

getOtherProperties

public Collection getOtherProperties()

getPassword

public String getPassword()

getPoolSize

public String getPoolSize()

getShowSql

public boolean getShowSql()

getTransactionManagerFactory

public String getTransactionManagerFactory()

Returns:

getTransactionManagerLookup

public String getTransactionManagerLookup()

getTransactionManagerStrategy

public String getTransactionManagerStrategy()

getUseOuterJoin

public boolean getUseOuterJoin()

getUserName

public String getUserName()

getUserTransactionName

public String getUserTransactionName()

getVersion

public String getVersion()

Get the Hibernate configuration DTD version.

Returns:

setCacheProviderClass

public void setCacheProviderClass(String string)

The classname of a custom CacheProvider.

Parameters: string

UNKNOWN:

setCglibUseReflectionOptimizer

public void setCglibUseReflectionOptimizer(String string)

Enables use of CGLIB instead of runtime reflection (System-level property, default is to use CGLIB where possible). Reflection can sometimes be useful when troubleshooting.

Parameters: string

UNKNOWN:

setDataSource

public void setDataSource(String dataSource)

JNDI name of data source to use in the session factory.

Parameters: dataSource

UNKNOWN:

setDefaultSchema

public void setDefaultSchema(String string)

Qualify unqualified tablenames with the given schema/tablespace in generated SQL.

Parameters: string

UNKNOWN:

setDialect

public void setDialect(String dialect)

SQL dialect of the database.

Parameters: dialect

UNKNOWN: Yes.Usefully-qualified classname.

setDriver

public void setDriver(String driver)

JDBC Driver to make database connection.

Parameters: driver

UNKNOWN:

setHbm2ddl

public void setHbm2ddl(String hbm2ddl)

Automatically export schema DDL to the database when the SessionFactory is created. With create-drop, the database schema will be dropped when the SessionFactory is closed explicitely. eg. update | create | create-drop

Parameters: hbm2ddl

UNKNOWN: