xdoclet.modules.hibernate

Class HibernateSubTask

Implemented Interfaces:
Serializable

public class HibernateSubTask
extends xdoclet.XmlSubTask

This task generates Hibernate xml mapping file for a given class. Supports Hibernate 1.1, 2.0, 2.1 & 3.0.
Version:
$Revision: 1.12 $
Authors:
Sibastien Guimont (sebastieng@sympatico.ca)
David Channon
ant.element
name = "hibernate" display-name = "Hibernate Mapping File" parent = "xdoclet.modules.hibernate.HibernateDocletTask"
created
August 9th, 2002

Nested Class Summary

static class
HibernateSubTask.HibernateVersion

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

static String
DEFAULT_HIBERNATE_CLASS_PATTERN

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

HibernateSubTask()
Constructor for the HibernateSubTask object.

Method Summary

protected void
engineStarted()
Called when the engine is started
void
execute()
Generate Mapping file (*.hbm.xml).
String
getGeneratedFileName(XClass clazz)
String
getMappingURL(XClass clazz)
String
getVersion()
Get the Hibernate version.
protected boolean
processInnerClasses()
Since we want to support static inner classes, we set this to true.
void
setVersion(HibernateSubTask.HibernateVersion version)
Sets the hibernate version to use.

Methods inherited from class xdoclet.XmlSubTask

copyAttributesFrom, engineFinished, getDtdURL, getPublicId, getSchema, getSchemaURL, getSystemId, getUseIds, getXmlencoding, isValidateXML, setDtdURL, setPublicId, setSchema, setSchemaURL, setSystemId, setUseIds, setValidateXML, setXmlencoding, startProcess

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

Field Details

DEFAULT_HIBERNATE_CLASS_PATTERN

public static final String DEFAULT_HIBERNATE_CLASS_PATTERN

Constructor Details

HibernateSubTask

public HibernateSubTask()
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
Generate Mapping file (*.hbm.xml).
Overrides:
execute in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException -

getGeneratedFileName

public String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Overrides:
getGeneratedFileName in interface xdoclet.TemplateSubTask

getMappingURL

public String getMappingURL(XClass clazz)

getVersion

public String getVersion()
Get the Hibernate version.
Returns:

processInnerClasses

protected boolean processInnerClasses()
Since we want to support static inner classes, we set this to true.
Overrides:
processInnerClasses in interface xdoclet.TemplateSubTask
Returns:
true

setVersion

public void setVersion(HibernateSubTask.HibernateVersion version)
Sets the hibernate version to use. Legal values are "1.1", "2.0", "2.1" and "3.0".
Parameters:
version -
ant.not-required
"No. Default is '1.1'".