org.apache.ddlutils.task
Class DumpMetadataTask

java.lang.Object
  extended byorg.apache.tools.ant.ProjectComponent
      extended byorg.apache.tools.ant.Task
          extended byorg.apache.ddlutils.task.DumpMetadataTask

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

A simple task that dumps information about a database.

Version:
$Revision: 289996 $
Author:
Thomas Dudziak

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
DumpMetadataTask()
           
 
Method Summary
 void addConfiguredDatabase(org.apache.commons.dbcp.BasicDataSource dataSource)
          Adds the data source to use for accessing the database.
 void execute()
          
 void setCatalogPattern(String catalogPattern)
          Sets the catalog pattern.
 void setColumnPattern(String columnPattern)
          Sets the column pattern.
 void setDumpProcedures(boolean readProcedures)
          Specifies whether procedures shall be read from the database.
 void setDumpTables(boolean readTables)
          Specifies whether tables shall be read from the database.
 void setOutputFile(File outputFile)
          Set the output file.
 void setProcedurePattern(String procedurePattern)
          Sets the procedure pattern.
 void setSchemaPattern(String schemaPattern)
          Sets the schema pattern.
 void setTablePattern(String tablePattern)
          Sets the table pattern.
 void setTableTypes(String tableTypes)
          Sets the table types as a comma-separated list.
 
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

DumpMetadataTask

public DumpMetadataTask()
Method Detail

addConfiguredDatabase

public void addConfiguredDatabase(org.apache.commons.dbcp.BasicDataSource dataSource)
Adds the data source to use for accessing the database.

Parameters:
dataSource - The data source

setOutputFile

public void setOutputFile(File outputFile)
Set the output file.

Parameters:
outputFile - The output file

setCatalogPattern

public void setCatalogPattern(String catalogPattern)
Sets the catalog pattern.

Parameters:
catalogPattern - The catalog pattern

setSchemaPattern

public void setSchemaPattern(String schemaPattern)
Sets the schema pattern.

Parameters:
schemaPattern - The schema pattern

setTablePattern

public void setTablePattern(String tablePattern)
Sets the table pattern.

Parameters:
tablePattern - The table pattern

setProcedurePattern

public void setProcedurePattern(String procedurePattern)
Sets the procedure pattern.

Parameters:
procedurePattern - The procedure pattern

setColumnPattern

public void setColumnPattern(String columnPattern)
Sets the column pattern.

Parameters:
columnPattern - The column pattern

setTableTypes

public void setTableTypes(String tableTypes)
Sets the table types as a comma-separated list.

Parameters:
tableTypes - The table types

setDumpProcedures

public void setDumpProcedures(boolean readProcedures)
Specifies whether procedures shall be read from the database.

Parameters:
readProcedures - true if procedures shall be read

setDumpTables

public void setDumpTables(boolean readTables)
Specifies whether tables shall be read from the database.

Parameters:
readTables - true if tables shall be read

execute

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

Throws:
org.apache.tools.ant.BuildException


Copyright © 2005 Apache Software Foundation. All Rights Reserved.