org.apache.torque.mojo
Class DataDtdMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.torque.mojo.BaseMojo
          org.apache.torque.mojo.AntTaskMojo
              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 DTD for the database tables from a schema XML file

Field Summary

(package private) boolean	antCompatibilityMode
(package private) String	artifactId Included here as a simple property to facilitate generating DTD's for other artifacts
(package private) String	copyToFile Only used if antCompatibilityMode is set to true.
private String	dummy1 The directory in which the DTD will be generated
private String	dummy2 The location where the report file will be generated, relative to outputDir.
private String	dummy3 The location where the context property file for velocity will be generated.
static String	PROJECT_CONTEXT_PROPERTY The context property for the name of the project.
private String	projectName The name of the project
private String	schemaXMLFile The name of the schema.xml file to process

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

suffix, TARGET_DATABASE_CONTEXT_PROPERTY, url

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

FS, SKIP_PACKAGING_TYPE

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

ROLE

Constructor Summary

DataDtdMojo()

Method Summary

protected void	configureTask() Configures the Texen task wrapped by this mojo
void	executeMojo() Executes the wrapped Texen task.
String	getArtifactId()
protected String	getControlTemplate() Returns the path to the control template.
String	getCopyToFile()
protected org.apache.commons.configuration.PropertiesConfiguration	getMojoContextProperties() Returns the context properties for the Texen task.
String	getProjectName() Returns the name of the project
String	getSchemaXMLFile() Returns the name of the xml file to process.
boolean	isAntCompatibilityMode()
void	setAntCompatibilityMode(boolean antCompatibilityMode)
void	setArtifactId(String artifactId)
void	setCopyToFile(String copyToFile)
void	setProjectName(String projectName) Sets the name of the project
void	setSchemaXMLFile(String xmlFile) Sets the name of the xml file to process.
protected void	showConfig()

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

addTargetDatabaseToOutputDir, addTargetDatabaseToReportFile, getAntFileSet, getCanonicalReportFile, getInvalidTargetDatabaseMessage, getReportFile, getSchemaDir, getSchemaExcludes, getSchemaFiles, getSchemaIncludes, getSqlDbMap, getSuffix, getTargetDatabase, getTargetPackage, getUrl, isRunOnlyOnSchemaChange, setReportFile, setRunOnlyOnSchemaChange, setSchemaDir, setSchemaExcludes, setSchemaIncludes, setSqlDbMap, setSuffix, setTargetDatabase, setTargetPackage, setUrl, updateConfiguration, validateConfiguration

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

generateContextProperties, getContextPropertiesPath, getGeneratorTask, getOutputDir, getTemplatePath, getUseClasspath, getUserContextProperties, setContextPropertiesPath, setOutputDir, setTemplatePath, setUseClasspath, setUserContextProperties

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

getAntProject, getAntTask, getIniatializedAntProject, setAntProject, setAntTask

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

afterExecution, beforeExecution, execute, getEncoding, getMavenSession, getProject, getSettings, isForceMojoExecution, isSkip, isStartMavenLogger, setEncoding, setForceMojoExecution, setMavenSession, setProject, setSettings, setSkip, setStartMavenLogger, skipMojo

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

antCompatibilityMode

boolean antCompatibilityMode

copyToFile

String copyToFile

Only used if antCompatibilityMode is set to true. If so, the dtd that gets generated will be copied to

artifactId

String artifactId

Included here as a simple property to facilitate generating DTD's for other artifacts

dummy1

private String dummy1

The directory in which the DTD will be generated

dummy2

private String dummy2

The location where the report file will be generated, relative to outputDir.

dummy3

private String dummy3

The location where the context property file for velocity will be generated.

projectName

private String projectName

The name of the project

schemaXMLFile

private String schemaXMLFile

The name of the schema.xml file to process

Constructor Detail

DataDtdMojo

public DataDtdMojo()

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.

showConfig

protected void showConfig()

configureTask

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

Configures the Texen task wrapped by this mojo

Overrides:

configureTask in class DataModelTaskMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

getControlTemplate

protected String getControlTemplate()

Returns the path to the control template.

Specified by:

getControlTemplate in class DataModelTaskMojo

Returns:

"data/Control.vm"

getProjectName

public String getProjectName()

Returns the name of the project

Returns:

the name of the project.

setProjectName

public void setProjectName(String projectName)

Sets the name of the project

Parameters:

project - the name of the project.

getSchemaXMLFile

public String getSchemaXMLFile()

Returns the name of the xml file to process.

Returns:

the name of the xml file to process.

setSchemaXMLFile

public void setSchemaXMLFile(String xmlFile)

Sets the name of the xml file to process.

Parameters:

project - the name of the xml file to process.

executeMojo

public void executeMojo()
                 throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: TexenTaskMojo

Executes the wrapped Texen task. Before this is done, the context properties file is generated and the Texen task is configured.

Overrides:

executeMojo in class TexenTaskMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occurs during execution.

See Also:

Mojo.execute()

isAntCompatibilityMode

public boolean isAntCompatibilityMode()

setAntCompatibilityMode

public void setAntCompatibilityMode(boolean antCompatibilityMode)

getCopyToFile

public String getCopyToFile()

setCopyToFile

public void setCopyToFile(String copyToFile)

getArtifactId

public String getArtifactId()

setArtifactId

public void setArtifactId(String artifactId)