oracle.apps.fnd.applseed.rt.extract.common
Class ExtractProperties

java.lang.Object
  oracle.apps.fnd.applseed.rt.extract.common.ExtractProperties

public class ExtractProperties
extends java.lang.Object

This singleton class holds the Extract property name value pairs, and accessor methods to retrieve the property values. Initialized from seedArgsMap values as set from command line or api calls.

 seedArgsMap(String key, Object value) entries:
 Key               Value Object type      Value
 ----------------- ---------------------- ------------------------------------
 CRITERIA_NAMES    ArrayList(String)      List of Driver VO ViewCriteria names
                                          to apply at Extract runtime.
 BIND_VARIABLES    HashMap(String,String) Map of ViewCriteria BindVaribles
                                          name=value pairs to set at runtime.
 ROOT_PATH         String                 String root extract path where
                                          extract files will be generated.
 PROCESS_MODE      ExtractProcessMode or  enum process mode
                   String                 process mode value
 PARTITION_KEY_VALUES PartitionKeyMap     Map of partition key values to
                                          define the extract file partitioning
                                          (built and passed from Seed Console GUI)
 PARTITION_KEYIDS  ArrayList(String)      List of partition Id values,
                                          moduleId or applicationId, passed
                                          from cmd line properties.
 PARTITION_KEYNAMES ArrayList(String)     List of partition key name values,
                                          App or LBA type, eg FND, passed
                                          from cmd line properties.
 LANGUAGE_CODES    String[]               Array of Language Codes in Oracle
                                          DB format, eg US, ES, FR, etc
 

Field Summary

static java.lang.String	AM_PROP Public Property: The Application Module used for Extract.
static java.lang.String	DRIVER_VONAME_PROP Public Property: The Driver View Object Name used for Extract.

Method Summary

oracle.jbo.ApplicationModule	getAM() Get ApplicationModule property.
java.util.Map<java.lang.String,java.lang.String>	getBindVariables() Get Bind Variables property.
java.util.List<java.lang.String>	getCriteriaNames() Get Criteria Names property.
java.util.List<java.lang.String>	getCriteriaNamesList() Convienence method to get CriteriaNames property as empty list when none.
oracle.jbo.ViewCriteria[]	getCriteriaObjects() Get dynamic ViewCriteria objects as an arrary of ViewCriteria.
java.util.List<oracle.jbo.ViewCriteria>	getCriteriaObjectsList() Convienence mehtod to get dynamic ViewCriteria objects as list.
PartitionHelper	getDriverPartitionHelper() Get the PartitionHelper instance for the driver node.
SDExtractViewNode	getDriverViewNode() Get Driver SDExtractViewNode property.
oracle.jbo.ViewObject	getDriverVO() Get the driver view node View Object.
oracle.jbo.server.ViewObjectImpl	getDriverVOImpl() Get the driver view node view object as ViewObjectImpl.
java.lang.String	getDriverVOName() Get DriverVOName property.
java.lang.String	getEnterpriseId() Get the Enterprise Id value.
SDExtractViewNode	getExclusiveExtractNode() Get the Exclusive Extract node property value.
static ExtractProperties	getInstance() Get the ExtractProperties instance, assumes already initialized.
java.lang.String	getJBOVersion() Get the JBO runtime version string.
oracle.jbo.ViewObject	getPartitioningVO() Get the view object that serves as the partitioning node.
oracle.jbo.server.ViewObjectImpl	getPartitioningVOImpl() Get the view object impl that serves as the partitioning node.
java.lang.String	getPartitionKeyAttribName() Get the Partition Key Attribute Name, eg ModuleId, or ApplicationId.
java.util.Collection<java.lang.String>	getPartitionKeyValues() Get the Partition key ID values property as collection of Strings.
PartitionKeyMap	getPartitionKeyValuesMap() Get the Partition key values property as Map of values.
ExtractProcessMode	getProcessMode() Get Extract Process Mode property.
static ExtractProcessMode	getProcessModeProperty(java.lang.String entry) Get the ExtractProcessMode property from the properties.
java.lang.String	getRootPath() Get Root Path property.
java.lang.String	getSDFFileFmtVersion() Get the SDF File format version.
java.lang.String	getSDFVersion() Get the SDF version, that is ATGPF label at SDF compile time.
java.lang.String[]	getSelectedLanguages() Get the selected languages as String array of language codes, eg {"US", "FR", "ES",...}.
boolean	hasUserBindVariables() Determine if user bind variables used.
boolean	hasUserCriteria() Determine if user criteria used, either named or dynamic.
SDExtractViewNode	initExclusiveExtractNode() Initialize the Exclusive Extract node, if any.
static ExtractProperties	initialize(java.util.Map seedArgsMapP) Initialize the Extract Properties instance from the passed seedArgsMap.
boolean	isDebugMode() Check if debug mode is set.
boolean	isDevMode() Test for ExtractProcessMode is DevMode
boolean	isExcludeImmutable() In the t2p code path, we need to filter out immutable records.
boolean	isForceSinglePartitioning() Get the boolean flag value for force single partitioning.
boolean	isModelEffectiveDated() Check if the Model contains any effective dated nodes.
boolean	isModelTranslatable() Check if the Model contains any translatable nodes.
boolean	isNoDynamicExtRefs()
boolean	isNonAppsModel()
boolean	isUseADFforNLS()
boolean	isVCSMode() Test for ExtractProcessMode is VCSMode
oracle.jbo.ApplicationModule	setAM(oracle.jbo.ApplicationModule am) Set ApplicationModule property.
PartitionHelper	setDriverPartitionHelper(PartitionHelper partitionHelperInstance) Set the PartitionHelper instance of the driver node.
java.lang.String	setDriverViewName(java.lang.String name) Set Driver View Name
SDExtractViewNode	setDriverViewNode(SDExtractViewNode node) Set Driver view node.
java.lang.String	setEnterpriseId(java.lang.String eid) Set Enterprise Id value
void	setExcludeImmutable(boolean exclude)
java.lang.String	setPartitionKeyAttribName(java.lang.String name) Set the Partition Key Attribute Name, eg ModuleId or Application Id
java.lang.String	toString() Get all the property key names and values as a single String for display, newline delimited.

Methods inherited from class java.lang.Object

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

Field Detail

AM_PROP

public static final java.lang.String AM_PROP

Public Property: The Application Module used for Extract.

See Also:

Constant Field Values

DRIVER_VONAME_PROP

public static final java.lang.String DRIVER_VONAME_PROP

Public Property: The Driver View Object Name used for Extract.

See Also:

Constant Field Values

Method Detail

initialize

public static ExtractProperties initialize(java.util.Map seedArgsMapP)
                                    throws ExtractPropertyException

Initialize the Extract Properties instance from the passed seedArgsMap.

Parameters:

seedArgsMapP - Map of known name value extract params

Returns:

ExtractProperties instance

Throws:

ExtractPropertyException - invalid property

getInstance

public static ExtractProperties getInstance()

Get the ExtractProperties instance, assumes already initialized.

Returns:

ExtractProperties instance reference

Throws:

java.lang.RuntimeException - if not first initialized

toString

public java.lang.String toString()

Get all the property key names and values as a single String for display, newline delimited.

Overrides:

toString in class java.lang.Object

Returns:

String

getAM

public oracle.jbo.ApplicationModule getAM()

Get ApplicationModule property.

Returns:

ApplicationModule

getDriverVOName

public java.lang.String getDriverVOName()

Get DriverVOName property.

Returns:

String

getDriverViewNode

public SDExtractViewNode getDriverViewNode()

Get Driver SDExtractViewNode property.

Returns:

SDExtractViewNode

getProcessMode

public ExtractProcessMode getProcessMode()

Get Extract Process Mode property.

Returns:

ExtractProcessMode

getCriteriaNames

public java.util.List<java.lang.String> getCriteriaNames()

Get Criteria Names property. This is the list of user specified criteria names from the vo. List may be altered by caller to remove invalid names.

Returns:

List of Strings, null List if none

getCriteriaNamesList

public java.util.List<java.lang.String> getCriteriaNamesList()

Convienence method to get CriteriaNames property as empty list when none.

Returns:

CriteriaNames list of Strings, empty list when none

getCriteriaObjects

public oracle.jbo.ViewCriteria[] getCriteriaObjects()

Get dynamic ViewCriteria objects as an arrary of ViewCriteria.

Returns:

ViewCriteria array, null when none

getCriteriaObjectsList

public java.util.List<oracle.jbo.ViewCriteria> getCriteriaObjectsList()

Convienence mehtod to get dynamic ViewCriteria objects as list.

Returns:

List of dynamic ViewCriteria, empty list when none

hasUserCriteria

public boolean hasUserCriteria()

Determine if user criteria used, either named or dynamic.

Returns:

true when user criteria available.

getBindVariables

public java.util.Map<java.lang.String,java.lang.String> getBindVariables()

Get Bind Variables property. This is the list of user specified bind variable name value pairs for each criteria used. List may be altered by caller to remove invalid values.

Returns:

Map of bind name value pairs, null if none

hasUserBindVariables

public boolean hasUserBindVariables()

Determine if user bind variables used.

Returns:

true when user bind variables available.

getPartitionKeyValuesMap

public PartitionKeyMap getPartitionKeyValuesMap()

Get the Partition key values property as Map of values. This is the list of partition key values to use to define the extract file partitions, selected on the Console, or specified by user via command line.

Returns:

PartitionKeyMap of partition key values

getPartitionKeyValues

public java.util.Collection<java.lang.String> getPartitionKeyValues()

Get the Partition key ID values property as collection of Strings. This is the list of partition key values to use to define the extract file partitions, selected on the Console, or specified by user via command line.

Returns:

Collection of Strings of partition key ID values

getRootPath

public java.lang.String getRootPath()

Get Root Path property.

Returns:

String

getSelectedLanguages

public java.lang.String[] getSelectedLanguages()

Get the selected languages as String array of language codes, eg {"US", "FR", "ES",...}. Always includes at least base lang, eg US. Default to return "US" when not set.

Returns:

String[] language codes

getPartitionKeyAttribName

public java.lang.String getPartitionKeyAttribName()

Get the Partition Key Attribute Name, eg ModuleId, or ApplicationId.

Returns:

String Partition Key Attribute Name

getExclusiveExtractNode

public SDExtractViewNode getExclusiveExtractNode()

Get the Exclusive Extract node property value. See Bug 7276442.

Returns:

SDExtractViewNode node to be used for exclusive extract, null if none

getDriverPartitionHelper

public PartitionHelper getDriverPartitionHelper()

Get the PartitionHelper instance for the driver node.

Returns:

PartitionHelper for driver node

getEnterpriseId

public java.lang.String getEnterpriseId()

Get the Enterprise Id value.

Returns:

String eid value, default value when not initially set.

isExcludeImmutable

public boolean isExcludeImmutable()

In the t2p code path, we need to filter out immutable records.

Returns:

true if we need to filter out immutable records.

getSDFFileFmtVersion

public java.lang.String getSDFFileFmtVersion()

Get the SDF File format version.

Returns:

String file format version number

getSDFVersion

public java.lang.String getSDFVersion()

Get the SDF version, that is ATGPF label at SDF compile time.

Returns:

String

getJBOVersion

public java.lang.String getJBOVersion()

Get the JBO runtime version string.

Returns:

String

isForceSinglePartitioning

public boolean isForceSinglePartitioning()

Get the boolean flag value for force single partitioning.

Returns:

true to force single partitioning

setAM

public oracle.jbo.ApplicationModule setAM(oracle.jbo.ApplicationModule am)

Set ApplicationModule property.

Parameters:

am - ApplicationModule

Returns:

previous value set

setDriverViewNode

public SDExtractViewNode setDriverViewNode(SDExtractViewNode node)

Set Driver view node.

Parameters:

node - SDExtractViewNode

Returns:

previous value set

setDriverViewName

public java.lang.String setDriverViewName(java.lang.String name)

Set Driver View Name

Parameters:

name - String

Returns:

previous value set

setPartitionKeyAttribName

public java.lang.String setPartitionKeyAttribName(java.lang.String name)

Set the Partition Key Attribute Name, eg ModuleId or Application Id

Parameters:

name - String partition key name

Returns:

String previous value

setDriverPartitionHelper

public PartitionHelper setDriverPartitionHelper(PartitionHelper partitionHelperInstance)

Set the PartitionHelper instance of the driver node.

Parameters:

partitionHelperInstance - PartitionHelper

Returns:

PartitionHelper previous value set

setEnterpriseId

public java.lang.String setEnterpriseId(java.lang.String eid)
                                 throws ExtractPropertyException

Set Enterprise Id value

Parameters:

nEid - String value to set

Returns:

String enterprise id value

Throws:

ExtractPropertyException - when not valid numeric value

setExcludeImmutable

public void setExcludeImmutable(boolean exclude)

isVCSMode

public boolean isVCSMode()

Test for ExtractProcessMode is VCSMode

Returns:

true if vcsmode

isDevMode

public boolean isDevMode()

Test for ExtractProcessMode is DevMode

Returns:

true if dev mode

getDriverVO

public oracle.jbo.ViewObject getDriverVO()

Get the driver view node View Object.

Returns:

ViewObject driver

getDriverVOImpl

public oracle.jbo.server.ViewObjectImpl getDriverVOImpl()

Get the driver view node view object as ViewObjectImpl.

Returns:

ViewObjectImpl

initExclusiveExtractNode

public SDExtractViewNode initExclusiveExtractNode()

Initialize the Exclusive Extract node, if any. See Bug 7276442. Assumes the driver node is set, and model initialized.

Returns:

SDExtractViewNode node for exclusive extract, null if none.

isModelTranslatable

public boolean isModelTranslatable()

Check if the Model contains any translatable nodes.

Returns:

true when model is translatable

isModelEffectiveDated

public boolean isModelEffectiveDated()

Check if the Model contains any effective dated nodes.

Returns:

true when model is effective dated

getPartitioningVO

public oracle.jbo.ViewObject getPartitioningVO()

Get the view object that serves as the partitioning node. Normally this is the Driver VO, for Exclusive extract mode, it is the exclusive extract vo.

Returns:

ViewObject that serves as the partitioning node

getPartitioningVOImpl

public oracle.jbo.server.ViewObjectImpl getPartitioningVOImpl()

Get the view object impl that serves as the partitioning node. Normally this is the Driver VO, for Exclusive extract mode, it is the exclusive extract vo.

Returns:

ViewObjectImpl that serves as the partitioning node

isDebugMode

public boolean isDebugMode()

Check if debug mode is set.

Returns:

True when debug mode is on

getProcessModeProperty

public static ExtractProcessMode getProcessModeProperty(java.lang.String entry)

Get the ExtractProcessMode property from the properties.

Parameters:

entry - property map entry value of process mode string

Returns:

ExtractProcessMode, default value if not set in properties

isNonAppsModel

public boolean isNonAppsModel()

Returns:

true if non apps mode property is set

isNoDynamicExtRefs

public boolean isNoDynamicExtRefs()

Returns:

true if no dynamic ext refs property is set

isUseADFforNLS

public boolean isUseADFforNLS()