oracle.sysman.dbTarget.db.changemgr.emo.docaccess
Class XMLAccessorSettings

java.lang.Object
  extended by oracle.sysman.dbTarget.db.changemgr.emo.docaccess.XMLAccessorSettings
All Implemented Interfaces:
XMLAccessorClient

public class XMLAccessorSettings
extends java.lang.Object
implements XMLAccessorClient


Field Summary
 
Fields inherited from interface oracle.sysman.dbTarget.db.changemgr.emo.docaccess.XMLAccessorClient
ALTERXML_TO_DDL, CHANGE_IN_PLACE_MODE, CM_OBJTYPE_CLUSTER, CM_OBJTYPE_DBLINK, CM_OBJTYPE_FUNCTION, CM_OBJTYPE_INDEX, CM_OBJTYPE_INDEX_COLUMN, CM_OBJTYPE_INDEX_SEGMENT, CM_OBJTYPE_MVIEW, CM_OBJTYPE_MVIEW_LOG, CM_OBJTYPE_PACKAGE, CM_OBJTYPE_PACKAGE_BODY, CM_OBJTYPE_PARTITIONS, CM_OBJTYPE_PROCEDURE, CM_OBJTYPE_PROFILE, CM_OBJTYPE_ROLE, CM_OBJTYPE_ROLLSEG, CM_OBJTYPE_SEQUENCE, CM_OBJTYPE_SYNONYM, CM_OBJTYPE_TABLE, CM_OBJTYPE_TABLE_COLUMN, CM_OBJTYPE_TABLE_CONSTRAINT, CM_OBJTYPE_TABLE_IOT, CM_OBJTYPE_TABLE_SEGMENT, CM_OBJTYPE_TBSP, CM_OBJTYPE_TBSP_DF, CM_OBJTYPE_TRIGGER, CM_OBJTYPE_UDT, CM_OBJTYPE_USER, CM_OBJTYPE_VIEW, DEFAULT_CHANGE_MODE, DIFF_SXML_MODE, DIFF_SXML_TO_ALTERXML, FULL_XML_TO_CMXML, FULL_XML_TO_DEP_DDL, FULL_XML_TO_GRANT_DDL, FULL_XML_TO_SXML, FULL_XML_TO_TOP_DDL, MAX_XFORM_PARAM_INDEX, MODIFY_FULL_XML, SXML_TO_DDL, XFORM_PARAM_CM_MODE, XFORM_PARAM_COMMENTS, XFORM_PARAM_CONSTS_AS_ALTER, XFORM_PARAM_FOR_DIFFING, XFORM_PARAM_IGNORE_NAME_DIFFS, XFORM_PARAM_IGNORE_TABLECOL_POS, XFORM_PARAM_MATCH_BY_DEFINITION, XFORM_PARAM_NO_CONSTRAINTS, XFORM_PARAM_NO_FORCE, XFORM_PARAM_NO_PHYSICAL_PROPERTIES, XFORM_PARAM_NO_PRETTY, XFORM_PARAM_NO_REF_CONSTRAINTS, XFORM_PARAM_NO_SEGMENT_ATTRIBUTES, XFORM_PARAM_NO_SQL_TERMINATOR, XFORM_PARAM_NO_STORAGE, XFORM_PARAM_NO_TABLESPACE, XFORM_PARAM_NO_TYPE_BODY, XFORM_PARAM_NO_TYPE_SPEC, XFORM_PARAM_NOT_USED_2, XFORM_PARAM_NOT_USED_3, XFORM_PARAM_NOT_USED_4, XFORM_PARAM_NOT_USING_INDEX, XFORM_PARAM_PARTITIONS, XFORM_PARAM_PASSWD_VALUE, XFORM_PARAM_PRS_ALTERABLE, XFORM_PARAM_PRS_CLAUSE_TYPE, XFORM_PARAM_PRS_NAME, XFORM_PARAM_PRS_XPATH, XFORM_PARAM_REUSE, XFORM_PARAM_SQL_DELIMITER, XFORM_PARAM_STATISTICS, XFORM_PARAM_SUPPRESS_SCHEMA, XFORM_PSTR_CM_MODE, XFORM_PSTR_COMMENTS, XFORM_PSTR_CONSTRAINTS, XFORM_PSTR_CONSTS_AS_ALTER, XFORM_PSTR_EMIT_SCHEMA, XFORM_PSTR_FORCE, XFORM_PSTR_IGNORE_NAME_DIFFS, XFORM_PSTR_IGNORE_TABLECOL_POS, XFORM_PSTR_MATCH_BY_DEFINITION, XFORM_PSTR_PARTITIONS, XFORM_PSTR_PASSWD_VALUE, XFORM_PSTR_PHYSICAL_PROPERTIES, XFORM_PSTR_PRETTY, XFORM_PSTR_PRS_ALTERABLE, XFORM_PSTR_PRS_CLAUSE_TYPE, XFORM_PSTR_PRS_NAME, XFORM_PSTR_PRS_XPATH, XFORM_PSTR_REF_CONSTRAINTS, XFORM_PSTR_REUSE, XFORM_PSTR_SEGMENT_ATTRIBUTES, XFORM_PSTR_SQL_DELIMITER, XFORM_PSTR_SQLTERMINATOR, XFORM_PSTR_STATISTICS, XFORM_PSTR_STORAGE, XFORM_PSTR_TABLESPACE, XFORM_PSTR_TYPE_BODY, XFORM_PSTR_TYPE_SPECIFICATION, XFORM_PSTR_USING_INDEX
 
Constructor Summary
XMLAccessorSettings()
           
 
Method Summary
 boolean getChangeManagerMode()
          Returns true if Change Manager mode is set, false if not.
 int getChangeMode()
          Returns the client-specified change mode to use when making changes to the SXML document through the accessor's methods.
 boolean getGenerateComments()
          Indicates whether comments are generated in SXML and DDL.
 boolean getGenerateConstraintIndexes()
          Indicates whether constraint indexes will be generated in CREATE TABLE DDL.
 boolean getGenerateConstraints()
          Indicates whether constraints will be generated in CREATE TABLE DDL.
 boolean getGeneratePasswordValue()
          Indicates whether generation of an encrypted password value is enabled in DDL that creates a user, database link, or other object that uses a password.
 boolean getGenerateRefConstraints()
          Indicates whether referential (foreign key) constraints will be generated in CREATE TABLE DDL.
 boolean getGenerateSQLTerminator()
          Indicates whether the SQL terminator is generted in DDL statements.
 boolean getIgnoreHighValues()
          Indicates whether range partition high values are ignored during comparison.
 boolean getIgnorePartitioning()
          Indicates whether partitioning is ignored during comparison.
 boolean getIgnorePhysicalAttributes()
          Indicates whether generation or comparison of the physical attributes clause in stored objects is enabled.
 boolean getIgnoreSegmentAttributes()
          Indicates whether generation or comparison of the segment clause in stored objects is enabled.
 boolean getIgnoreStorage()
          Indicates whether generation or comparison of the storage clause in stored objects is enabled.
 boolean getIgnoreTableColumnPosition()
          Indicates whether table column positions are ignored during comparison.
 boolean getIgnoreTablespace()
          Indicates whether generation or comparison of the tablespace clause in stored objects is enabled.
 boolean getLogicalCompare()
          Indicates whether case, extra white space, and unnecessary quotes are ignored in SQL text, and whether extra space is ignored in comments on tables, views, and materialized views.
 boolean getMatchConstraintsByName()
          Indicates whether constraints are matched by name or by definition.
 boolean getReportConstraintNameDifferences()
          Indicates whether differences in constraint names are reported in comparisons.
 javax.servlet.ServletContext getServletContext()
          Returns the ServletContext, through which the WEB_INF/xsls/ directory in which Change Manager-provided stylesheets (.xsl files) are stored can be located.
 boolean getStatistics()
          Indicates whether generation or comparison of statistics for objects that have them is enabled.
 boolean getSuppressForce()
          Indicates whether generation of the FORCE keyword in CREATE VIEW DDL is suppressed.
 boolean getSuppressSchema()
          Indicates whether generation of the schema is suppressed.
 int getSXMLToDDLTransformParamFlags(int type)
          Allows the client to specify the transform parameters to use when transforming SXML to DDL.
 int getTransformParamFlags(int type, int transform)
          Allows the client to specify the transform parameters to use for all transforms.
 java.lang.String getXslRoot()
          Returns the operating system directory that contains the WEB_INF/xsls/ directory in which Change Manager-provided stylesheets (.xsl files) are stored.
 void setAdditionalFlags(int addnlFlags)
          Sets one or more transformation flags to supplement those normally returned by the getTransformParamFlags() method.
 void setChangeManagerMode(boolean mode)
          Sets or disables "Change Manager mode" when generating SXML and when comparing object definitions.
 void setChangeMode(int mode)
          Sets the change mode to use when making changes to the SXML document through the accessor's methods.
 void setGenerateComments(boolean genComments)
          Sets or disables generation of table and view comments in SXML and DDL.
 void setGenerateConstraintIndexes(boolean genConstraintIdxs)
          Sets or disables generation of constraint indexes in CREATE TABLE DDL.
 void setGenerateConstraints(boolean genConstraints)
          Sets or disables generation of constraints in CREATE TABLE DDL.
 void setGeneratePasswordValue(boolean setPwdVal)
          Sets or disable generation of an encrypted password value in DDL that creates a user, database link, or other object that uses a password.
 void setGenerateRefConstraints(boolean genConstraints)
          Sets or disables generation of referential (foreign key) constraints in CREATE TABLE DDL.
 void setGenerateSQLTerminator(boolean genTerm)
          Sets or disables generation of the SQL terminator in DDL statements.
 void setIgnoreHighValues(boolean ignHV)
          Controls whether range partition high values are ignored during comparison.
 void setIgnorePartitioning(boolean ignPtng)
          Controls whether partitioning is ignored during comparison.
 void setIgnorePhysicalAttributes(boolean ignPhysAtts)
          Sets or disables generation or comparison of the physical attributes clause in stored objects.
 void setIgnoreSegmentAttributes(boolean ignSegAtts)
          Sets or disables generation or comparison of the segment attributes clause in stored objects.
 void setIgnoreStorage(boolean ignStorage)
          Sets or disables generation or comparison of the storage clause in stored objects.
 void setIgnoreTableColumnPosition(boolean ignColPos)
          Controls whether table column positions are ignored during comparison.
 void setIgnoreTablespace(boolean ignTablespace)
          Sets or disables generation or comparison of the tablespace clause in stored objects.
 void setLogicalCompare(boolean lc)
          Controls whether case, extra white space, and unnecessary quotes are ignored in SQL text, and whether extra space is ignored in comments on tables, views, and materialized views.
 void setMatchConstraintsByName(boolean match)
          Controls whether constraints are matched by name or by definition.
 void setReportConstraintNameDifferences(boolean rptNameDiffs)
          Controls whether differences in constraint names are reported in comparisons.
 void setServletContext(javax.servlet.ServletContext sc)
           
 void setStatistics(boolean stats)
          Sets or disables generation or comparison of statistics for objects that have them.
 void setSuppressForce(boolean suppressForce)
          Sets or disables suppressiong of the FORCE keyword in CREATE VIEW DDL.
 void setSuppressSchema(boolean suppressSchema)
          Sets or disables suppression of the schema in SXML and DDL.
 void setXslRoot(java.lang.String root)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLAccessorSettings

public XMLAccessorSettings()
Method Detail

getXslRoot

public java.lang.String getXslRoot()
Description copied from interface: XMLAccessorClient
Returns the operating system directory that contains the WEB_INF/xsls/ directory in which Change Manager-provided stylesheets (.xsl files) are stored. Access to these stylesheets must be provided to allow the XMLAccessor to generate DDL from SXML documents. In installed Enterprise Manager environments, this access can be provided by implementing the getServletContext() method. In other environments, implement the getXslRoot() method.

Specified by:
getXslRoot in interface XMLAccessorClient
Returns:
the operating system directory that contains WEB_INF

setXslRoot

public void setXslRoot(java.lang.String root)

getServletContext

public javax.servlet.ServletContext getServletContext()
Description copied from interface: XMLAccessorClient
Returns the ServletContext, through which the WEB_INF/xsls/ directory in which Change Manager-provided stylesheets (.xsl files) are stored can be located. Access to these stylesheets must be provided to allow the XMLAccessor to generate DDL from SXML documents. In installed Enterprise Manager environments, this access can be provided by implementing the getServletContext() method. In other environments, implement the getXslRoot() method.

Specified by:
getServletContext in interface XMLAccessorClient
Returns:
the ServletContext

setServletContext

public void setServletContext(javax.servlet.ServletContext sc)

getSXMLToDDLTransformParamFlags

public int getSXMLToDDLTransformParamFlags(int type)
Description copied from interface: XMLAccessorClient
Allows the client to specify the transform parameters to use when transforming SXML to DDL.

Specified by:
getSXMLToDDLTransformParamFlags in interface XMLAccessorClient
Parameters:
type - one of the CM_OBJTYPE values defined in this interface
Returns:
bitwise-OR of XMLAccessorClient.XFORM_PARAM values. If a flag is specified, the corresponding parameter is set to its non-default value.

getTransformParamFlags

public int getTransformParamFlags(int type,
                                  int transform)
Description copied from interface: XMLAccessorClient
Allows the client to specify the transform parameters to use for all transforms.

Specified by:
getTransformParamFlags in interface XMLAccessorClient
Parameters:
type - one of the CM_OBJTYPE values defined in this interface
transform - one of the transforms defined in this interface
Returns:
bitwise-OR of XMLAccessorClient.XFORM_PARAM values. If a flag is specified, the corresponding parameter is set to its non-default value.

getChangeMode

public int getChangeMode()
Returns the client-specified change mode to use when making changes to the SXML document through the accessor's methods.

Specified by:
getChangeMode in interface XMLAccessorClient
Returns:
  • XMLAccessorClient.CHANGE_IN_PLACE_MODE
  • XMLAccessorClient.DIFF_SXML_MODE

setChangeMode

public void setChangeMode(int mode)
Sets the change mode to use when making changes to the SXML document through the accessor's methods.

Parameters:
mode -
  • XMLAccessorClient.CHANGE_IN_PLACE_MODE
  • XMLAccessorClient.DIFF_SXML_MODE

setChangeManagerMode

public void setChangeManagerMode(boolean mode)
Sets or disables "Change Manager mode" when generating SXML and when comparing object definitions. It is critical that SXML intended for comparison in the Change Manager differ be generated with Change Manager mode set.

Parameters:
mode - true to specify Change Manager mode, false to disable it.

getChangeManagerMode

public boolean getChangeManagerMode()
Returns true if Change Manager mode is set, false if not.

Returns:
true Change Manager mode is enabled, false if disabled.

setGenerateConstraints

public void setGenerateConstraints(boolean genConstraints)
Sets or disables generation of constraints in CREATE TABLE DDL.

Parameters:
genConstraints - true to generate constraints in DDL, false to omit constraints.

getGenerateConstraints

public boolean getGenerateConstraints()
Indicates whether constraints will be generated in CREATE TABLE DDL.

Returns:
true if constraint generation in DDL is enabled, false otherwise.

setGenerateRefConstraints

public void setGenerateRefConstraints(boolean genConstraints)
Sets or disables generation of referential (foreign key) constraints in CREATE TABLE DDL.

Parameters:
genConstraints - true to generate referential constraints in DDL, false to omit referential constraints.

getGenerateRefConstraints

public boolean getGenerateRefConstraints()
Indicates whether referential (foreign key) constraints will be generated in CREATE TABLE DDL.

Returns:
true if referential constraint generation in DDL is enabled, false otherwise.

setGenerateConstraintIndexes

public void setGenerateConstraintIndexes(boolean genConstraintIdxs)
Sets or disables generation of constraint indexes in CREATE TABLE DDL.

Parameters:
genConstraintIdxs - true to generate constraint indexes in DDL, false to omit constraint indexess.

getGenerateConstraintIndexes

public boolean getGenerateConstraintIndexes()
Indicates whether constraint indexes will be generated in CREATE TABLE DDL.

Returns:
true if constraint index generation in DDL is enabled, false otherwise.

setGeneratePasswordValue

public void setGeneratePasswordValue(boolean setPwdVal)
Sets or disable generation of an encrypted password value in DDL that creates a user, database link, or other object that uses a password.

Parameters:
setPwdVal - true to enable encrpyted password generation, false otherwise.

getGeneratePasswordValue

public boolean getGeneratePasswordValue()
Indicates whether generation of an encrypted password value is enabled in DDL that creates a user, database link, or other object that uses a password.

Returns:
true if encrpyted password generation is enabled, false otherwise.

setIgnorePhysicalAttributes

public void setIgnorePhysicalAttributes(boolean ignPhysAtts)
Sets or disables generation or comparison of the physical attributes clause in stored objects.

Parameters:
ignPhysAtts - true to disable generation or comparison of the physical attributes clause, false otherwise.

getIgnorePhysicalAttributes

public boolean getIgnorePhysicalAttributes()
Indicates whether generation or comparison of the physical attributes clause in stored objects is enabled.

Returns:
true if generation or comparison of the physical attributes clause is disabled, false otherwise.

setIgnoreTablespace

public void setIgnoreTablespace(boolean ignTablespace)
Sets or disables generation or comparison of the tablespace clause in stored objects.

Parameters:
ignTablespace - true to disable generation or comparison of the tablespace clause, false otherwise.

getIgnoreTablespace

public boolean getIgnoreTablespace()
Indicates whether generation or comparison of the tablespace clause in stored objects is enabled.

Returns:
true if generation or comparison of the tablespace clause is disabled, false otherwise.

setIgnoreSegmentAttributes

public void setIgnoreSegmentAttributes(boolean ignSegAtts)
Sets or disables generation or comparison of the segment attributes clause in stored objects.

Parameters:
ignSegAtts - true to disable generation or comparison of the segment attributes clause, false otherwise.

getIgnoreSegmentAttributes

public boolean getIgnoreSegmentAttributes()
Indicates whether generation or comparison of the segment clause in stored objects is enabled.

Returns:
true if generation or comparison of the segment attributes clause is disabled, false otherwise.

setIgnoreStorage

public void setIgnoreStorage(boolean ignStorage)
Sets or disables generation or comparison of the storage clause in stored objects.

Parameters:
ignStorage - true to disable generation or comparison of the storage clause, false otherwise.

getIgnoreStorage

public boolean getIgnoreStorage()
Indicates whether generation or comparison of the storage clause in stored objects is enabled.

Returns:
true if generation or comparison of the storage clause is disabled, false otherwise.

setStatistics

public void setStatistics(boolean stats)
Sets or disables generation or comparison of statistics for objects that have them. When generating DDL, statistics DBMS_STATS calls are generated instead of object DDL.

Parameters:
stats - true to enable generation or comparison of statistics, false otherwise.

getStatistics

public boolean getStatistics()
Indicates whether generation or comparison of statistics for objects that have them is enabled. If true, statistics DBMS_STATS calls are generated instead of object DDL.

Returns:
true if generation or comparison of statistics is enabled, false otherwise.

setMatchConstraintsByName

public void setMatchConstraintsByName(boolean match)
Controls whether constraints are matched by name or by definition.

Parameters:
match - true to match constraints by name, false to match by definition

getMatchConstraintsByName

public boolean getMatchConstraintsByName()
Indicates whether constraints are matched by name or by definition.

Returns:
true if constraints are matched by name, false if matched by definition

setReportConstraintNameDifferences

public void setReportConstraintNameDifferences(boolean rptNameDiffs)
Controls whether differences in constraint names are reported in comparisons. This parameter is only meaningful when constraints are matched by definition.

Parameters:
rptNameDiffs - true to report constraint name differences, false to ignore constraint name differences

getReportConstraintNameDifferences

public boolean getReportConstraintNameDifferences()
Indicates whether differences in constraint names are reported in comparisons. This parameter is only meaningful when constraints are matched by definition.

Returns:
true if constraint name differences are reported, false ignore constraint name differences are ignored

setIgnoreTableColumnPosition

public void setIgnoreTableColumnPosition(boolean ignColPos)
Controls whether table column positions are ignored during comparison.

Parameters:
ignColPos - true to ignore column position, false to compare column position

getIgnoreTableColumnPosition

public boolean getIgnoreTableColumnPosition()
Indicates whether table column positions are ignored during comparison.

Returns:
true if column position is ignored, false if column position is compared

setLogicalCompare

public void setLogicalCompare(boolean lc)
Controls whether case, extra white space, and unnecessary quotes are ignored in SQL text, and whether extra space is ignored in comments on tables, views, and materialized views.

Parameters:
lc - true to enable logicical comparison

getLogicalCompare

public boolean getLogicalCompare()
Indicates whether case, extra white space, and unnecessary quotes are ignored in SQL text, and whether extra space is ignored in comments on tables, views, and materialized views.

Returns:
true if logicical comparison is in effect

setIgnoreHighValues

public void setIgnoreHighValues(boolean ignHV)
Controls whether range partition high values are ignored during comparison.

Parameters:
ignHV - true to ignore partition high values

getIgnoreHighValues

public boolean getIgnoreHighValues()
Indicates whether range partition high values are ignored during comparison.

Returns:
true if partition high values are ignored

setIgnorePartitioning

public void setIgnorePartitioning(boolean ignPtng)
Controls whether partitioning is ignored during comparison.

Parameters:
ignPtng - true to ignore partitioning

getIgnorePartitioning

public boolean getIgnorePartitioning()
Indicates whether partitioning is ignored during comparison.

Returns:
true if partitioning is ignored

setGenerateSQLTerminator

public void setGenerateSQLTerminator(boolean genTerm)
Sets or disables generation of the SQL terminator in DDL statements.

Parameters:
genTerm - true to generate the SQL terminator, false to suppress it

getGenerateSQLTerminator

public boolean getGenerateSQLTerminator()
Indicates whether the SQL terminator is generted in DDL statements.

Returns:
true if the SQL terminator is generated, false if it is suppressed

setGenerateComments

public void setGenerateComments(boolean genComments)
Sets or disables generation of table and view comments in SXML and DDL. (Comments in SXML is a Change Manager extension to SXML.)

Parameters:
genComments - true to generate comment SXML and DDL, false to suppress comment generation.

getGenerateComments

public boolean getGenerateComments()
Indicates whether comments are generated in SXML and DDL. (Comments in SXML is a Change Manager extension to SXML.)

Returns:
true if comments are generated in SXML and DDL, false otherwise.

setSuppressSchema

public void setSuppressSchema(boolean suppressSchema)
Sets or disables suppression of the schema in SXML and DDL.

Parameters:
suppressSchema - true to suppress generation of the schema, false to allow it

getSuppressSchema

public boolean getSuppressSchema()
Indicates whether generation of the schema is suppressed.

Returns:
true if schema generation is suppressed, false otherwise

setSuppressForce

public void setSuppressForce(boolean suppressForce)
Sets or disables suppressiong of the FORCE keyword in CREATE VIEW DDL.

Parameters:
suppressForce - true to suppress generation of the FORCE keyword, false to allow it

getSuppressForce

public boolean getSuppressForce()
Indicates whether generation of the FORCE keyword in CREATE VIEW DDL is suppressed.

Returns:
true if generation of the FORCE keyword is suppressed, false otherwise.

setAdditionalFlags

public void setAdditionalFlags(int addnlFlags)
Sets one or more transformation flags to supplement those normally returned by the getTransformParamFlags() method. The value specified is bitwise-OR'd with the value normally returned by the method.

Parameters:
addnlFlags - The bitwise-OR of transformation parameter flags