to.etc.dbutil

Class GenericDB

java.lang.Object

to.etc.dbutil.GenericDB

public class GenericDB
extends Object

A generic database access class to hide differences between databases.

Version:

1.0

Author:

F. Jalvingh

Field Summary

Fields

Modifier and Type	Field and Description
static BaseDB	dbtypeMYSQL
static BaseDB	dbtypeORACLE
static BaseDB	dbtypePOSTGRESQL
static BaseDB	dbtypeUNKNOWN

Method Summary

Modifier and Type	Method and Description
static String	getCheckString(BaseDB dbtype)
static BaseDB	getDbType(Connection dbc) Tries to return a database type for the connection passed.
static BaseDB	getDbTypeByDriverName(String dn)
static int	getFullSequenceID(Connection dbc, String tablename)
static Reader	getLobReader(Connection dbc, ResultSet rs, int col) Returns a Reader from the blob (clob) column specified.
static Reader	getLobReader(Connection dbc, ResultSet rs, String col) Returns a Reader from the blob (clob) column specified.
static InputStream	getLobStream(Connection dbc, ResultSet rs, int col) Returns an InputStream from the blob (clob) column specified.
static InputStream	getLobStream(Connection dbc, ResultSet rs, String col) Returns an InputStream from the blob (clob) column specified.
static String	getScriptResource(Connection dbc, Class<?> clz, String baseName) Get a database script as a resource.
static int	getSequenceID(Connection dbc, String tablename) Returns a sequence number that can be used to create a new PK for a record in the given table.
static void	runScriptResource(Connection dbc, Class<?> clz, String name, StringBuilder errors) Run a script resource with some basic name.
static boolean	saveBlob(ResultSet rs, int col, File f) Saves a BLOB from a resultset to a file using Oracle semantics.
static boolean	saveBlob(ResultSet rs, int col, OutputStream os)
static boolean	saveBlob(ResultSet rs, String col, File f)
static void	setBlob(Connection dbc, String table, String column, String[] pkfields, Object[] key, File f)
static void	setBlob(Connection dbc, String table, String column, String[] pkfields, Object[] key, InputStream is, int len)
static void	setBlob(Connection dbc, String table, String column, String where, byte[][] data) Writes a blob to the requested record.
static void	setBlob(Connection dbc, String table, String column, String where, File f) Writes a blob to the requested record.
static void	setBlob(Connection dbc, String table, String column, String where, InputStream is, int len) Writes a blob to the requested record.
static void	setBlob(Connection dbc, String table, String column, String where, String str)
static void	setClob(Connection dbc, String table, String column, String where, Reader r)
static void	setClob(Connection dbc, String table, String column, String where, String content)

Methods inherited from class java.lang.Object

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

Field Detail

dbtypeUNKNOWN

public static final BaseDB dbtypeUNKNOWN

dbtypeORACLE

public static final BaseDB dbtypeORACLE

dbtypeMYSQL

public static final BaseDB dbtypeMYSQL

dbtypePOSTGRESQL

public static final BaseDB dbtypePOSTGRESQL

Method Detail

getDbType

public static BaseDB getDbType(Connection dbc)

Tries to return a database type for the connection passed. TODO: Need to be replaced with generic accept() in base specific class

Parameters:

dbc - the connection to check

Returns:

a dbtype for the connection.

getDbTypeByDriverName

public static BaseDB getDbTypeByDriverName(String dn)

getSequenceID

public static int getSequenceID(Connection dbc,
                                String tablename)
                         throws SQLException

Returns a sequence number that can be used to create a new PK for a record in the given table. Sequences are emulated on databases that do not support 'm.

Parameters:

dbc -

tablename -

Returns:

Throws:

SQLException

getFullSequenceID

public static int getFullSequenceID(Connection dbc,
                                    String tablename)
                             throws SQLException

Throws:

SQLException

getCheckString

public static String getCheckString(BaseDB dbtype)

setBlob

public static void setBlob(Connection dbc,
                           String table,
                           String column,
                           String where,
                           File f)
                    throws Exception

Writes a blob to the requested record. Works for Oral and MYSQL.

Throws:

Exception

setBlob

public static void setBlob(Connection dbc,
                           String table,
                           String column,
                           String where,
                           String str)
                    throws Exception

Throws:

Exception

setBlob

public static void setBlob(Connection dbc,
                           String table,
                           String column,
                           String where,
                           InputStream is,
                           int len)
                    throws Exception

Writes a blob to the requested record.

Throws:

Exception

setBlob

public static void setBlob(Connection dbc,
                           String table,
                           String column,
                           String where,
                           byte[][] data)
                    throws Exception

Writes a blob to the requested record.

Throws:

Exception

setBlob

public static void setBlob(Connection dbc,
                           String table,
                           String column,
                           String[] pkfields,
                           Object[] key,
                           InputStream is,
                           int len)
                    throws SQLException

Throws:

SQLException

setBlob

public static void setBlob(Connection dbc,
                           String table,
                           String column,
                           String[] pkfields,
                           Object[] key,
                           File f)
                    throws SQLException

Throws:

SQLException

getLobReader

public static Reader getLobReader(Connection dbc,
                                  ResultSet rs,
                                  int col)
                           throws Exception

Returns a Reader from the blob (clob) column specified.

Parameters:

rs -

col -

Returns:

Throws:

Exception

getLobReader

public static Reader getLobReader(Connection dbc,
                                  ResultSet rs,
                                  String col)
                           throws Exception

Returns a Reader from the blob (clob) column specified.

Parameters:

rs -

col -

Returns:

Throws:

Exception

getLobStream

public static InputStream getLobStream(Connection dbc,
                                       ResultSet rs,
                                       int col)
                                throws Exception

Returns an InputStream from the blob (clob) column specified.

Parameters:

rs -

col -

Returns:

Throws:

Exception

getLobStream

public static InputStream getLobStream(Connection dbc,
                                       ResultSet rs,
                                       String col)
                                throws Exception

Returns an InputStream from the blob (clob) column specified.

Parameters:

rs -

col -

Returns:

Throws:

Exception

setClob

public static void setClob(Connection dbc,
                           String table,
                           String column,
                           String where,
                           Reader r)
                    throws Exception

Throws:

Exception

setClob

public static void setClob(Connection dbc,
                           String table,
                           String column,
                           String where,
                           String content)
                    throws Exception

Throws:

Exception

saveBlob

public static boolean saveBlob(ResultSet rs,
                               int col,
                               File f)
                        throws Exception

Saves a BLOB from a resultset to a file using Oracle semantics.

Throws:

Exception

saveBlob

public static boolean saveBlob(ResultSet rs,
                               String col,
                               File f)
                        throws Exception

Throws:

Exception

saveBlob

public static boolean saveBlob(ResultSet rs,
                               int col,
                               OutputStream os)
                        throws Exception

Throws:

Exception

getScriptResource

@Nonnull
public static String getScriptResource(@Nonnull
                                                Connection dbc,
                                                @Nonnull
                                                Class<?> clz,
                                                @Nonnull
                                                String baseName)
                                         throws Exception

Get a database script as a resource. The basename should be the base name of the script like "tables.sql". The script will determine the db type, then first try "tables-[dbtype].sql". If that is not found it will fallback to the basename.

Parameters:

dbc -

clz -

baseName -

Returns:

Throws:

SQLException

Exception

runScriptResource

public static void runScriptResource(Connection dbc,
                                     Class<?> clz,
                                     String name,
                                     StringBuilder errors)
                              throws Exception

Run a script resource with some basic name. Statements in the script must be separated by //

Parameters:

dbc -

clz -

name -

errors -

Throws:

Exception