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:
  • Task

  • Constructor Details

    • DbUnitTask

      public DbUnitTask()

  • Method Details

    • setDriver

      public void setDriver(String driver)
      Set the JDBC driver to be used.
      Parameters:
      driver - the fully qualified class name of the JDBC driver.

    • setUrl

      public void setUrl(String url)
      Set the DB connection url.
      Parameters:
      url - the JDBC connection URL.

    • setUserid

      public void setUserid(String userId)
      Set the user name for the DB connection.
      Parameters:
      userId - the database user name.

    • setPassword

      public void setPassword(String password)
      Set the password for the DB connection.
      Parameters:
      password - the database password.

    • setSchema

      public void setSchema(String schema)
      Set the schema for the DB connection.
      Parameters:
      schema - the database schema.

    • setUseQualifiedTableNames

      public void setUseQualifiedTableNames(Boolean useQualifiedTableNames)
      Set the flag for using the qualified table names.
      Parameters:
      useQualifiedTableNames - true to use qualified table names.

    • setSupportBatchStatement

      public void setSupportBatchStatement(Boolean supportBatchStatement)
      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.
      Parameters:
      supportBatchStatement - true to use batch statements.

    • setDatatypeWarning

      public void setDatatypeWarning(Boolean datatypeWarning)
      Sets the flag for logging a warning on unsupported data types.
      Parameters:
      datatypeWarning - true to log a warning on unsupported data types.

    • setDatatypeFactory

      public void setDatatypeFactory(String datatypeFactory)
      Sets the fully qualified class name of the IDataTypeFactory to use.
      Parameters:
      datatypeFactory - the fully qualified class name of the IDataTypeFactory to use.

    • setEscapePattern

      public void setEscapePattern(String escapePattern)
      Sets the pattern used to escape table and column names.
      Parameters:
      escapePattern - the pattern used to escape table and column names.

    • getDbConfig

      public DbConfig getDbConfig()
      Returns the generic DatabaseConfig configuration child element.
      Returns:
      the generic DatabaseConfig configuration child element.

    • addDbConfig

      public void addDbConfig(DbConfig dbConfig)
      Sets the generic DatabaseConfig configuration child element.
      Parameters:
      dbConfig - the generic DatabaseConfig configuration child element.

    • setClasspath

      public void setClasspath(org.apache.tools.ant.types.Path classpath)
      Set the classpath for loading the driver.
      Parameters:
      classpath - the classpath for loading the driver.

    • createClasspath

      public org.apache.tools.ant.types.Path createClasspath()
      Create the classpath for loading the driver.
      Returns:
      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.
      Parameters:
      r - the reference to the classpath for loading the driver.

    • getSteps

      public List getSteps()
      Gets the Steps.
      Returns:
      the steps to execute.

    • addOperation

      public void addOperation(Operation operation)
      Adds an Operation.
      Parameters:
      operation - the operation step to add.

    • addCompare

      public void addCompare(Compare compare)
      Adds a Compare to the steps List.
      Parameters:
      compare - the compare step to add.

    • addExport

      public void addExport(Export export)
      Adds an Export to the steps List.
      Parameters:
      export - the export step to add.

    • getBatchSize

      public String getBatchSize()
      Returns the size of batch inserts.
      Returns:
      the size of batch inserts.

    • setBatchSize

      public void setBatchSize(String batchSize)
      sets the size of batch inserts.
      Parameters:
      batchSize - the size of batch inserts.

    • getFetchSize

      public String getFetchSize()
      Returns the JDBC fetch size used for result sets.
      Returns:
      the JDBC fetch size used for result sets.

    • setFetchSize

      public void setFetchSize(String fetchSize)
      Sets the JDBC fetch size used for result sets.
      Parameters:
      fetchSize - the JDBC fetch size used for result sets.

    • setSkipOracleRecycleBinTables

      public void setSkipOracleRecycleBinTables(Boolean skipOracleRecycleBinTables)
      Sets the flag for skipping Oracle recycle bin tables.
      Parameters:
      skipOracleRecycleBinTables - true to skip Oracle recycle bin tables.

    • execute

      public void execute() throws org.apache.tools.ant.BuildException
      Load the step and then execute it.
      Overrides:
      execute in class org.apache.tools.ant.Task
      Throws:
      org.apache.tools.ant.BuildException

    • createConnection

      protected IDatabaseConnection createConnection() throws SQLException
      Loads the JDBC driver and opens the configured database connection.
      Returns:
      the opened database connection.
      Throws:
      SQLException - if the connection cannot be opened.

    • createDatabaseConnection

      protected IDatabaseConnection createDatabaseConnection(Connection jdbcConnection, String dbSchema)
      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 - the JDBC connection to adapt.
      dbSchema - the database schema.
      Returns:
      The dbunit connection