oracle.ifs.admin.upgrade.common

Class ObjectIndexUtilities

java.lang.Object

oracle.ifs.admin.upgrade.common.ObjectIndexUtilities

public class ObjectIndexUtilities
extends Object

The ObjectIndexUtilities class provides static methods for dealing with indexes on iFS repository classobject attributes.

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
ObjectIndexUtilities()

Method Summary

Modifier and Type	Method and Description
protected static void	closeResultSet(ResultSet rset) Try our best to close a resultSet; no exceptions thrown
protected static void	closeStatement(Statement stmt) Try our best to close a Statement; no exceptions thrown
static void	createIndex(Connection con, String tableSuffix, String column) Creates an index on an iFS classobject attribute.
static void	dropIndex(Connection con, String tableSuffix, String column) Drops an index on an iFS classobject attribute.
static String	getIndexOnObjectAttribute(Statement stmt, String tableSuffix, String column) Returns the name of an index on an attribute of an object.
static Long	getObjectId(Statement stmt, String tableSuffix, String column) Get the Object ID for the Attribute of the specified table suffix and column.
static void	updateIndexedAttribute(LibrarySession session, String className, String attrName, boolean newIsIndexedValue) updateIndexedAttribute should be invoked after creating a new index on an attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectIndexUtilities

public ObjectIndexUtilities()

Method Detail

createIndex

public static void createIndex(Connection con,
                               String tableSuffix,
                               String column)
                        throws SQLException

Creates an index on an iFS classobject attribute. The ClassObject's databaseobject name (the table suffix) along with the Attribute's databaseobject name (the column name).

Parameters:

con - the JDBC connection to use for executing the query.

tableSuffix - the suffix of the table the index is on; for example "document" for the odm_document table

column - the column for the attribute

Throws:

SQLException - if a database error occurs.

dropIndex

public static void dropIndex(Connection con,
                             String tableSuffix,
                             String column)
                      throws SQLException

Drops an index on an iFS classobject attribute.

Parameters:

con - the JDBC connection to use for executing the query.

tableSuffix - the suffix of the table the index is on; for example "document" for the odm_document table

column - the column for the attribute

Throws:

SQLException - if a database error occurs.

getObjectId

public static Long getObjectId(Statement stmt,
                               String tableSuffix,
                               String column)
                        throws SQLException

Get the Object ID for the Attribute of the specified table suffix and column. Both strings specified are guaranteed to be in uppercase.

Parameters:

stmt - the JDBC statement to use for executing the query.

tableSuffix - the suffix of the table the index is on; for example "document" for the odm_document table

column - the column for the attribute

Throws:

SQLException - if a database error occurs or if there is no column for the specified table suffix.

getIndexOnObjectAttribute

public static String getIndexOnObjectAttribute(Statement stmt,
                                               String tableSuffix,
                                               String column)
                                        throws SQLException

Returns the name of an index on an attribute of an object. This method executes the following SQL command:
SELECT DISTINCT index_name FROM user_ind_columns x WHERE table_name = 'ODM_tableSuffix.toUpperCase()' AND column_name = 'column.toUpperCase()' AND 1 = (SELECT count(*) FROM user_ind_columns y WHERE y.table_name = 'ODM_tableSuffix.toUpperCase()' AND y.index_name = x.index_name)

Parameters:

stmt - the Statement to use for executing the query.

tableSuffix - the suffix of the table the index is on; for example "document" for the odm_document table

column - the column the index is on.

Returns:

the index name, or null if none exist

Throws:

SQLException - if a database error occurs.

closeResultSet

protected static void closeResultSet(ResultSet rset)

Try our best to close a resultSet; no exceptions thrown

Parameters:

rset - the ResultSet

(Unpublished)

closeStatement

protected static void closeStatement(Statement stmt)

Try our best to close a Statement; no exceptions thrown

Parameters:

stmt - the Statement

(Unpublished)

updateIndexedAttribute

public static void updateIndexedAttribute(LibrarySession session,
                                          String className,
                                          String attrName,
                                          boolean newIsIndexedValue)
                                   throws IfsException

updateIndexedAttribute should be invoked after creating a new index on an attribute. The value of the Indexed attribute should be set to true. This method needs to be run in a separate LibrarySessionAction since the creation of the new index is done in a JDBCAction.

Parameters:

session - the current LibrarySession

className - the class name of the ClassObject

attrName - the attribute of the ClassObject

newIsIndexedValue - new boolean setting for Indexed attribute

Throws:

IfsException - if the operation fails