org.apache.torque.task
Class TorqueXMLWithDesc

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.torque.task.TorqueXMLWithDesc

public class TorqueXMLWithDesc
extends org.apache.tools.ant.Task

This class is task used to generate xml file with database information and its description.

Author:

Kuali Rice Team (kuali-rice@googlegroups.com)

Field Summary

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

TorqueXMLWithDesc()

Method Summary

Document	createXMLWithDescription() Returns a document object with table and column name from the input file and a blank description
void	execute() This is the exceute method of the Task called by the ant script
void	setInputFileString(String inputFileString)
void	setOutputFileString(String outputFileString)
void	writeXMLToFile(Document newXMLDocument) Writes the XMLDocument to an output file.

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

Constructor Detail

TorqueXMLWithDesc

public TorqueXMLWithDesc()

Method Detail

setOutputFileString

public void setOutputFileString(String outputFileString)

setInputFileString

public void setInputFileString(String inputFileString)

createXMLWithDescription

public Document createXMLWithDescription()
                                  throws ParserConfigurationException,
                                         SAXException,
                                         IOException

Returns a document object with table and column name from the input file and a blank description

Returns:

Document document object with table/column names and blank description added

Throws:

ParserConfigurationException

SAXException

IOException

writeXMLToFile

public void writeXMLToFile(Document newXMLDocument)

Writes the XMLDocument to an output file.

Parameters:

newXMLDocument -

execute

public void execute()
             throws org.apache.tools.ant.BuildException

This is the exceute method of the Task called by the ant script

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException