Oracle Fusion Middleware extensions for XML based Datamodel Framework
11g Release 1 (11.1.1.5)

E22566-01

oracle.apps.fnd.applxdf.comp
Class IndexObject

java.lang.Object
  extended by oracle.apps.fnd.applxdf.comp.DBObject
      extended by oracle.apps.fnd.applxdf.comp.IndexObject

public class IndexObject
extends DBObject

Contains methods to create a Index, compare existing Index with the defintition in the xml file and generate DDLs statements if possible to map the differences or throw errors

Author:
Guoqiang Su <Guoqiang.Su@oracle.com>, izhang <irene.zhang@oracle.com>

Field Summary
 
Fields inherited from class oracle.apps.fnd.applxdf.comp.DBObject
indexExists, logger, mapPartition, notToEmitAlterDDLArray, objDoc, objectName, objElm, param
 
Constructor Summary
IndexObject()
          Constructor.
IndexObject(Parameters theParam, XDFLogger theLogger)
          Constructor with arguments.
 
Method Summary
 void executeDDLStmt(Parameters theParam, java.lang.String ddlStmt, oracle.xml.parser.v2.XMLElement indexElm)
          Execute the DDL statement for index objects.
protected  java.util.Hashtable getAlterXMLParameters()
          Get the alter XML parameters.
protected  java.lang.String getAlterXMLXSLFile()
          Get the alter XML XSL file.
protected  java.util.HashMap getClauseTypeNotToEmit()
          Dummy Method.
protected  java.util.Hashtable getCreateDDLParameters()
          Get the create DDL parameters.
protected  java.lang.String getCreateDDLXSLFile()
          Get the create DDL XSL file.
protected  void getDataFromSXML(oracle.xml.parser.v2.XMLElement inXmlDoc)
          Get the data from the XML Element.
protected  void getDataFromTargetDB(java.sql.ResultSet rset)
          Dummy method.
 oracle.sql.CLOB getDiffDocument(oracle.sql.CLOB tranformCLOB)
          Compare the difference of the two index documents and generate the difference CLOB.
 java.lang.String getIndexDeferred()
          Return the index deferred value.
static boolean getInvalidIndexes(Parameters param, java.lang.String tableName, java.lang.String tableOwner, java.util.ArrayList indexNames, java.util.ArrayList indexOwner, XDFLogger logger)
          Get the invalid indexes.
static boolean getInvalidPartitionIndexes(Parameters param, java.lang.String tableName, java.lang.String tableOwner, java.util.ArrayList indexNames, java.util.ArrayList partitionName, java.util.ArrayList indexOwner, XDFLogger logger)
          Get invalid partition indexes.
 java.lang.String getPhysicalTableName()
           
protected  java.util.Hashtable getRemapParameters()
          Get the remap parameters.
protected  java.lang.String getRemapXSLFile()
          Get the rempa XSL file.
protected  java.lang.String prepareObjectQuery(java.util.ArrayList arguments)
          Prepare the query statement.
static boolean rebuildIndexes(Parameters param, java.lang.String tableName, java.lang.String tableOwner, XDFLogger logger)
          Rebuild the indexes.
 oracle.xml.parser.v2.XMLDocumentFragment validateDDL(oracle.xml.parser.v2.XMLDocumentFragment dddlXMLDoc)
          Dummy method.
 
Methods inherited from class oracle.apps.fnd.applxdf.comp.DBObject
checkTargetDBObjectExists, executeDDLStmt, getAlterDDLArrayToExecute, getAlterXML, getCreateDDLToExecute, getCreateDDLToExecute, getDependentDiffDocument, getObjectName, getTableSpaceType, getTargetTableSpaceName, isIndexExists, isObjectObsolete, readInputSXML, remapSXML, setObjDoc, setObjectName, setObjElm, stripRowTag
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IndexObject

public IndexObject()
Constructor.


IndexObject

public IndexObject(Parameters theParam,
                   XDFLogger theLogger)
Constructor with arguments.

Parameters:
theParam - Parameters instance
theLogger - XDFLogger instance
Method Detail

getDataFromSXML

protected void getDataFromSXML(oracle.xml.parser.v2.XMLElement inXmlDoc)
Get the data from the XML Element.

Specified by:
getDataFromSXML in class DBObject
Parameters:
inXmlDoc - XML Element for an index only

getDataFromTargetDB

protected void getDataFromTargetDB(java.sql.ResultSet rset)
Dummy method. Get the data from target db

Specified by:
getDataFromTargetDB in class DBObject
Parameters:
rset - resultset from the query

prepareObjectQuery

protected java.lang.String prepareObjectQuery(java.util.ArrayList arguments)
Prepare the query statement.

Specified by:
prepareObjectQuery in class DBObject
Parameters:
arguments - arguments associated with the query statement
Returns:
query statement

getRemapXSLFile

protected java.lang.String getRemapXSLFile()
Get the rempa XSL file.

Specified by:
getRemapXSLFile in class DBObject
Returns:
remap XSL file string

getRemapParameters

protected java.util.Hashtable getRemapParameters()
Get the remap parameters.

Specified by:
getRemapParameters in class DBObject
Returns:
remap parameters hashtable

getCreateDDLXSLFile

protected java.lang.String getCreateDDLXSLFile()
Get the create DDL XSL file.

Specified by:
getCreateDDLXSLFile in class DBObject
Returns:
create DDL XSL file string

getCreateDDLParameters

protected java.util.Hashtable getCreateDDLParameters()
Get the create DDL parameters.

Specified by:
getCreateDDLParameters in class DBObject
Returns:
create DDL parameters hashtable

getAlterXMLXSLFile

protected java.lang.String getAlterXMLXSLFile()
Get the alter XML XSL file.

Specified by:
getAlterXMLXSLFile in class DBObject
Returns:
alter XML XSL file string

getAlterXMLParameters

protected java.util.Hashtable getAlterXMLParameters()
Get the alter XML parameters.

Overrides:
getAlterXMLParameters in class DBObject
Returns:
alter XML parameters

validateDDL

public oracle.xml.parser.v2.XMLDocumentFragment validateDDL(oracle.xml.parser.v2.XMLDocumentFragment dddlXMLDoc)
Dummy method. Validate DDL in the alter XMLDocumentFragment

Specified by:
validateDDL in class DBObject
Parameters:
dddlXMLDoc - alter XMLDocumentFragment
Returns:
validated XMLDocumentFragment

getClauseTypeNotToEmit

protected java.util.HashMap getClauseTypeNotToEmit()
Dummy Method. Get the clause type not to emit

Specified by:
getClauseTypeNotToEmit in class DBObject
Returns:
cluase type hashmap not to emit

rebuildIndexes

public static boolean rebuildIndexes(Parameters param,
                                     java.lang.String tableName,
                                     java.lang.String tableOwner,
                                     XDFLogger logger)
Rebuild the indexes.

Parameters:
param - Parameters instance
tableName - table name
tableOwner - talbe owner
logger - XDFLogger instance
Returns:
true if success

getInvalidIndexes

public static boolean getInvalidIndexes(Parameters param,
                                        java.lang.String tableName,
                                        java.lang.String tableOwner,
                                        java.util.ArrayList indexNames,
                                        java.util.ArrayList indexOwner,
                                        XDFLogger logger)
Get the invalid indexes.

Parameters:
param - Parameters instance
tableName - table name
tableOwner - talbe owner
indexNames - index names
indexOwner - index owner
logger - XDFLogger instance
Returns:
returns true if success

getInvalidPartitionIndexes

public static boolean getInvalidPartitionIndexes(Parameters param,
                                                 java.lang.String tableName,
                                                 java.lang.String tableOwner,
                                                 java.util.ArrayList indexNames,
                                                 java.util.ArrayList partitionName,
                                                 java.util.ArrayList indexOwner,
                                                 XDFLogger logger)
Get invalid partition indexes.

Parameters:
param - Parameters instance
tableName - table name
tableOwner - table owner
indexNames - index names
partitionName - partition name
indexOwner - index owner
logger - XDFLogger instance
Returns:
true if success

getIndexDeferred

public java.lang.String getIndexDeferred()
Return the index deferred value.

Returns:
index deferred value

executeDDLStmt

public void executeDDLStmt(Parameters theParam,
                           java.lang.String ddlStmt,
                           oracle.xml.parser.v2.XMLElement indexElm)
Execute the DDL statement for index objects.

Parameters:
theParam - Parameters instance
ddlStmt - DDL statement to be execute
indexElm - - original index xdf file

getDiffDocument

public oracle.sql.CLOB getDiffDocument(oracle.sql.CLOB tranformCLOB)
                                throws java.lang.Exception
Compare the difference of the two index documents and generate the difference CLOB.

Overrides:
getDiffDocument in class DBObject
Parameters:
tranformCLOB - CLOB to be compared to the target DB
Returns:
the CLOB of the differences of the two documents
Throws:
java.lang.Exception - when closing the statement

getPhysicalTableName

public java.lang.String getPhysicalTableName()

Oracle Fusion Middleware extensions for XML based Datamodel Framework
11g Release 1 (11.1.1.5)

E22566-01

Copyright © 2011 Oracle. All Rights Reserved.