xdoclet.modules.jdo

Class JdoXmlMetadataSubTask

Implemented Interfaces:
Serializable

public class JdoXmlMetadataSubTask
extends xdoclet.XmlSubTask

Generates the XML metadata for the JDO classes.
Version:
$Revision: 1.11 $
Authors:
Ludovic Claude (ludovicc@users.sourceforge.net)
David Jencks (d_jencks@users.sourceforge.net)
ant.element
display-name = "JDO XML MetaData" name = "jdometadata" parent = "xdoclet.modules.jdo.JdoDocletTask"
created
June 11, 20012

Nested Class Summary

static class
JdoXmlMetadataSubTask.GenerationOptionTypes

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

JdoXmlMetadataSubTask()
Describe what the WebXmlSubTask constructor does

Method Summary

protected void
engineStarted()
Describe what the method does
void
execute()
Describe what the method does
protected void
generateForPackage(XPackage pkg)
Processed template for pkg and generates output file for pkg.
protected String
getGeneratedFileName(XPackage pak)
Returns class name for the generated file.
String
getGeneration()
String
getJdoSpec()
Gets the Jdospec attribute of the JdoXmlSubTask object
String
getProject()
protected boolean
isForceGenerationPerPackage()
protected boolean
isGenerationPerClass()
protected boolean
isGenerationPerPackage()
protected void
setForceGenerationPerPackage(boolean value)
void
setGeneration(JdoXmlMetadataSubTask.GenerationOptionTypes value)
void
setJdoSpec(JdoSpecVersion jdoSpec)
Sets the Jdospec attribute of the JdoXmlSubTask object
void
setProject(String project)
void
startProcess()
protected void
startProcessPerPackage()
void
validateOptions()
Called to validate configuration parameters.

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

Constructor Details

JdoXmlMetadataSubTask

public JdoXmlMetadataSubTask()
Describe what the WebXmlSubTask constructor does

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Describe what the method does
Overrides:
engineStarted in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException -

execute

public void execute()
            throws xdoclet.XDocletException
Describe what the method does
Overrides:
execute in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException -

generateForPackage

protected void generateForPackage(XPackage pkg)
            throws xdoclet.XDocletException
Processed template for pkg and generates output file for pkg.
Parameters:
pkg - Description of Parameter
Throws:
xdoclet.XDocletException - Description of Exception

getGeneratedFileName

protected String getGeneratedFileName(XPackage pak)
            throws xdoclet.XDocletException
Returns class name for the generated file. {0} substituted by package name.
Parameters:
pak -
Returns:
The GeneratedClassName value
Throws:
xdoclet.XDocletException - Description of Exception

getGeneration

public String getGeneration()

getJdoSpec

public String getJdoSpec()
Gets the Jdospec attribute of the JdoXmlSubTask object
Returns:
The Jdospec value

getProject

public String getProject()

isForceGenerationPerPackage

protected boolean isForceGenerationPerPackage()

isGenerationPerClass

protected boolean isGenerationPerClass()
Returns:
To do:
make isGenerationPerClass() in TemplateSubTask protected

isGenerationPerPackage

protected boolean isGenerationPerPackage()

setForceGenerationPerPackage

protected void setForceGenerationPerPackage(boolean value)

setGeneration

public void setGeneration(JdoXmlMetadataSubTask.GenerationOptionTypes value)

setJdoSpec

public void setJdoSpec(JdoSpecVersion jdoSpec)
Sets the Jdospec attribute of the JdoXmlSubTask object
Parameters:
jdoSpec - The new Jdospec value

setProject

public void setProject(String project)

startProcess

public void startProcess()
            throws xdoclet.XDocletException
Overrides:
startProcess in interface xdoclet.XmlSubTask

startProcessPerPackage

protected void startProcessPerPackage()
            throws xdoclet.XDocletException

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Overrides:
validateOptions in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException - Description of Exception