FactoryClassSubTask (XDoclet 1.2.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

xdoclet.modules.hibernate
Class FactoryClassSubTask

java.lang.Object
  xdoclet.DocletSupport
      xdoclet.SubTask
          xdoclet.TemplateSubTask
              xdoclet.modules.hibernate.FactoryClassSubTask

All Implemented Interfaces:: xdoclet.modules.hibernate.HibernateProperties, Serializable

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" @ xdoclet.merge-file file="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"
created: August 8, 2003

Nested Class Summary

Nested classes 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(xjavadoc.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`	`getUserName()`
`String`	`getUserTransactionName()`
`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()` 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