xdoclet.modules.hibernate

Class FactoryClassSubTask

public class FactoryClassSubTask extends TemplateSubTask implements HibernateProperties

Generate a SessionFactory facade that is capable of configuring Hibernate inline, as well as provide a convenient method of switching later to other SessionFactory implementations.

Version: $Revision: 1.8 $

Author: Brian Topping (topping@bill2.com)

UNKNOWN: August 8, 2003 name = "factoryclass" display-name = "Factory class generator" parent = "xdoclet.modules.hibernate.HibernateDocletTask" = "hibernate-factory-custom.xdt" relates-to = "HibernateFactory.java" description = "A Java unparsed entity or XDoclet template file, for custom * elements to be included in the generated HibernateFactory.java"

Constructor Summary
FactoryClassSubTask()
Constructor for the HibernateSubTask object
Method Summary
protected voidengineStarted()
Called when the engine is started
voidexecute()
Describe what the method does
StringgetDataSource()
StringgetDialect()
StringgetDriver()
StringgetFactoryClass()
protected StringgetGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the EntityCmpSubTask object
StringgetJdbcUrl()
StringgetJndiName()
CollectiongetJndiProperties()
CollectiongetOtherMappings()
We don't provide/have/use other mappings here for now.
CollectiongetOtherProperties()
StringgetPassword()
StringgetPoolSize()
booleangetShowSql()
StringgetTransactionManagerStrategy()
booleangetUseOuterJoin()
StringgetUsername()
StringgetUserName()
StringgetUserTransactionName()
booleanisUseJndiFactory()
voidsetDataSource(String dataSource)
The data source name to be generated into the factory
voidsetDialect(String dialect)
The Hibernate DB dialect to be generated into the factory
voidsetDriver(String driver)
The driver class name to be generated into the factory
voidsetFactoryClass(String factoryClass)
The fully qualified class name of the generated factory
voidsetJdbcUrl(String jdbcUrl)
voidsetJndiName(String jndiName)
voidsetPassword(String password)
The password to be generated into the factory
voidsetPoolSize(String poolSize)
voidsetUseJndiFactory(boolean useJndiFactory)
voidsetUsername(String username)
The username to be generated into the factory
voidvalidateOptions()

Constructor Detail

FactoryClassSubTask

public FactoryClassSubTask()
Constructor for the HibernateSubTask object

Method Detail

engineStarted

protected void engineStarted()
Called when the engine is started

Throws: XDocletException Thrown in case of problem

execute

public void execute()
Describe what the method does

Throws: XDocletException Describe the exception

getDataSource

public String getDataSource()

getDialect

public String getDialect()

getDriver

public String getDriver()

getFactoryClass

public String getFactoryClass()

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the EntityCmpSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: XDocletException

getJdbcUrl

public String getJdbcUrl()

getJndiName

public String getJndiName()

getJndiProperties

public Collection getJndiProperties()

getOtherMappings

public Collection getOtherMappings()
We don't provide/have/use other mappings here for now.

Returns:

See Also: xdoclet.modules.hibernate.HibernateProperties#getOtherMappings()

getOtherProperties

public Collection getOtherProperties()

getPassword

public String getPassword()

getPoolSize

public String getPoolSize()

getShowSql

public boolean getShowSql()

getTransactionManagerStrategy

public String getTransactionManagerStrategy()

getUseOuterJoin

public boolean getUseOuterJoin()

getUsername

public String getUsername()

getUserName

public String getUserName()

getUserTransactionName

public String getUserTransactionName()

isUseJndiFactory

public boolean isUseJndiFactory()

setDataSource

public void setDataSource(String dataSource)
The data source name to be generated into the factory

Parameters: dataSource

setDialect

public void setDialect(String dialect)
The Hibernate DB dialect to be generated into the factory

Parameters: dialect

setDriver

public void setDriver(String driver)
The driver class name to be generated into the factory

Parameters: driver

setFactoryClass

public void setFactoryClass(String factoryClass)
The fully qualified class name of the generated factory

Parameters: factoryClass

setJdbcUrl

public void setJdbcUrl(String jdbcUrl)

Parameters: jdbcUrl

setJndiName

public void setJndiName(String jndiName)

Parameters: jndiName

UNKNOWN:

setPassword

public void setPassword(String password)
The password to be generated into the factory

Parameters: password

setPoolSize

public void setPoolSize(String poolSize)

Parameters: poolSize

setUseJndiFactory

public void setUseJndiFactory(boolean useJndiFactory)

Parameters: useJndiFactory

UNKNOWN: No.Defaultis false.

setUsername

public void setUsername(String username)
The username to be generated into the factory

Parameters: username

validateOptions

public void validateOptions()