xdoclet.modules.jdo

Class JdoXmlMetadataSubTask

public class JdoXmlMetadataSubTask extends XmlSubTask

Generates the XML metadata for the JDO classes.

Version: $Revision: 1.11 $

Author: Ludovic Claude (ludovicc@users.sourceforge.net) David Jencks (d_jencks@users.sourceforge.net)

UNKNOWN: June 11, 20012 display-name = "JDO XML MetaData" name = "jdometadata" parent = "xdoclet.modules.jdo.JdoDocletTask" file = "vendor-extensions.xml" relates-to = "generated .jdo files" description = "An XML unparsed * entity containing any additional vendor extensions i.e. top-level extension elements."

Nested Class Summary
static classJdoXmlMetadataSubTask.GenerationOptionTypes
Constructor Summary
JdoXmlMetadataSubTask()
Describe what the WebXmlSubTask constructor does
Method Summary
protected voidengineStarted()
Describe what the method does
voidexecute()
Describe what the method does
protected voidgenerateForPackage(XPackage pkg)
Processed template for pkg and generates output file for pkg.
protected StringgetGeneratedFileName(XPackage pak)
Returns class name for the generated file.
StringgetGeneration()
StringgetJdoSpec()
Gets the Jdospec attribute of the JdoXmlSubTask object
StringgetProject()
protected booleanisForceGenerationPerPackage()
protected booleanisGenerationPerClass()
protected booleanisGenerationPerPackage()
protected voidsetForceGenerationPerPackage(boolean value)
voidsetGeneration(JdoXmlMetadataSubTask.GenerationOptionTypes value)
voidsetJdoSpec(JdoDocletTask.JdoSpecVersion jdoSpec)
Sets the Jdospec attribute of the JdoXmlSubTask object
voidsetProject(String project)
voidstartProcess()
protected voidstartProcessPerPackage()
voidvalidateOptions()
Called to validate configuration parameters.

Constructor Detail

JdoXmlMetadataSubTask

public JdoXmlMetadataSubTask()
Describe what the WebXmlSubTask constructor does

Method Detail

engineStarted

protected void engineStarted()
Describe what the method does

Throws: XDocletException

execute

public void execute()
Describe what the method does

Throws: XDocletException

generateForPackage

protected void generateForPackage(XPackage pkg)
Processed template for pkg and generates output file for pkg.

Parameters: pkg Description of Parameter

Throws: XDocletException Description of Exception

getGeneratedFileName

protected String getGeneratedFileName(XPackage pak)
Returns class name for the generated file. {0} substituted by package name.

Parameters: pak

Returns: The GeneratedClassName value

Throws: 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:

UNKNOWN: 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(JdoDocletTask.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()

startProcessPerPackage

protected void startProcessPerPackage()

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException Description of Exception