org.apache.torque.mojo
Class DocumentationMojo

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

All Implemented Interfaces:

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

public class DocumentationMojo
extends DataModelTaskMojo

Creates html or anakia documentation for the data model from the schema.xml files.

Author:

Raphael Pieroni (rafale_at_codehaus.org), Thomas Fischer

Field Summary

static String

OUTPUT_FORMAT_CONTEXT_PROPERTY The context property for the output format.

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

DocumentationMojo()
Creates a new SQLMojo object.

Method Summary

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	getOutputFormat() Returns the output format of the documentation (html or anakia)
void	setOutputFormat(String outputFormat) Sets the output format of the documentation (html or anakia)

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

configureTask, 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

OUTPUT_FORMAT_CONTEXT_PROPERTY

public static final String OUTPUT_FORMAT_CONTEXT_PROPERTY

The context property for the output format.

See Also:

Constant Field Values

Constructor Detail

DocumentationMojo

public DocumentationMojo()

Creates a new SQLMojo object.

Method Detail

setOutputFormat

public void setOutputFormat(String outputFormat)

Sets the output format of the documentation (html or anakia)

Parameters:

outputFormat - the output format of the documentation.

getOutputFormat

public String getOutputFormat()

Returns the output format of the documentation (html or anakia)

Returns:

the output format of the documentation.

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.

getControlTemplate

protected String getControlTemplate()

Returns the path to the control template.

Specified by:

getControlTemplate in class DataModelTaskMojo

Returns:

"doc/Control.vm"