xdoclet.modules.hibernate
Class FactoryClassSubTask

java.lang.Object
  extended by xdoclet.DocletSupport
      extended by xdoclet.SubTask
          extended by xdoclet.TemplateSubTask
              extended by xdoclet.modules.hibernate.FactoryClassSubTask
All Implemented Interfaces:
java.io.Serializable, xdoclet.modules.hibernate.HibernateProperties

public class FactoryClassSubTask
extends TemplateSubTask
implements xdoclet.modules.hibernate.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)
See Also:
Serialized Form
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
 java.lang.String getDataSource()
           
 java.lang.String getDialect()
           
 java.lang.String getDriver()
           
 java.lang.String getFactoryClass()
           
protected  java.lang.String getGeneratedFileName(xjavadoc.XClass clazz)
          Gets the GeneratedFileName attribute of the EntityCmpSubTask object
 java.lang.String getJdbcUrl()
           
 java.lang.String getJndiName()
           
 java.util.Collection getJndiProperties()
           
 java.util.Collection getOtherMappings()
          We don't provide/have/use other mappings here for now.
 java.util.Collection getOtherProperties()
           
 java.lang.String getPassword()
           
 java.lang.String getPoolSize()
           
 boolean getShowSql()
           
 java.lang.String getTransactionManagerStrategy()
           
 boolean getUseOuterJoin()
           
 java.lang.String getUsername()
           
 java.lang.String getUserName()
           
 java.lang.String getUserTransactionName()
           
 boolean isUseJndiFactory()
           
 void setDataSource(java.lang.String dataSource)
          The data source name to be generated into the factory
 void setDialect(java.lang.String dialect)
          The Hibernate DB dialect to be generated into the factory
 void setDriver(java.lang.String driver)
          The driver class name to be generated into the factory
 void setFactoryClass(java.lang.String factoryClass)
          The fully qualified class name of the generated factory
 void setJdbcUrl(java.lang.String jdbcUrl)
           
 void setJndiName(java.lang.String jndiName)
           
 void setPassword(java.lang.String password)
          The password to be generated into the factory
 void setPoolSize(java.lang.String poolSize)
           
 void setUseJndiFactory(boolean useJndiFactory)
           
 void setUsername(java.lang.String username)
          The username to be generated into the factory
 void validateOptions()
          Called to validate configuration parameters.
 
Methods inherited from class xdoclet.TemplateSubTask
addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, 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
 
Methods inherited from class xdoclet.SubTask
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName
 
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FactoryClassSubTask

public FactoryClassSubTask()
Constructor for the HibernateSubTask object

Method Detail

getDataSource

public java.lang.String getDataSource()
Specified by:
getDataSource in interface xdoclet.modules.hibernate.HibernateProperties

getDialect

public java.lang.String getDialect()
Specified by:
getDialect in interface xdoclet.modules.hibernate.HibernateProperties

getDriver

public java.lang.String getDriver()
Specified by:
getDriver in interface xdoclet.modules.hibernate.HibernateProperties

getPassword

public java.lang.String getPassword()
Specified by:
getPassword in interface xdoclet.modules.hibernate.HibernateProperties

getUsername

public java.lang.String getUsername()

getFactoryClass

public java.lang.String getFactoryClass()

isUseJndiFactory

public boolean isUseJndiFactory()

getJndiProperties

public java.util.Collection getJndiProperties()
Specified by:
getJndiProperties in interface xdoclet.modules.hibernate.HibernateProperties

getOtherMappings

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

Specified by:
getOtherMappings in interface xdoclet.modules.hibernate.HibernateProperties
Returns:
See Also:
HibernateProperties.getOtherMappings()

getOtherProperties

public java.util.Collection getOtherProperties()
Specified by:
getOtherProperties in interface xdoclet.modules.hibernate.HibernateProperties

getTransactionManagerStrategy

public java.lang.String getTransactionManagerStrategy()
Specified by:
getTransactionManagerStrategy in interface xdoclet.modules.hibernate.HibernateProperties

getUserTransactionName

public java.lang.String getUserTransactionName()
Specified by:
getUserTransactionName in interface xdoclet.modules.hibernate.HibernateProperties

getUserName

public java.lang.String getUserName()
Specified by:
getUserName in interface xdoclet.modules.hibernate.HibernateProperties

getUseOuterJoin

public boolean getUseOuterJoin()
Specified by:
getUseOuterJoin in interface xdoclet.modules.hibernate.HibernateProperties

getShowSql

public boolean getShowSql()
Specified by:
getShowSql in interface xdoclet.modules.hibernate.HibernateProperties

getJndiName

public java.lang.String getJndiName()
Specified by:
getJndiName in interface xdoclet.modules.hibernate.HibernateProperties

getJdbcUrl

public java.lang.String getJdbcUrl()
Specified by:
getJdbcUrl in interface xdoclet.modules.hibernate.HibernateProperties

getPoolSize

public java.lang.String getPoolSize()
Specified by:
getPoolSize in interface xdoclet.modules.hibernate.HibernateProperties

setJndiName

public void setJndiName(java.lang.String jndiName)
Parameters:
jndiName -
ant.not-required

setJdbcUrl

public void setJdbcUrl(java.lang.String jdbcUrl)
Parameters:
jdbcUrl -

setPoolSize

public void setPoolSize(java.lang.String poolSize)
Parameters:
poolSize -

setDataSource

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

Parameters:
dataSource -

setDialect

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

Parameters:
dialect -

setDriver

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

Parameters:
driver -

setPassword

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

Parameters:
password -

setUsername

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

Parameters:
username -

setFactoryClass

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

Parameters:
factoryClass -

setUseJndiFactory

public void setUseJndiFactory(boolean useJndiFactory)
Parameters:
useJndiFactory -
ant.not-required
No.Defaultis false.

validateOptions

public void validateOptions()
                     throws XDocletException
Description copied from class: TemplateSubTask
Called to validate configuration parameters.

Overrides:
validateOptions in class TemplateSubTask
Throws:
XDocletException - Description of Exception

execute

public void execute()
             throws XDocletException
Describe what the method does

Overrides:
execute in class TemplateSubTask
Throws:
XDocletException - Describe the exception

getGeneratedFileName

protected java.lang.String getGeneratedFileName(xjavadoc.XClass clazz)
                                         throws XDocletException
Gets the GeneratedFileName attribute of the EntityCmpSubTask object

Overrides:
getGeneratedFileName in class TemplateSubTask
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
XDocletException

engineStarted

protected void engineStarted()
                      throws XDocletException
Called when the engine is started

Overrides:
engineStarted in class TemplateSubTask
Throws:
XDocletException - Thrown in case of problem

http://xdoclet.sourceforge.net/