org.apache.torque.mojo
Class DataSqlMojo

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.DataSqlMojo

All Implemented Interfaces:

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

public class DataSqlMojo
extends DataModelTaskMojo

Generates platform specific SQL from database agnostic XML files. Each SQL file created by this goal contains data for a single table. The database platform to generate SQL for is determined by ${targetDatabase}. See also impex:schemasql

Field Summary

private File	dataDTD The DTD for the data XML files
private File	dataXMLDir The directory containing data XML files
private String	dataXMLExcludes The default set of files in that directory to exclude (ant style notation)
private String	dataXMLIncludes The default set of files in that directory to include (ant style notation)
private String	dummy The directory in which the SQL will be generated.
private String	dummy2 The location where the SQL file will be generated.
private String	dummy3 The location where the context property file for velocity will be generated.
private boolean	runOnlyOnChange Only run this mojo if the data or schema has changed since the last run
private File	schemaXMLFile The XML file describing the database schema

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

DataSqlMojo()

Method Summary

protected void	configureTask() Configures the Texen task wrapped by this mojo
void	executeMojo() Executes the wrapped Texen task.
protected String	getControlTemplate() Returns the path to the control template.
File	getDataDTD()
protected List<File>	getDataFiles()
File	getDataXMLDir()
String	getDataXMLExcludes()
String	getDataXMLIncludes()
protected org.apache.commons.configuration.PropertiesConfiguration	getMojoContextProperties() Returns the context properties for the Texen task.
File	getSchemaXMLFile()
boolean	isRunOnlyOnChange()
void	setDataDTD(File dataDTD)
void	setDataXMLDir(File dataXMLDir)
void	setDataXMLExcludes(String dataXMLExcludes)
void	setDataXMLIncludes(String dataXMLIncludes)
void	setRunOnlyOnChange(boolean runOnlyOnDataChange)
void	setSchemaXMLFile(File schemaXMLFile)

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

dummy

private String dummy

The directory in which the SQL will be generated.

dummy2

private String dummy2

The location where the SQL file will be generated.

dummy3

private String dummy3

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

runOnlyOnChange

private boolean runOnlyOnChange

Only run this mojo if the data or schema has changed since the last run

schemaXMLFile

private File schemaXMLFile

The XML file describing the database schema

dataXMLDir

private File dataXMLDir

The directory containing data XML files

dataXMLIncludes

private String dataXMLIncludes

The default set of files in that directory to include (ant style notation)

dataXMLExcludes

private String dataXMLExcludes

The default set of files in that directory to exclude (ant style notation)

dataDTD

private File dataDTD

The DTD for the data XML files

Constructor Detail

DataSqlMojo

public DataSqlMojo()

Method Detail

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()

getDataFiles

protected List<File> getDataFiles()

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

"sql/load/Control.vm"

getDataXMLIncludes

public String getDataXMLIncludes()

setDataXMLIncludes

public void setDataXMLIncludes(String dataXMLIncludes)

getDataXMLExcludes

public String getDataXMLExcludes()

setDataXMLExcludes

public void setDataXMLExcludes(String dataXMLExcludes)

getDataXMLDir

public File getDataXMLDir()

setDataXMLDir

public void setDataXMLDir(File dataXMLDir)

getSchemaXMLFile

public File getSchemaXMLFile()

setSchemaXMLFile

public void setSchemaXMLFile(File schemaXMLFile)

isRunOnlyOnChange

public boolean isRunOnlyOnChange()

setRunOnlyOnChange

public void setRunOnlyOnChange(boolean runOnlyOnDataChange)

getDataDTD

public File getDataDTD()

setDataDTD

public void setDataDTD(File dataDTD)