xdoclet.modules.hibernate

Class FactoryClassSubTask

Implemented Interfaces:
HibernateProperties, Serializable

public class FactoryClassSubTask
extends xdoclet.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)
ant.element
name = "factoryclass" display-name = "Factory class generator" parent = "xdoclet.modules.hibernate.HibernateDocletTask"
created
August 8, 2003

Nested Class Summary

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

FactoryClassSubTask()
Constructor for the HibernateSubTask object

Method Summary

protected void
engineStarted()
Called when the engine is started
void
execute()
Describe what the method does
String
getDataSource()
String
getDialect()
String
getDriver()
String
getFactoryClass()
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the EntityCmpSubTask object
String
getJdbcUrl()
String
getJndiName()
Collection
getJndiProperties()
Collection
getOtherMappings()
We don't provide/have/use other mappings here for now.
Collection
getOtherProperties()
String
getPassword()
String
getPoolSize()
boolean
getShowSql()
String
getTransactionManagerStrategy()
boolean
getUseOuterJoin()
String
getUserName()
String
getUserTransactionName()
String
getUsername()
boolean
isUseJndiFactory()
void
setDataSource(String dataSource)
The data source name to be generated into the factory
void
setDialect(String dialect)
The Hibernate DB dialect to be generated into the factory
void
setDriver(String driver)
The driver class name to be generated into the factory
void
setFactoryClass(String factoryClass)
The fully qualified class name of the generated factory
void
setJdbcUrl(String jdbcUrl)
void
setJndiName(String jndiName)
void
setPassword(String password)
The password to be generated into the factory
void
setPoolSize(String poolSize)
void
setUseJndiFactory(boolean useJndiFactory)
void
setUsername(String username)
The username to be generated into the factory
void
validateOptions()

Methods inherited from class xdoclet.TemplateSubTask

addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, engineStarted, execute, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGeneratedFileName, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, startProcessForAll, startProcessPerClass, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, copyAttributesFrom, execute, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Constructor Details

FactoryClassSubTask

public FactoryClassSubTask()
Constructor for the HibernateSubTask object

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Called when the engine is started
Overrides:
engineStarted in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException - Thrown in case of problem

execute

public void execute()
            throws xdoclet.XDocletException
Describe what the method does
Overrides:
execute in interface xdoclet.TemplateSubTask
Throws:
xdoclet.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)
            throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the EntityCmpSubTask object
Overrides:
getGeneratedFileName in interface xdoclet.TemplateSubTask
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
xdoclet.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()

getUserTransactionName

public String getUserTransactionName()

getUsername

public String getUsername()

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 -
ant.not-required

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 -
ant.not-required
No.Defaultis false.

setUsername

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

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Overrides:
validateOptions in interface xdoclet.TemplateSubTask