org.apache.ojb.broker.platforms
Class DBHandlingTask

java.lang.Object
  extended byorg.apache.tools.ant.ProjectComponent
      extended byorg.apache.tools.ant.Task
          extended byorg.apache.ojb.broker.platforms.DBHandlingTask

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

Ant task for performing basic db setup functions.

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
DBHandlingTask()
           
 
Method Summary
 void addFileset(org.apache.tools.ant.types.FileSet fileset)
          Adds a fileset.
 void execute()
           
 java.lang.String getCommands()
          Returns the list of commands.
 java.lang.String getHandling()
          Returns the name of the handling that is used.
 java.lang.String getJcdAlias()
          Returns the alias of the jdbc connection.
 java.lang.String getPropertiesFile()
          Returns the properties file.
 java.lang.String getWorkDir()
          Returns the working directory.
 void setCommands(java.lang.String listOfCommands)
          Sets the list of commands to perform.
 void setHandling(java.lang.String name)
          Sets the name of the handling to use.
 void setJcdAlias(java.lang.String alias)
          Sets the alias of the jdbc connection to use.
 void setPropertiesFile(java.lang.String path)
          Sets the properties file (OJB.properties).
 void setWorkDir(java.lang.String dir)
          Sets the working directory.
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
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

DBHandlingTask

public DBHandlingTask()
Method Detail

setHandling

public void setHandling(java.lang.String name)
Sets the name of the handling to use.

Parameters:
name - The short name of the handling

getHandling

public java.lang.String getHandling()
Returns the name of the handling that is used.

Returns:
The short name of the handling

setPropertiesFile

public void setPropertiesFile(java.lang.String path)
Sets the properties file (OJB.properties).

Parameters:
path - The path to the properties file

getPropertiesFile

public java.lang.String getPropertiesFile()
Returns the properties file.

Returns:
The path to the properties file

setJcdAlias

public void setJcdAlias(java.lang.String alias)
Sets the alias of the jdbc connection to use.

Parameters:
alias - The alias of the connection

getJcdAlias

public java.lang.String getJcdAlias()
Returns the alias of the jdbc connection.

Returns:
The alias

setWorkDir

public void setWorkDir(java.lang.String dir)
Sets the working directory. If none is given, then the system's temporary directory is used.

Parameters:
dir - The working directory

getWorkDir

public java.lang.String getWorkDir()
Returns the working directory.

Returns:
The working directory

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet fileset)
Adds a fileset.

Parameters:
fileset - The additional input files

setCommands

public void setCommands(java.lang.String listOfCommands)
Sets the list of commands to perform.

Parameters:
listOfCommands - The comma-separated list of commands

getCommands

public java.lang.String getCommands()
Returns the list of commands.

Returns:
The comma-separated list of commands

execute

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


Authors: Thomas Mahler and others. (C) 2000 - 2003 Apache Software Foundation
All rights reserved. Published under the Apache License.
http://db.apache.org/ojb
Version: 1.0.rc5, 2003-12-14