Oracle Fusion Middleware extensions for Seed Data Framework
11g Release 1 (11.1.2)

E22564-02

oracle.apps.fnd.applseed.rt.common.util
Class SDConfigUtil

java.lang.Object
  extended by oracle.apps.fnd.applseed.rt.common.util.SDConfigUtil

public class SDConfigUtil
extends java.lang.Object


Method Summary
static java.lang.String getAlternateKeyName(SDViewNode node)
          Method returns the Alternate Key name for this ViewNode if this property is declared.
static java.util.List<java.lang.String> getAttrExclusionList(SDViewNode node)
          Get list of attribute names for the node that are to be excluded from extract.
static java.util.List<java.lang.String> getChildOrder(SDViewNode node)
          Return any pre-defined child ordering for the given node, as ordered list.
static java.lang.Integer getCommitSize(SDViewNode node)
          Return any custom commit size value set for passed node.
static java.lang.String getConnectByClause(SDViewNode node)
          gets the connect by clause defined for a given SDViewNode
static java.lang.String getCVN(SDViewNode node)
          Method returns the Config Version Number (CVN) for this ViewNode.
static java.lang.String getDecodedHint(java.lang.String key, oracle.jbo.Properties props)
          Method decodes a UTF-8 encoded string property.
static java.util.List<java.lang.String> getExclusionLinkList(SDViewNode node)
          Return the list of links from given node that are to be excluded from extract/upload.
static java.lang.String getExclusiveExtractPartitionKey(oracle.jbo.ApplicationModule am)
          Get the partition key to use for the Exclusive extract mode.
static java.lang.String getExclusiveExtractVOName(oracle.jbo.ApplicationModule am, java.lang.String voName)
          Get the Exclusive Extract VO name property value.
static java.util.List<java.lang.String> getExtRefsList(SDViewNode node)
          Get list of static external references defined for this node.
static java.lang.String getFragment(java.lang.String str, int fragmentIndex)
          String utility that splits the passed str on the character period and returns the fragment identified by the fragmentIndex.
static java.lang.String getHandlerContext(SDViewNode node)
           
static java.lang.String getHandlerText(SDViewNode node)
          Method returns the appropriate handler for upload types bulk and custom.
static java.lang.String getHandlerType(SDViewNode node)
          Method returns the upload handler type.
static java.lang.String getIdentifierKey(java.lang.String baseKey, SDViewNode node)
          Method returns the transformed based key that identifies the driver view.
static java.util.List<java.lang.String> getIgnoreRefDataValidationList(SDViewNode node)
           
static java.util.List<java.lang.String> getLOVExclusionList(SDViewNode node)
          return the list of LOV's from a given node that are to be excluded from extract/upload
static java.lang.String getMultiTenantColumnName(SDViewNode node)
          Get the multi-tenant enterprise id column name.
static java.util.Map<java.lang.String,java.lang.String> getPropertiesWithPrefix(oracle.jbo.ApplicationModule am, java.lang.String prefix)
          Method returns the map of properties that have keys that start with prefix.
static java.util.Map<java.lang.String,java.lang.String> getPVOToInstanceMapping(oracle.jbo.ApplicationModule am)
          PVO To Instance MAp in the Am
static java.lang.String getReferenceAMName(oracle.jbo.ApplicationModule srcAM, java.lang.String driverName, java.lang.String viewName)
          Get the ReferenceAM property from the named AM for the named driver/child view.
static java.util.List<java.lang.String> getRefVAList(SDViewNode node)
          Return the list of View Accesor's (VA's) that should be used for external reference processing if the are used in a LOV
static java.lang.String getSeedChangeIndicator(SDViewNode node)
          Return the name of the seed data change indicator attribute.
static java.lang.String getStagingTableName(SDViewNode node)
          Method returns the staging table name for the ViewNode if the upload mode is bulk mode.
static java.lang.String getSurrogate(SDViewNode node)
          Get the Surrogate Id property value.
static java.util.List<java.lang.String> getTransientAttrExtractList(SDViewNode node)
          Get the list of attributes for the given node that should be extracted, regardless of the Transient or Derived properties.
static java.util.Map<java.lang.String,java.lang.String> getVAPVOMaping(SDViewNode node)
          VA TO PVO Mapping format; VA:PVO,VA:PVO
static boolean isBulkValidate(SDViewNode node)
           
static boolean isDraft(SDViewNode node)
          Method returns true if the Application Module is in draft status.
static boolean isIncrMidTier(SDViewNode node)
          Check if incremental load and mid-tier hashing has been enabled for this node.
static boolean isMultiTenant(SDViewNode node)
          Check if node is multi-tenant aware.
static boolean isMultiTenantPropsDefined(SDViewNode node)
          Checks if MTS is being enabled via custom properties.
static java.lang.String isNoDynamicExtRefs(SDViewNode node)
          gets the no dynamic ext refs property value for a given SDViewNode
static boolean isNonAppsModel(oracle.jbo.ApplicationModule am)
           
static boolean isTranslationIncrLoad(SDViewNode node)
          Translation incremental load property.
static java.lang.String isUseADFForNLSUpload(SDViewNode node)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDecodedHint

public static java.lang.String getDecodedHint(java.lang.String key,
                                              oracle.jbo.Properties props)
Method decodes a UTF-8 encoded string property.

Parameters:
key - property key
props - Object implementing the Properties interface
Returns:
The decoded value of the property corresponding to the key

getIdentifierKey

public static java.lang.String getIdentifierKey(java.lang.String baseKey,
                                                SDViewNode node)
Method returns the transformed based key that identifies the driver view.

Parameters:
baseKey - base key
node - View node
Returns:
actual key

getFragment

public static java.lang.String getFragment(java.lang.String str,
                                           int fragmentIndex)
String utility that splits the passed str on the character period and returns the fragment identified by the fragmentIndex. The fragmentIndex is zero based. If the fragmentIndex is less than 0, the last fragment is returned. If fragmentIndex value is greater than the the number of fragments -1, an empty string is returned.

Parameters:
str - String to be split.
fragmentIndex - index of fragment
Returns:
fragment

getPropertiesWithPrefix

public static java.util.Map<java.lang.String,java.lang.String> getPropertiesWithPrefix(oracle.jbo.ApplicationModule am,
                                                                                       java.lang.String prefix)
Method returns the map of properties that have keys that start with prefix.

Parameters:
am - Seed Application Module
prefix - prefix of the keys
Returns:
map of properties

getHandlerType

public static java.lang.String getHandlerType(SDViewNode node)
Method returns the upload handler type. If the type has not been defined or the defined type is not recognized, the default handler is returned. Valid return types are SDConstants.HANDLER_DEFAULT and SDConstants.HANDLER_BULK.

Returns:
handler type

getHandlerContext

public static java.lang.String getHandlerContext(SDViewNode node)

getStagingTableName

public static java.lang.String getStagingTableName(SDViewNode node)
Method returns the staging table name for the ViewNode if the upload mode is bulk mode. Else returns an empty string.

Returns:
staging table name.

getAlternateKeyName

public static java.lang.String getAlternateKeyName(SDViewNode node)
Method returns the Alternate Key name for this ViewNode if this property is declared. Else returns null. Maintains backward compatibility with old style of lookup, ie with vo def name.

Returns:
Alternate key name

getCVN

public static java.lang.String getCVN(SDViewNode node)
Method returns the Config Version Number (CVN) for this ViewNode.

Returns:
String CVN

getExclusionLinkList

public static java.util.List<java.lang.String> getExclusionLinkList(SDViewNode node)
Return the list of links from given node that are to be excluded from extract/upload. See Bug 7558445.

Parameters:
node - SDViewNode
Returns:
List of view link names to exclude from extract/upload, empty string when none

getLOVExclusionList

public static java.util.List<java.lang.String> getLOVExclusionList(SDViewNode node)
return the list of LOV's from a given node that are to be excluded from extract/upload

Parameters:
node - SDViewNode
Returns:
List of LOV names to be exluced from extract/uolaod, empty list when none

getAttrExclusionList

public static java.util.List<java.lang.String> getAttrExclusionList(SDViewNode node)
Get list of attribute names for the node that are to be excluded from extract. See Bug 10098768.

Parameters:
node - SDViewNode
Returns:
List of attribute names to exclude for the give node, empty if none

getRefVAList

public static java.util.List<java.lang.String> getRefVAList(SDViewNode node)
Return the list of View Accesor's (VA's) that should be used for external reference processing if the are used in a LOV

Parameters:
node -
Returns:

getVAPVOMaping

public static java.util.Map<java.lang.String,java.lang.String> getVAPVOMaping(SDViewNode node)
VA TO PVO Mapping format; VA:PVO,VA:PVO

Parameters:
node -
Returns:
Map

getPVOToInstanceMapping

public static java.util.Map<java.lang.String,java.lang.String> getPVOToInstanceMapping(oracle.jbo.ApplicationModule am)
PVO To Instance MAp in the Am

Parameters:
am -
Returns:
Map

getHandlerText

public static java.lang.String getHandlerText(SDViewNode node)
Method returns the appropriate handler for upload types bulk and custom.

Returns:
handler text

isDraft

public static boolean isDraft(SDViewNode node)
Method returns true if the Application Module is in draft status.

Returns:
true if status is draft

getReferenceAMName

public static java.lang.String getReferenceAMName(oracle.jbo.ApplicationModule srcAM,
                                                  java.lang.String driverName,
                                                  java.lang.String viewName)
Get the ReferenceAM property from the named AM for the named driver/child view.

Parameters:
srcAM - ApplicationModule containing the properties
driverName - String driver name
viewName - String child view name
Returns:
String full path reference AM defn name for the named driver child node, null when none

getSurrogate

public static java.lang.String getSurrogate(SDViewNode node)
Get the Surrogate Id property value. Maintains backward compatibility with old style of lookup, ie with vo def name.

Parameters:
node - SDViewNode containing surrogate property to check
Returns:
surrogate id value, null when none

getExclusiveExtractVOName

public static java.lang.String getExclusiveExtractVOName(oracle.jbo.ApplicationModule am,
                                                         java.lang.String voName)
Get the Exclusive Extract VO name property value.

Parameters:
am - ApplicationModule containing properties
voName - driver VO name to build the key
Returns:
String exclusive extract vo name, null when none

getExclusiveExtractPartitionKey

public static java.lang.String getExclusiveExtractPartitionKey(oracle.jbo.ApplicationModule am)
Get the partition key to use for the Exclusive extract mode.

Parameters:
am - ApplicationModule containing properties
Returns:
partition key attribute name, or null when none

getTransientAttrExtractList

public static java.util.List<java.lang.String> getTransientAttrExtractList(SDViewNode node)
Get the list of attributes for the given node that should be extracted, regardless of the Transient or Derived properties. See Bug 8304581.

Parameters:
node - SDViewNode
Returns:
List of String Attribute names for the current node that should always be extracted, null if none

isMultiTenant

public static boolean isMultiTenant(SDViewNode node)
Check if node is multi-tenant aware. Property value either set for the VO Defn name or instance name. If property not set, check for existence of default mts columns.

Parameters:
node - SDViewNode to check for MTS aware
Returns:
true when node is MTS aware

getMultiTenantColumnName

public static java.lang.String getMultiTenantColumnName(SDViewNode node)
Get the multi-tenant enterprise id column name. Log warning when column name property set, but does not exist.

Parameters:
node - SDViewNode
Returns:
MTS enterprise column name, null if none

isMultiTenantPropsDefined

public static boolean isMultiTenantPropsDefined(SDViewNode node)
Checks if MTS is being enabled via custom properties. This can be used to distinguish applcore style of MTS enablement from HCM's.

Parameters:
node -
Returns:
true if MTS is being enabled via custom properties

getExtRefsList

public static java.util.List<java.lang.String> getExtRefsList(SDViewNode node)
Get list of static external references defined for this node.

Parameters:
node - SDViewNode
Returns:
List of static external references, empty list when none

isNonAppsModel

public static boolean isNonAppsModel(oracle.jbo.ApplicationModule am)

getConnectByClause

public static java.lang.String getConnectByClause(SDViewNode node)
gets the connect by clause defined for a given SDViewNode

Parameters:
node -
Returns:
String

isNoDynamicExtRefs

public static java.lang.String isNoDynamicExtRefs(SDViewNode node)
gets the no dynamic ext refs property value for a given SDViewNode

Parameters:
node - SDViewNode on which the property value is requried
Returns:
String

getChildOrder

public static java.util.List<java.lang.String> getChildOrder(SDViewNode node)
Return any pre-defined child ordering for the given node, as ordered list. See Bug 9413051.

Parameters:
node - SDViewNode parent node to check for any child ordering
Returns:
List of String node instance names to determine child ordering, empty string when none

getCommitSize

public static final java.lang.Integer getCommitSize(SDViewNode node)
Return any custom commit size value set for passed node. See Bug 9619908.

Parameters:
node - SDViewNode
Returns:
commit size as Integer value, null if not set or if an invalid non-numeric value

getSeedChangeIndicator

public static java.lang.String getSeedChangeIndicator(SDViewNode node)
Return the name of the seed data change indicator attribute. Used for database based hashing.

Parameters:
node - SDViewNode
Returns:
name of the seed data change indicator attribute or null if none defined.

isIncrMidTier

public static boolean isIncrMidTier(SDViewNode node)
Check if incremental load and mid-tier hashing has been enabled for this node.

Parameters:
node - SDViewNode, should be the root driver node
Returns:
True when incremental loading and mid-tier hash calculation

isTranslationIncrLoad

public static boolean isTranslationIncrLoad(SDViewNode node)
Translation incremental load property.

Parameters:
node - SDViewNode
Returns:
true when translation incremental load is enabled for this node

isUseADFForNLSUpload

public static java.lang.String isUseADFForNLSUpload(SDViewNode node)
Parameters:
node - SDViewNode
Returns:
the boolean proeprty value of

isBulkValidate

public static boolean isBulkValidate(SDViewNode node)

getIgnoreRefDataValidationList

public static java.util.List<java.lang.String> getIgnoreRefDataValidationList(SDViewNode node)

Oracle Fusion Middleware extensions for Seed Data Framework
11g Release 1 (11.1.2)

E22564-02

Copyright © 2011 Oracle. All Rights Reserved.