org.apache.torque.mojo
Class DataSqlMojo

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

All Implemented Interfaces:

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

public class DataSqlMojo
extends DataModelTaskMojo

Generates SQL for populating the database from data.xml files.

Author:

Raphael Pieroni (rafale_at_codehaus.org), Thomas Fischer

Field Summary

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

DataSqlMojo()
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.
String	getDataDtd() Returns the data dtd file for the data xml file.
String	getDataXmlFile() Returns the data xml file which should be processed.
protected org.apache.commons.configuration.PropertiesConfiguration	getMojoContextProperties() Returns the context properties for the Texen task.
void	setDataDtd(String dataDtd) Sets the data dtd file for the data xml file.
void	setDataXmlFile(String dataXmlFile) Sets the data xml file which should be processed.

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

Constructor Detail

DataSqlMojo

public DataSqlMojo()

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 addition to the prioerties set by DataModelTaskMojo#configureTask(), the properties dataXmlFile and dataDTD are set.

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/load/Control.vm"

getDataDtd

public String getDataDtd()

Returns the data dtd file for the data xml file.

Returns:

the data dtd file for the data xml file.

setDataDtd

public void setDataDtd(String dataDtd)

Sets the data dtd file for the data xml file.

Parameters:

dataDtd - the data dtd file for the data xml file.

getDataXmlFile

public String getDataXmlFile()

Returns the data xml file which should be processed.

Returns:

the data xml file which should be processed.

setDataXmlFile

public void setDataXmlFile(String dataXmlFile)

Sets the data xml file which should be processed.

Parameters:

dataXmlFile - the data xml file which should be processed.