org.apache.torque.mojo
Class DataDtdMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.torque.mojo.TexenTaskMojo
          org.apache.torque.mojo.DataModelTaskMojo
              org.apache.torque.mojo.DataDtdMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class DataDtdMojo
extends DataModelTaskMojo

Generates a data dtd from schema files.

Author:

Raphael Pieroni (rafale_at_codehaus.org), Thomas Fischer

Field Summary

static String

PROJECT_CONTEXT_PROPERTY The context property for the name of the project.

Fields inherited from class org.apache.torque.mojo.DataModelTaskMojo

TARGET_DATABASE_CONTEXT_PROPERTY

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

DataDtdMojo()
Creates a new SQLMojo object.

Method Summary

protected void	configureTask() Configures the Texen task which is wrapped by this mojo.
protected String	getControlTemplate() Returns the path to the control template.
protected org.apache.commons.configuration.PropertiesConfiguration	getMojoContextProperties() Returns the context properties for the Texen task.
String	getProjectName() Returns the name of the project, which is used as prefix for the name of the datadtd.
String	getXmlFile() Returns the name of the xml file to process.
void	setProjectName(String projectName) Sets the name of the project, which is used as prefix for the name of the datadtd.
void	setXmlFile(String xmlFile) Sets the name of the xml file to process.

Methods inherited from class org.apache.torque.mojo.DataModelTaskMojo

execute, getReportFile, getSchemaDir, getSchemaExcludes, getSchemaIncludes, getSqlDbMap, getTargetDatabase, getTargetPackage, isRunOnlyOnSchemaChange, schemaChanged, setReportFile, setRunOnlyOnSchemaChange, setSchemaDir, setSchemaExcludes, setSchemaIncludes, setSqlDbMap, setTargetDatabase, setTargetPackage

Methods inherited from class org.apache.torque.mojo.TexenTaskMojo

generateContextProperties, getAntProject, getContextPropertiesPath, getGeneratorTask, getOutputDir, getProject, getTemplatePath, getUseClasspath, getUserContextProperties, setContextPropertiesPath, setGeneratorTask, setOutputDir, setProject, setTemplatePath, setUseClasspath, setUserContextProperties

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROJECT_CONTEXT_PROPERTY

public static final String PROJECT_CONTEXT_PROPERTY

The context property for the name of the project.

See Also:

Constant Field Values

Constructor Detail

DataDtdMojo

public DataDtdMojo()

Creates a new SQLMojo object.

Method Detail

getMojoContextProperties

protected org.apache.commons.configuration.PropertiesConfiguration getMojoContextProperties()

Returns the context properties for the Texen task.

Specified by:

getMojoContextProperties in class TexenTaskMojo

Returns:

The PropertiesConfiguration containing all context properties, not null.

configureTask

protected void configureTask()
                      throws org.apache.maven.plugin.MojoExecutionException

Configures the Texen task which is wrapped by this mojo. In this implementation, the xml file is set in addition to the properties set by DataModelTaskMojo#configureTask().

Overrides:

configureTask in class DataModelTaskMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occurs when setting the Tasks properties.

See Also:

DataModelTaskMojo.configureTask()

getControlTemplate

protected String getControlTemplate()

Returns the path to the control template.

Specified by:

getControlTemplate in class DataModelTaskMojo

Returns:

"sql/Control.vm"

getProjectName

public String getProjectName()

Returns the name of the project, which is used as prefix for the name of the datadtd.

Returns:

the name of the project.

setProjectName

public void setProjectName(String projectName)

Sets the name of the project, which is used as prefix for the name of the datadtd.

Parameters:

project - the name of the project.

getXmlFile

public String getXmlFile()

Returns the name of the xml file to process.

Returns:

the name of the xml file to process.

setXmlFile

public void setXmlFile(String xmlFile)

Sets the name of the xml file to process.

Parameters:

project - the name of the xml file to process.