org.exolab.jms.tools.db
Class RDBMSTool

java.lang.Object
  |
  +--org.exolab.jms.tools.db.RDBMSTool

public class RDBMSTool

extends java.lang.Object

This class provides support for creating and destroying tables in RDBMS databases.

Version:

$Revision: 1.4 $ $Date: 2005/11/12 12:47:37 $

Author:

Tim Anderson

Constructor Summary

RDBMSTool(org.exolab.jms.config.Configuration config)
Construct a new RDBMSTool.

RDBMSTool(java.sql.Connection connection)
Construct a new RDBMSTool.

Method Summary

void	close() Close the connection to the database.
void	create(Database schema) Creates the database.
void	create(Table table) Creates a table in the database.
void	delete(Database schema) Deletes data from all tables in the database.
void	drop(Database schema) Drops tables from the database.
void	drop(Table table) Drops a table from the database.
SchemaBrowser	getSchemaBrowser() Returns the schema browser.
boolean	hasTables(Table[] tables) Determines if a set of tables are present in the dataase.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RDBMSTool

public RDBMSTool(java.sql.Connection connection)
          throws org.exolab.jms.persistence.PersistenceException

Construct a new RDBMSTool.

Parameters:

connection - the JDBC connection

Throws:

org.exolab.jms.persistence.PersistenceException - if database meta-data can't be obtained

RDBMSTool

public RDBMSTool(org.exolab.jms.config.Configuration config)
          throws org.exolab.jms.persistence.PersistenceException

Construct a new RDBMSTool.

Parameters:

config - the configuration

Throws:

org.exolab.jms.persistence.PersistenceException - for any error

Method Detail

hasTables

public boolean hasTables(Table[] tables)
                  throws org.exolab.jms.persistence.PersistenceException

Determines if a set of tables are present in the dataase.

Parameters:

tables - the tables

Returns:

true if all tables are present

Throws:

org.exolab.jms.persistence.PersistenceException - for any error

create

public void create(Database schema)
            throws org.exolab.jms.persistence.PersistenceException

Creates the database.

Parameters:

schema - the database schema

Throws:

org.exolab.jms.persistence.PersistenceException - if elements cannot be created in the database

drop

public void drop(Database schema)
          throws org.exolab.jms.persistence.PersistenceException

Drops tables from the database.

Parameters:

schema - the database schema

Throws:

org.exolab.jms.persistence.PersistenceException - if elements cannot be dropped from the database

delete

public void delete(Database schema)
            throws org.exolab.jms.persistence.PersistenceException

Deletes data from all tables in the database.

Parameters:

schema - the database schema

Throws:

org.exolab.jms.persistence.PersistenceException - if a table can't be truncated

close

public void close()

Close the connection to the database.

create

public void create(Table table)
            throws org.exolab.jms.persistence.PersistenceException

Creates a table in the database.

Parameters:

table - the table to create

Throws:

org.exolab.jms.persistence.PersistenceException - if the table exists, or cannot be created

drop

public void drop(Table table)
          throws org.exolab.jms.persistence.PersistenceException

Drops a table from the database. If the table doesn't exist, then it will be ignored.

Parameters:

table - the table to drop

Throws:

org.exolab.jms.persistence.PersistenceException - for any database error

getSchemaBrowser

public SchemaBrowser getSchemaBrowser()

Returns the schema browser.

Returns:

the schema browser