org.apache.torque.task
Class TorqueDataSQLTask

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

public class TorqueDataSQLTask
extends TorqueDataModelTask

An extended Texen task used for generating SQL source from an XML data file

Version:
$Id: TorqueDataSQLTask.java,v 1.11 2002/11/27 11:30:59 mpoeschl Exp $
Author:
Jason van Zyl , John McNally , Fedor Karpelevitch

Field Summary
private  java.lang.String dataDTD
          the data dtd file
private  java.lang.String dataXmlFile
          the XML data file
private  java.lang.String targetDatabase
          The target database(s) we are generating SQL for.
 
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
TorqueDataSQLTask()
           
 
Method Summary
 java.lang.String getDataDTD()
          Gets the DataDTD attribute of the TorqueDataSQLTask object
 java.lang.String getDataXmlFile()
          Gets the DataXmlFile attribute of the TorqueDataSQLTask object
 java.lang.String getTargetDatabase()
          Get the current target database.
 org.apache.velocity.context.Context initControlContext()
          Set up the initialial context for generating the SQL from the XML schema.
 void setDataDTD(java.lang.String dataDTD)
          Sets the DataDTD attribute of the TorqueDataSQLTask object
 void setDataXmlFile(java.lang.String dataXmlFile)
          Sets the DataXmlFile attribute of the TorqueDataSQLTask object
 void setTargetDatabase(java.lang.String v)
          Set the current target database.
 
Methods inherited from class org.apache.torque.task.TorqueDataModelTask
addFileset, getBasePathToDbProps, getDataModelDbMap, getDataModels, getSqlDbMap, getTargetPackage, getXmlFile, setBasePathToDbProps, setContextProperties, setSqlDbMap, 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

dataXmlFile

private java.lang.String dataXmlFile
the XML data file


dataDTD

private java.lang.String dataDTD
the data dtd file


targetDatabase

private java.lang.String targetDatabase
The target database(s) we are generating SQL for. Right now we can only deal with a single target, but we will support multiple targets soon.

Constructor Detail

TorqueDataSQLTask

public TorqueDataSQLTask()
Method Detail

setDataXmlFile

public void setDataXmlFile(java.lang.String dataXmlFile)
Sets the DataXmlFile attribute of the TorqueDataSQLTask object

Parameters:
dataXmlFile - The new DataXmlFile value

getDataXmlFile

public java.lang.String getDataXmlFile()
Gets the DataXmlFile attribute of the TorqueDataSQLTask object

Returns:
The DataXmlFile value

getTargetDatabase

public java.lang.String getTargetDatabase()
Get the current target database.

Overrides:
getTargetDatabase in class TorqueDataModelTask
Returns:
String target database(s)

setTargetDatabase

public void setTargetDatabase(java.lang.String v)
Set the current target database. This is where generated java classes will live.

Overrides:
setTargetDatabase in class TorqueDataModelTask
Parameters:
v - The new TargetDatabase value

getDataDTD

public java.lang.String getDataDTD()
Gets the DataDTD attribute of the TorqueDataSQLTask object

Returns:
The DataDTD value

setDataDTD

public void setDataDTD(java.lang.String dataDTD)
Sets the DataDTD attribute of the TorqueDataSQLTask object

Parameters:
dataDTD - The new DataDTD value

initControlContext

public org.apache.velocity.context.Context initControlContext()
                                                       throws java.lang.Exception
Set up the initialial context for generating the SQL from the XML schema.

Overrides:
initControlContext in class TorqueDataModelTask
Returns:
the context
Throws:
java.lang.Exception - If there is an error parsing the data xml.


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