org.apache.torque.task
Class TorqueDataDumpTask

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

All Implemented Interfaces:

java.lang.Cloneable

public class TorqueDataDumpTask
extends TorqueDataModelTask

An extended Texen task used for dumping data from db into XML

Version:

$Id: TorqueDataDumpTask.java 473814 2006-11-11 22:30:30Z tv $

Author:

Fedor Karpelevitch, Jason van Zyl, Daniel Rall, Martin Poeschl

Nested Class Summary

class

TorqueDataDumpTask.TableTool A nasty do-it-all tool class.

Nested classes/interfaces inherited from class org.apache.torque.task.TorqueDataModelTask

TorqueDataModelTask.TorqueClasspathResourceLoader, TorqueDataModelTask.TorqueFileResourceLoader

Field Summary

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

context, databaseNames, dataModelDbMap, dataModels, filesets, sqldbmap, 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

target, taskName, taskType, wrapper

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

description, location, project

Constructor Summary

TorqueDataDumpTask()

Method Summary

protected void	cleanup() Closes the db-connection, overriding the cleanup() hook method in TexenTask.
java.lang.String	getDatabaseDriver() Get the database driver name
java.lang.String	getDatabaseName() Get the database name to dump
java.lang.String	getDatabasePassword() Get the database password
java.lang.String	getDatabaseUrl() Get the database url
java.lang.String	getDatabaseUser() Get the database user
org.apache.velocity.context.Context	initControlContext() Initializes initial context
void	setDatabaseDriver(java.lang.String v) Set the database driver name
void	setDatabaseName(java.lang.String v) Set the database name
void	setDatabasePassword(java.lang.String v) Set the database password
void	setDatabaseUrl(java.lang.String v) Set the database url
void	setDatabaseUser(java.lang.String v) Set the database user

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

addFileset, execute, filter, getDataModelDbMap, getDataModels, getSqlDbMap, getTargetDatabase, getTargetPackage, getXmlFile, populateInitialContext, setContextProperties, setSqlDbMap, setTargetDatabase, setTargetPackage, setXmlFile

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

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

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

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

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

TorqueDataDumpTask

public TorqueDataDumpTask()

Method Detail

getDatabaseName

public java.lang.String getDatabaseName()

Get the database name to dump

Returns:

The DatabaseName value

setDatabaseName

public void setDatabaseName(java.lang.String v)

Set the database name

Parameters:

v - The new DatabaseName value

getDatabaseUrl

public java.lang.String getDatabaseUrl()

Get the database url

Returns:

The DatabaseUrl value

setDatabaseUrl

public void setDatabaseUrl(java.lang.String v)

Set the database url

Parameters:

v - The new DatabaseUrl value

getDatabaseDriver

public java.lang.String getDatabaseDriver()

Get the database driver name

Returns:

String database driver name

setDatabaseDriver

public void setDatabaseDriver(java.lang.String v)

Set the database driver name

Parameters:

v - The new DatabaseDriver value

getDatabaseUser

public java.lang.String getDatabaseUser()

Get the database user

Returns:

String database user

setDatabaseUser

public void setDatabaseUser(java.lang.String v)

Set the database user

Parameters:

v - The new DatabaseUser value

getDatabasePassword

public java.lang.String getDatabasePassword()

Get the database password

Returns:

String database password

setDatabasePassword

public void setDatabasePassword(java.lang.String v)

Set the database password

Parameters:

v - The new DatabasePassword value

initControlContext

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

Initializes initial context

Overrides:

initControlContext in class TorqueDataModelTask

Returns:

the context

Throws:

java.lang.Exception - generic exception

cleanup

protected void cleanup()
                throws java.lang.Exception

Closes the db-connection, overriding the cleanup() hook method in TexenTask.

Overrides:

cleanup in class org.apache.texen.ant.TexenTask

Throws:

java.lang.Exception - Database problem while closing resource.