org.apache.ddlutils.task
Class DatabaseCommand

java.lang.Object
  extended byorg.apache.ddlutils.task.DatabaseCommand
All Implemented Interfaces:
Command
Direct Known Subclasses:
ConvertingDatabaseCommand, CreateDatabaseCommand, DatabaseCommandWithCreationParameters, DropDatabaseCommand

public abstract class DatabaseCommand
extends Object
implements Command

Base type for commands that have the database info embedded.

Version:
$Revision: 289996 $

Field Summary
protected  org.apache.commons.logging.Log _log
          The log.
 
Constructor Summary
DatabaseCommand()
           
 
Method Summary
 String getCatalogPattern()
          Returns the catalog pattern if any.
protected  String getDatabaseType()
          Returns the database type.
protected  org.apache.commons.dbcp.BasicDataSource getDataSource()
          Returns the data source to use for accessing the database.
protected  Platform getPlatform()
          Creates the platform for the configured database.
 String getSchemaPattern()
          Returns the schema pattern if any.
 boolean isFailOnError()
          Determines whether the command execution will be stopped upon an error.
 boolean isRequiringModel()
          Specifies whether this command requires a model, i.e. whether the second argument in Command.execute(DatabaseTaskBase, Database) cannot be null.
 void setFailOnError(boolean failOnError)
          Specifies whether the execution shall stop if an error has occurred during the task runs.
protected  void setPlatformConfiguration(PlatformConfiguration platformConf)
          Sets the platform configuration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.ddlutils.task.Command
execute
 

Field Detail

_log

protected final org.apache.commons.logging.Log _log
The log.

Constructor Detail

DatabaseCommand

public DatabaseCommand()
Method Detail

getDatabaseType

protected String getDatabaseType()
Returns the database type.

Returns:
The database type

getDataSource

protected org.apache.commons.dbcp.BasicDataSource getDataSource()
Returns the data source to use for accessing the database.

Returns:
The data source

getCatalogPattern

public String getCatalogPattern()
Returns the catalog pattern if any.

Returns:
The catalog pattern

getSchemaPattern

public String getSchemaPattern()
Returns the schema pattern if any.

Returns:
The schema pattern

setPlatformConfiguration

protected void setPlatformConfiguration(PlatformConfiguration platformConf)
Sets the platform configuration.

Parameters:
platformConf - The platform configuration

isFailOnError

public boolean isFailOnError()
Determines whether the command execution will be stopped upon an error. Default value is true.

Returns:
true if the execution stops in case of an error

setFailOnError

public void setFailOnError(boolean failOnError)
Specifies whether the execution shall stop if an error has occurred during the task runs.

Parameters:
failOnError - true if the execution shall stop in case of an error

getPlatform

protected Platform getPlatform()
                        throws org.apache.tools.ant.BuildException
Creates the platform for the configured database.

Returns:
The platform
Throws:
org.apache.tools.ant.BuildException

isRequiringModel

public boolean isRequiringModel()
Specifies whether this command requires a model, i.e. whether the second argument in Command.execute(DatabaseTaskBase, Database) cannot be null.

Specified by:
isRequiringModel in interface Command
Returns:
true if this command requires a model


Copyright © 2005-2006 Apache Software Foundation. All Rights Reserved.