org.apache.torque.task
Class TorqueDocumentationTask

java.lang.Object
  extended byorg.apache.tools.ant.ProjectComponent
      extended byorg.apache.tools.ant.Task
          extended byorg.apache.velocity.texen.ant.TexenTask
              extended byorg.apache.torque.task.TorqueDataModelTask
                  extended byorg.apache.torque.task.TorqueDocumentationTask

public class TorqueDocumentationTask
extends TorqueDataModelTask

An ant task for generating output by using Velocity

Version:
$Id: TorqueDocumentationTask.java,v 1.6 2002/11/27 11:30:59 mpoeschl Exp $
Author:
Martin Poeschl

Field Summary
private  java.lang.String outputFormat
          output format for the generated docs
 
Fields inherited from class org.apache.torque.task.TorqueDataModelTask
context, databaseNames, dataModelDbMap, dataModels, filesets, sqldbmap, xmlFile
 
Fields inherited from class org.apache.velocity.texen.ant.TexenTask
contextProperties, controlTemplate, inputEncoding, outputDirectory, outputEncoding, outputFile, templatePath, useClasspath
 
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
 java.lang.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(java.lang.String v)
          Set the current output format.
 
Methods inherited from class org.apache.torque.task.TorqueDataModelTask
addFileset, getBasePathToDbProps, getDataModelDbMap, getDataModels, getSqlDbMap, getTargetDatabase, getTargetPackage, getXmlFile, setBasePathToDbProps, setContextProperties, setSqlDbMap, setTargetDatabase, setTargetPackage, setXmlFile
 
Methods inherited from class org.apache.velocity.texen.ant.TexenTask
cleanup, execute, getContextProperties, getControlTemplate, getOutputDirectory, getOutputFile, getTemplatePath, populateInitialContext, setControlTemplate, setInputEncoding, setOutputDirectory, setOutputEncoding, setOutputFile, setTemplatePath, setUseClasspath
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
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 java.lang.String outputFormat
output format for the generated docs

Constructor Detail

TorqueDocumentationTask

public TorqueDocumentationTask()
Method Detail

getOutputFormat

public java.lang.String getOutputFormat()
Get the current output format.

Returns:
the current output format

setOutputFormat

public void setOutputFormat(java.lang.String v)
Set the current output format.

Parameters:
v - output format

initControlContext

public org.apache.velocity.context.Context initControlContext()
                                                       throws java.lang.Exception
Place our target package value into the context for use in the templates.

Overrides:
initControlContext in class TorqueDataModelTask
Returns:
the context
Throws:
java.lang.Exception - a generic exception


Copyright © 1999-2003 Apache Software Foundation. All Rights Reserved.