Package org.dbunit.ant
Class DbUnitTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.dbunit.ant.DbUnitTask
- All Implemented Interfaces:
Cloneable
public class DbUnitTask
extends org.apache.tools.ant.Task
DbUnitTask is the task definition for an Ant
interface to DbUnit. DbUnit is a JUnit extension
which sets your database to a known state before executing your
tasks.- Since:
- Jun 10, 2002
- Version:
- $Revision$
- Author:
- Timothy Ruppert, Ben Cox
- See Also:
-
Field Summary
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapperFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCompare(Compare compare) Adds a Compare to the steps List.voidaddDbConfig(DbConfig dbConfig) voidAdds an Export to the steps List.voidaddOperation(Operation operation) Adds an Operation.org.apache.tools.ant.types.PathCreate the classpath for loading the driver.protected IDatabaseConnectionprotected IDatabaseConnectioncreateDatabaseConnection(Connection jdbcConnection, String dbSchema) Creates the dbunit connection using the two given arguments.voidexecute()Load the step and then execute it.getSteps()Gets the Steps.voidsetBatchSize(String batchSize) sets the size of batch inserts.voidsetClasspath(org.apache.tools.ant.types.Path classpath) Set the classpath for loading the driver.voidsetClasspathRef(org.apache.tools.ant.types.Reference r) Set the classpath for loading the driver using the classpath reference.voidsetDatatypeFactory(String datatypeFactory) voidsetDatatypeWarning(Boolean datatypeWarning) voidSet the JDBC driver to be used.voidsetEscapePattern(String escapePattern) voidsetFetchSize(String fetchSize) voidsetPassword(String password) Set the password for the DB connection.voidSet the schema for the DB connection.voidsetSkipOracleRecycleBinTables(Boolean skipOracleRecycleBinTables) voidsetSupportBatchStatement(Boolean supportBatchStatement) Set the flag for supporting batch statements.voidSet the DB connection url.voidsetUseQualifiedTableNames(Boolean useQualifiedTableNames) Set the flag for using the qualified table names.voidSet the user name for the DB connection.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, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
DbUnitTask
public DbUnitTask()
-
-
Method Details
-
setDriver
Set the JDBC driver to be used. -
setUrl
Set the DB connection url. -
setUserid
Set the user name for the DB connection. -
setPassword
Set the password for the DB connection. -
setSchema
Set the schema for the DB connection. -
setUseQualifiedTableNames
Set the flag for using the qualified table names. -
setSupportBatchStatement
Set the flag for supporting batch statements. NOTE: This property cannot be used to force the usage of batch statement if your database does not support it. -
setDatatypeWarning
-
setDatatypeFactory
-
setEscapePattern
-
getDbConfig
-
addDbConfig
-
setClasspath
public void setClasspath(org.apache.tools.ant.types.Path classpath) Set the classpath for loading the driver. -
createClasspath
public org.apache.tools.ant.types.Path createClasspath()Create the classpath for loading the driver. -
setClasspathRef
public void setClasspathRef(org.apache.tools.ant.types.Reference r) Set the classpath for loading the driver using the classpath reference. -
getSteps
Gets the Steps. -
addOperation
Adds an Operation. -
addCompare
Adds a Compare to the steps List. -
addExport
Adds an Export to the steps List. -
getBatchSize
-
setBatchSize
sets the size of batch inserts.- Parameters:
batchSize-
-
getFetchSize
-
setFetchSize
-
setSkipOracleRecycleBinTables
-
execute
public void execute() throws org.apache.tools.ant.BuildExceptionLoad the step and then execute it.- Overrides:
executein classorg.apache.tools.ant.Task- Throws:
org.apache.tools.ant.BuildException
-
createConnection
- Throws:
SQLException
-
createDatabaseConnection
Creates the dbunit connection using the two given arguments. The configuration properties of the dbunit connection are initialized using the fields of this class.- Parameters:
jdbcConnection-dbSchema-- Returns:
- The dbunit connection
-