org.rhq.core.db

Class OracleDatabaseType

java.lang.Object

org.rhq.core.db.DatabaseType

org.rhq.core.db.OracleDatabaseType

Direct Known Subclasses:

Oracle8DatabaseType

public abstract class OracleDatabaseType
extends DatabaseType

Superclass of all versions of the Oracle database.

Author:

John Mazzitelli

Field Summary

Fields

Modifier and Type	Field and Description
static String	VENDOR The vendor name for all Oracle databases.

Constructor Summary

Constructors

Constructor and Description
OracleDatabaseType()

Method Summary

Methods

Modifier and Type	Method and Description
void	alterColumn(Connection conn, String table, String column, String generic_column_type, String default_value, String precision, Boolean nullable, Boolean reindex) Alters an existing column.
String	getBooleanValue(boolean bool) Oracle needs 1 for true and 0 for false.
Integer	getInteger(Object number) Get the Integer representation of the number type supplied by the db vendor for an integer field value.
String	getLimitClause(int limit) Return vendor-specific row limit clause to be appended to a native SQL SELECT statement.
Long	getLong(Object number) Get the Long representation of the number type supplied by the db vendor for a long field value.
int	getNextSequenceValue(Connection conn, String table, String key) A utility that returns the next value of a sequence.
String	getSequenceInsertValue(Connection conn, String sequenceName) A utility that returns the string for sequence use in an Insert statement
int	getSequenceValue(Connection conn, String table, String key) A utility that returns the last value of a sequence.
String	getString(String varchar, int maxLength) Different vendors have different rules regarding varchar/varchar2 string storage.
String	getVendor() Returns VENDOR.
boolean	isTableNotFoundException(SQLException e) Determines if the given SQL exception was caused by a "table not found" error.
void	reindexTable(Connection conn, String table) Reindexes the given table.
void	setBooleanValue(boolean bool, PreparedStatement ps, int idx) For Oracle databases, the boolean parameter will actually be of type "int" with a value of 0 or 1.

Methods inherited from class org.rhq.core.db.DatabaseType

addColumn, checkColumnExists, checkTableExists, closeConnection, closeJDBCObjects, closeResultSet, closeStatement, countRows, createSequence, deleteColumn, dropSequence, dropTable, executeSelectSql, executeSql, executeSql, getDBTypeFromGenericType, getEscapeCharacter, getHibernateDialect, getName, getVersion, insert, matches, supportsSelfReferringCascade, toString, update, updateColumn

Methods inherited from class java.lang.Object

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

Field Detail

VENDOR

public static final String VENDOR

The vendor name for all Oracle databases.

See Also:

Constant Field Values

Constructor Detail

OracleDatabaseType

public OracleDatabaseType()

Method Detail

getVendor

public String getVendor()

Returns VENDOR.

Specified by:

getVendor in class DatabaseType

Returns:

name of database vendor

See Also:

DatabaseType.getVendor()

getBooleanValue

public String getBooleanValue(boolean bool)

Oracle needs 1 for true and 0 for false.

Overrides:

getBooleanValue in class DatabaseType

Parameters:

bool - the boolean value to be converted to the DB string version of the boolean

Returns:

the appropriate boolean string for the specific database

See Also:

DatabaseType.getBooleanValue(boolean)

getInteger

public Integer getInteger(Object number)

Description copied from class: DatabaseType

Get the Integer representation of the number type supplied by the db vendor for an integer field value. The default implementation simply applies a cast to the passed in number and is appropriate for DB types that support a native integer field type (like Postgres). Other db types should override this method (like Oracle).

Overrides:

getInteger in class DatabaseType

Returns:

getLong

public Long getLong(Object number)

Description copied from class: DatabaseType

Get the Long representation of the number type supplied by the db vendor for a long field value. The default implementation simply applies a cast to the passed in number and is appropriate for DB types that support a native long field type. Other db types should override this method (like Oracle).

Overrides:

getLong in class DatabaseType

Returns:

getString

public String getString(String varchar,
               int maxLength)

Description copied from class: DatabaseType

Different vendors have different rules regarding varchar/varchar2 string storage. In particular, Oracle has a hard limit of 4000 bytes (not characters, bytes). Make sure we trim to maxLength (in characters) while also meeting vendor-specific constraints.

Overrides:

getString in class DatabaseType

Parameters:

varchar - The String to be stored as a varchar/varchar2

maxLength - max length of the DB field, in characters.

Returns:

The string, safe for storage to the DB field

setBooleanValue

public void setBooleanValue(boolean bool,
                   PreparedStatement ps,
                   int idx)
                     throws SQLException

For Oracle databases, the boolean parameter will actually be of type "int" with a value of 0 or 1.

Overrides:

setBooleanValue in class DatabaseType

Parameters:

bool - the boolean you want

ps - the prepapred statement where the boolean will be stored

idx - the index that corresponds to the boolean parameter in the statement

Throws:

SQLException

See Also:

DatabaseType.setBooleanValue(boolean, PreparedStatement, int)

isTableNotFoundException

public boolean isTableNotFoundException(SQLException e)

Description copied from class: DatabaseType

Determines if the given SQL exception was caused by a "table not found" error.

Specified by:

isTableNotFoundException in class DatabaseType

Parameters:

e - the SQL exception that occurred

Returns:

true if the given exception is the database's "table not found" exception.

See Also:

DatabaseType.isTableNotFoundException(SQLException)

getSequenceValue

public int getSequenceValue(Connection conn,
                   String table,
                   String key)
                     throws SQLException

Description copied from class: DatabaseType

A utility that returns the last value of a sequence. This is useful for when you need the value of a primary key for a row that you just inserted.

Specified by:

getSequenceValue in class DatabaseType

Parameters:

conn - The connection to use to get the sequence value.

table - The table where the sequence is defined.

key - The column on which the sequence is defined.

Returns:

the last value of a sequence

Throws:

SQLException

See Also:

DatabaseType.getSequenceValue(Connection, String, String)

getSequenceInsertValue

public String getSequenceInsertValue(Connection conn,
                            String sequenceName)

Description copied from class: DatabaseType

A utility that returns the string for sequence use in an Insert statement

Overrides:

getSequenceInsertValue in class DatabaseType

Parameters:

conn - The connection to use to get the sequence value.

sequenceName - The sequence name for the table.

Returns:

the sequence generating string

getNextSequenceValue

public int getNextSequenceValue(Connection conn,
                       String table,
                       String key)
                         throws SQLException

Description copied from class: DatabaseType

A utility that returns the next value of a sequence.

Specified by:

getNextSequenceValue in class DatabaseType

Parameters:

conn - The connection to use to get the sequence value.

table - The table where the sequence is defined.

key - The column on which the sequence is defined.

Returns:

the last value of a sequence

Throws:

SQLException

See Also:

DatabaseType.getNextSequenceValue(Connection, String, String)

alterColumn

public void alterColumn(Connection conn,
               String table,
               String column,
               String generic_column_type,
               String default_value,
               String precision,
               Boolean nullable,
               Boolean reindex)
                 throws SQLException

Description copied from class: DatabaseType

Alters an existing column. You can optionally alter the column's type, the default value, precision, and nullability. You can also optionally reindex the table.

Specified by:

alterColumn in class DatabaseType

Parameters:

conn - connection to the database

table - the name of the table where the column exists

column - the name of the column to alter

generic_column_type - the new generic type of the column

default_value - the new default value

precision - the new precision of the column

nullable - the new nullable value (if true, it's value can now be NULL)

reindex - if true, and the DB supports it, the table will be reindexed

Throws:

SQLException

See Also:

DatabaseType.alterColumn(Connection, String, String, String, String, String, Boolean, Boolean)

reindexTable

public void reindexTable(Connection conn,
                String table)
                  throws SQLException

Description copied from class: DatabaseType

Reindexes the given table.

Specified by:

reindexTable in class DatabaseType

Throws:

SQLException

See Also:

DatabaseType.reindexTable(Connection, String)

getLimitClause

public String getLimitClause(int limit)

Description copied from class: DatabaseType

Return vendor-specific row limit clause to be appended to a native SQL SELECT statement. This does not support OFFSET and therefore is not useful for paging, only for limiting the result set in a native way. For predictable results it is usually desirable to use an ORDER BY in conjunction with limit.

Overrides:

getLimitClause in class DatabaseType

Returns:

the limit clause