oracle.pg.rdbms

Class Oracle

java.lang.Object

oracle.pg.rdbms.Oracle

public class Oracle
extends Object

This class manages the RDBMS JDBC connection to an Oracle semantic store. Many convenience methods are provided to insert rows, execute SQL statements, etc.

Version:

1.1

Author:

Zhe Wu

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDEX_DOP This contant denotes the default value used for index degree of parallelism (DOP)
static int	DEFAULT_OPT_DYN_SAMPLING This constant denotes the default value used for dynamic sampling
static String	DEFAULT_PG_DS_NAME The default name of the data source for Oracle PG data management
static int	ORA_COL_ALREADY_INDEXED This constant denotes the Oracle error code for column already indexed
static int	ORA_DUP_ENTRY This constant denotes the Oracle error code for duplicate entry
static int	ORA_INDEX_NOT_EXIST This constant denotes the Oracle error code for index does not exist
static int	ORA_INSUFFICIENT_PRIV This constant denotes the Oracle error code for insufficient privileges
static int	ORA_INVALID_ID This constant denotes the Oracle error code for invalid ID
static int	ORA_INVALID_LOWER_LIMIT_SNAPSHOT This constant denotes the Oracle error code for invalid lower limit for snapshot
static int	ORA_INVALID_SCN This constant denotes the Oracle error code for invalid SCN
static int	ORA_LENGTH_TOO_LONG_FOR_DT This constant denotes the Oracle error code for length too long for datatype
static int	ORA_NAME_IN_USE_BY_EXISTING_OBJECT This constant denotes the Oracle error code for name in use by an existing object
static int	ORA_PTNED_IDX_MAY_NOT_BUILD_AS_WHOLE This constant denotes the Oracle error code for partitioned index may not be built as whole
static int	ORA_TAB_DEF_HAS_CHANGED This constant denotes the Oracle error code for table definition has changed
static int	ORA_TABLE_NOT_EXISTS This constant denotes the Oracle error code for table does not exist

Constructor Summary

Constructors

Constructor and Description
Oracle(oracle.jdbc.OracleConnection conn) Constructs a new instance based on the JDBC connection passed in.
Oracle(oracle.jdbc.pool.OracleDataSource ods) Constructs a new instance based on the data source object passed in.
Oracle(String url, String user, String pass) Constructs a new instance based on the JDBC connection and login information passed in.

Method Summary

Methods

Modifier and Type	Method and Description
Oracle	clone() Returns a new Oracle instance based on the JDBC connection information stored in this instance.
oracle.jdbc.OracleConnection	cloneConnection() Returns a new instance of OracleConnection.
void	commitTransaction() Persists changes made through this Oracle connection.
OraclePool	createPool(Properties prop) Creates an instance of OraclePool.
void	dispose() Closes the underlying JDBC connection after a rollback.
void	executeCall(String s) Executes a Callable statement based on s
void	executeCall(String s, String bindVarValue) Executes a Callable statement based on s and the given bind variable
void	executeCall(String s, String bv1, String bv2) Executes a Callable statement based on s and the given bind variables
ResultSet	executeQuery(String s) Executes the given query and returns a query result set.
ResultSet	executeQuery(String s, int iTimeout, int iDOP) Executes the given query and returns a query result set.
ResultSet	executeQuery(String s, int iTimeout, int iDOP, List listBindValues) Executes the given query and returns a query result set.
ResultSet	executeQueryWithArg(String s, String arg) Executes the given SQL statement with a bind variable.
ResultSet	executeQueryWithArg(String s, String arg, String arg2) Executes a SQL statement and returns a result set.
ResultSet	executeQueryWithArg(String s, String arg, String arg2, String arg3) Executes a SQL statement and returns a result set.
static void	executeSQL(Connection conn, String s) Executes a SQL statement, for example, a statement to create or drop a table, or a callable statement.
void	executeSQL(String s) Executes a SQL statement, for example, a statement to create or drop a table, or a callable statement.
void	executeSQL(String s, String bindVarValue) Executes a SQL statement.
void	executeSQL(String s, String bv1, String bv2) Executes a SQL statement.
void	executeSQL(String s, String bv1, String bv2, String bv3) Executes a SQL statement.
int	executeUpdate(String s) Used for SQL INSERT and UPDATE operations, but not for statements that are batched.
oracle.jdbc.OracleConnection	getConnection() Returns the underlying OracleConnection object upon request.
String	getSessionID() Returns the current Database Session ID
boolean	isOpgAPIsLoaded() Validates if the OPG APIs (catopg.sql) has been loaded into the Oracle Database
void	rollbackTransaction() Rolls back changes made through this Oracle connection.
void	setLabel(String policy, String label) Sets the label for the current session.
static void	setLocale() Set default locale using two Jena Adaptor specific JAVA VM properties
void	setRowLabel(String policy, String label) Sets the row label for the current session.
static void	setSessionQueryDOP(Connection conn, int dop) Sets the degree of parallel query execution at the session level.
void	setSessionQueryDOP(int dop) Sets the degree of parallel query execution at the session level.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDEX_DOP

public static final int DEFAULT_INDEX_DOP

This contant denotes the default value used for index degree of parallelism (DOP)

See Also:

Constant Field Values

DEFAULT_OPT_DYN_SAMPLING

public static final int DEFAULT_OPT_DYN_SAMPLING

This constant denotes the default value used for dynamic sampling

See Also:

Constant Field Values

DEFAULT_PG_DS_NAME

public static final String DEFAULT_PG_DS_NAME

The default name of the data source for Oracle PG data management

See Also:

Constant Field Values

ORA_COL_ALREADY_INDEXED

public static final int ORA_COL_ALREADY_INDEXED

This constant denotes the Oracle error code for column already indexed

See Also:

Constant Field Values

ORA_DUP_ENTRY

public static final int ORA_DUP_ENTRY

This constant denotes the Oracle error code for duplicate entry

See Also:

Constant Field Values

ORA_INDEX_NOT_EXIST

public static final int ORA_INDEX_NOT_EXIST

This constant denotes the Oracle error code for index does not exist

See Also:

Constant Field Values

ORA_INSUFFICIENT_PRIV

public static final int ORA_INSUFFICIENT_PRIV

This constant denotes the Oracle error code for insufficient privileges

See Also:

Constant Field Values

ORA_INVALID_ID

public static final int ORA_INVALID_ID

This constant denotes the Oracle error code for invalid ID

See Also:

Constant Field Values

ORA_INVALID_LOWER_LIMIT_SNAPSHOT

public static final int ORA_INVALID_LOWER_LIMIT_SNAPSHOT

This constant denotes the Oracle error code for invalid lower limit for snapshot

See Also:

Constant Field Values

ORA_INVALID_SCN

public static final int ORA_INVALID_SCN

This constant denotes the Oracle error code for invalid SCN

See Also:

Constant Field Values

ORA_LENGTH_TOO_LONG_FOR_DT

public static final int ORA_LENGTH_TOO_LONG_FOR_DT

This constant denotes the Oracle error code for length too long for datatype

See Also:

Constant Field Values

ORA_NAME_IN_USE_BY_EXISTING_OBJECT

public static final int ORA_NAME_IN_USE_BY_EXISTING_OBJECT

This constant denotes the Oracle error code for name in use by an existing object

See Also:

Constant Field Values

ORA_PTNED_IDX_MAY_NOT_BUILD_AS_WHOLE

public static final int ORA_PTNED_IDX_MAY_NOT_BUILD_AS_WHOLE

This constant denotes the Oracle error code for partitioned index may not be built as whole

See Also:

Constant Field Values

ORA_TAB_DEF_HAS_CHANGED

public static final int ORA_TAB_DEF_HAS_CHANGED

This constant denotes the Oracle error code for table definition has changed

See Also:

Constant Field Values

ORA_TABLE_NOT_EXISTS

public static final int ORA_TABLE_NOT_EXISTS

This constant denotes the Oracle error code for table does not exist

See Also:

Constant Field Values

Constructor Detail

Oracle

public Oracle(oracle.jdbc.OracleConnection conn)

Constructs a new instance based on the JDBC connection passed in.

Parameters:

conn - an OracleConnection object. It MUST not be null

Oracle

public Oracle(oracle.jdbc.pool.OracleDataSource ods)

Constructs a new instance based on the data source object passed in.

Parameters:

ods - an OracleDataSource object. It MUST not be null

Oracle

public Oracle(String url,
      String user,
      String pass)

Constructs a new instance based on the JDBC connection and login information passed in.

Parameters:

url - JDBC URL that identifies an Oracle database

user - username of a database schema

pass - password to authenticate

Method Detail

clone

public Oracle clone()

Returns a new Oracle instance based on the JDBC connection information stored in this instance.

Overrides:

clone in class Object

Returns:

a new Oracle instance

cloneConnection

public oracle.jdbc.OracleConnection cloneConnection()
                                             throws SQLException

Returns a new instance of OracleConnection. Callers of this method are reponsible for closing the returned connection object.

Throws:

SQLException

commitTransaction

public void commitTransaction()
                       throws SQLException

Persists changes made through this Oracle connection.

Throws:

SQLException

createPool

public OraclePool createPool(Properties prop)

Creates an instance of OraclePool.

Parameters:

prop - properties to be used for pool creation

Returns:

an instance of OraclePool

dispose

public void dispose()
             throws SQLException

Closes the underlying JDBC connection after a rollback. If changes need to be persisted, be sure to issue a commitTransaction() call before this method call.

Throws:

SQLException

executeCall

public void executeCall(String s)
                 throws SQLException

Executes a Callable statement based on s

Parameters:

s - a Callable statement

Throws:

SQLException - when there is a server error.

executeCall

public void executeCall(String s,
               String bindVarValue)
                 throws SQLException

Executes a Callable statement based on s and the given bind variable

Parameters:

s - a Callable statement

bindVarValue - value of the bind variable

Throws:

SQLException - when there is a server error.

executeCall

public void executeCall(String s,
               String bv1,
               String bv2)
                 throws SQLException

Executes a Callable statement based on s and the given bind variables

Parameters:

s - a Callable statement

bv1 - the value of the first bind variable

bv2 - the value of the second bind variable

Throws:

SQLException - when there is a server error.

executeQuery

public ResultSet executeQuery(String s)
                       throws SQLException

Executes the given query and returns a query result set. The invoker of this method is responsible for closing the statement after consuming the result set. In case there is a SQLException caused by the query execution, then the statement will be closed automatically.

Parameters:

s - the SQL command

Returns:

The result set. The caller is responsible for closing the Statement backing the returned ResultSet.

Throws:

SQLException - when there is a server error.

executeQuery

public ResultSet executeQuery(String s,
                     int iTimeout,
                     int iDOP)
                       throws SQLException

Executes the given query and returns a query result set. The invoker of this method is responsible for closing the statement after consuming the result set. In case there is a SQLException caused by the query execution, then the statement will be closed automatically.

Parameters:

s - the SQL command

iTimeout - number of seconds the system will wait for execution to finish

iDOP - degree of parallelism to execute the query.

Returns:

The result set. The caller is responsible for closing the Statement backing the returned ResultSet.

Throws:

SQLException - when there is a server error.

executeQuery

public ResultSet executeQuery(String s,
                     int iTimeout,
                     int iDOP,
                     List listBindValues)
                       throws SQLException

Executes the given query and returns a query result set. The invoker of this method is responsible for closing the statement after consuming the result set. In case there is a SQLException caused by the query execution, then the statement will be closed automatically.

Parameters:

s - the SQL command

iTimeout - number of seconds the system will wait for execution to finish

iDOP - degree of parallelism to execute the query.

listBindValues - the list of binding values

Returns:

The result set. The caller is responsible for closing the Statement backing the returned ResultSet.

Throws:

SQLException - when there is a server error.

executeQueryWithArg

public ResultSet executeQueryWithArg(String s,
                            String arg)
                              throws SQLException

Executes the given SQL statement with a bind variable. This method executes the given query and returns a query result set. The invoker of this method is responsible for closing the statement after consuming the result set.

Parameters:

s - SQL statement to be executed

arg - value of a bind variable

Throws:

SQLException - when there is a server error.

executeQueryWithArg

public ResultSet executeQueryWithArg(String s,
                            String arg,
                            String arg2)
                              throws SQLException

Executes a SQL statement and returns a result set. The statement used to run the query is not closed (and cannot be closed in this method). The invoker of this method is responsible for closing the statement after consuming the result set.

Parameters:

s - SQL statement to be executed.

arg - value of the first bind variable

arg2 - value of the second bind variable

Throws:

SQLException - when there is a server error.

executeQueryWithArg

public ResultSet executeQueryWithArg(String s,
                            String arg,
                            String arg2,
                            String arg3)
                              throws SQLException

Executes a SQL statement and returns a result set. The statement used to run the query is not closed (and cannot be closed in this method). The invoker of this method is responsible for closing the statement after consuming the result set.

Parameters:

s - SQL statement to be executed.

arg - value of the first bind variable

arg2 - value of the second bind variable

arg3 - value of the third bind variable

Throws:

SQLException - when there is a server error.

executeSQL

public static void executeSQL(Connection conn,
              String s)
                       throws SQLException

Executes a SQL statement, for example, a statement to create or drop a table, or a callable statement.

Parameters:

conn - Database connection

s - SQL statement

Throws:

SQLException - when there is a server error.

executeSQL

public void executeSQL(String s)
                throws SQLException

Executes a SQL statement, for example, a statement to create or drop a table, or a callable statement.

Parameters:

s - SQL statement

Throws:

SQLException - when there is a server error.

executeSQL

public void executeSQL(String s,
              String bindVarValue)
                throws SQLException

Executes a SQL statement.

Parameters:

s - SQL statement

bindVarValue - value of the bind variable

Throws:

SQLException - when there is a server error.

executeSQL

public void executeSQL(String s,
              String bv1,
              String bv2)
                throws SQLException

Executes a SQL statement.

Parameters:

s - SQL statement

bv1 - value of the first bind variable

bv2 - value of the second bind variable

Throws:

SQLException - when there is a server error.

executeSQL

public void executeSQL(String s,
              String bv1,
              String bv2,
              String bv3)
                throws SQLException

Executes a SQL statement.

Parameters:

s - SQL statement

bv1 - value of the first bind variable

bv2 - value of the second bind variable

bv3 - value of the third bind variable

Throws:

SQLException - when there is a server error.

executeUpdate

public int executeUpdate(String s)
                  throws SQLException

Used for SQL INSERT and UPDATE operations, but not for statements that are batched.

Parameters:

s - the SQL statement

Returns:

The value returned by Statement.execute(java.lang.String)

Throws:

SQLException

getConnection

public oracle.jdbc.OracleConnection getConnection()
                                           throws SQLException

Returns the underlying OracleConnection object upon request. A new instance of OracleConnection will be created if this method is called for the first time.

Throws:

SQLException - if there is any problem establishing a connection to the server.

getSessionID

public String getSessionID()
                    throws SQLException

Returns the current Database Session ID

Throws:

SQLException

isOpgAPIsLoaded

public boolean isOpgAPIsLoaded()

Validates if the OPG APIs (catopg.sql) has been loaded into the Oracle Database

Returns:

TRUE if catopg.sql has been loaded into the Oracle database.

rollbackTransaction

public void rollbackTransaction()
                         throws SQLException

Rolls back changes made through this Oracle connection.

Throws:

SQLException

setLabel

public void setLabel(String policy,
            String label)
              throws SQLException

Sets the label for the current session.

Parameters:

policy - name of the OLS policy

label - security label name

Throws:

SQLException

setLocale

public static void setLocale()

Set default locale using two Jena Adaptor specific JAVA VM properties

setRowLabel

public void setRowLabel(String policy,
               String label)
                 throws SQLException

Sets the row label for the current session.

Parameters:

policy - name of the OLS policy

label - security label name

Throws:

SQLException

setSessionQueryDOP

public static void setSessionQueryDOP(Connection conn,
                      int dop)
                               throws SQLException

Sets the degree of parallel query execution at the session level.

Parameters:

dop - degree of parallelism. The value can be zero. If the value is negative, then it is no op.

Throws:

SQLException

setSessionQueryDOP

public void setSessionQueryDOP(int dop)
                        throws SQLException

Sets the degree of parallel query execution at the session level.

Parameters:

dop - degree of parallelism. The value can be zero. If the value is negative, then it is no op.

Throws:

SQLException