org.apache.torque.task
Class TorqueDocumentationTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.texen.ant.TexenTask
              org.apache.torque.task.TorqueDataModelTask
                  org.apache.torque.task.TorqueDocumentationTask

public class TorqueDocumentationTask
extends TorqueDataModelTask

An ant task for generating output by using Velocity

Version:

$Id: TorqueDocumentationTask.java,v 1.1 2007-10-21 07:57:26 abyrne Exp $

Author:

Martin Poeschl

Field Summary

private String

outputFormat output format for the generated docs

Fields inherited from class org.apache.torque.task.TorqueDataModelTask

context, databaseNames, dataModelDbMap, dataModels, filesets, sExcludes, sIncludes, sqldbmap, tblExcludes, tblIncludes, vExcludes, vIncludes, xmlFile

Fields inherited from class org.apache.texen.ant.TexenTask

contextProperties, controlTemplate, inputEncoding, logFile, outputDirectory, outputEncoding, outputFile, resourceLoaderModificationCheckInterval, templatePath, useClasspath, useResourceLoaderCache

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

TorqueDocumentationTask()

Method Summary

String	getOutputFormat() Get the current output format.
org.apache.velocity.context.Context	initControlContext() Place our target package value into the context for use in the templates.
void	setOutputFormat(String v) Set the current output format.

Methods inherited from class org.apache.torque.task.TorqueDataModelTask

addFileset, filterSequences, filterTables, filterViews, getDatabaseParser, getDataModel, getDataModelDbMap, getDataModelFiles, getDataModels, getFilesets, getPopulatedDataModels, getsExcludes, getsIncludes, getSqlDbMap, getTables, getTargetDatabase, getTargetPackage, getTblExcludes, getTblIncludes, getvExcludes, getvIncludes, getXmlFile, populateInitialContext, setContextProperties, setFilesets, setsExcludes, setsIncludes, setSqlDbMap, setTargetDatabase, setTargetPackage, setTblExcludes, setTblIncludes, setvExcludes, setvIncludes, setXmlFile

Methods inherited from class org.apache.texen.ant.TexenTask

cleanup, execute, getContextProperties, getControlTemplate, getLogFile, getOutputDirectory, getOutputFile, getTemplatePath, setControlTemplate, setInputEncoding, setLogFile, setOutputDirectory, setOutputEncoding, setOutputFile, setResourceLoaderModificationCheckInterval, setTemplatePath, setUseClasspath, setUseResourceLoaderCache

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

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

Field Detail

outputFormat

private String outputFormat

output format for the generated docs

Constructor Detail

TorqueDocumentationTask

public TorqueDocumentationTask()

Method Detail

getOutputFormat

public String getOutputFormat()

Get the current output format.

Returns:

the current output format

setOutputFormat

public void setOutputFormat(String v)

Set the current output format.

Parameters:

v - output format

initControlContext

public org.apache.velocity.context.Context initControlContext()
                                                       throws Exception

Place our target package value into the context for use in the templates.

Overrides:

initControlContext in class TorqueDataModelTask

Returns:

the context

Throws:

Exception - a generic exception