oracle.adf.model.binding

Class DCExecutableBindingDef

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.adf.model.binding.DCDefBase

oracle.adf.model.binding.DCExecutableBindingDef

All Implemented Interfaces:

DCIExecutableDef, DiffMergeable, DefPersistable, PersistentDefinition

Direct Known Subclasses:

DCBindingContainerDef, DCBindingContainerReference, DCInvokeActionDef, DCIteratorBindingDef

public abstract class DCExecutableBindingDef
extends DCDefBase
implements DCIExecutableDef

Nested Class Summary

Nested classes/interfaces inherited from class oracle.jbo.mom.PersistableDefObject

PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PNAME_attrHintsSuffix
static java.lang.String	PNAME_option
static java.lang.String	PNAME_option_ALWAYS
static java.lang.String	PNAME_option_DEFAULT
static java.lang.String	PNAME_option_DEFER
static java.lang.String	PNAME_option_IF_NEEDED
static java.lang.String	PNAME_option_NEVER
static java.lang.String	PNAME_option_PREPARE
static java.lang.String	PNAME_option_PREPARE_OPT
static java.lang.String	PNAME_option_REFRESH
static java.lang.String	PNAME_option_REFRESH_OPT
static java.lang.String	PNAME_option_RENDER
static java.lang.String	PNAME_option_RENDER_OPT
static java.lang.String	PNAME_optionExpr
static java.lang.String	PNAME_refreshAfter
static int	RC_ALWAYS
static int	RC_DEFAULT
static int	RC_DEFER
static int	RC_NEVER
static int	RC_PREPARE
static int	RC_PREPARE_OPT
static int	RC_REFRESH
static int	RC_REFRESH_OPT
static int	RC_RENDER
static int	RC_RENDER_OPT
static int	RC_UNINIT

Fields inherited from class oracle.adf.model.binding.DCDefBase

DEF_XMLNS, DEF_XMLNS_BASE, EMPTY_STR, PNAME_AccessorIterator, PNAME_Action, PNAME_Boolean, PNAME_Button, PNAME_ButtonGroup, PNAME_Calendar, PNAME_ComboBox, PNAME_ComboBoxLovEdit, PNAME_DataControlAction, PNAME_DefaultControl, PNAME_DynamicTable, PNAME_EnumList, PNAME_EventBinding, PNAME_EventEnabled, PNAME_EventEnabled_NONE, PNAME_EventEnabled_PPR, PNAME_EventEnabled_PUSH, PNAME_FormattedTextField, PNAME_Graph, PNAME_HGrid, PNAME_Iterator, PNAME_Label, PNAME_ListSingleSel, PNAME_LovButton, PNAME_LOVList, PNAME_MethodAction, PNAME_MethodIterator, PNAME_NavigationBar, PNAME_NavigationList, PNAME_Panel, PNAME_Parameter, PNAME_Permission, PNAME_ProgressBar, PNAME_ProgressBarAttr, PNAME_Query, PNAME_Range, PNAME_ScrollBar, PNAME_ScrollBarAttr, PNAME_Search, PNAME_Shuttle, PNAME_Slider, PNAME_SliderAttr, PNAME_Spinner, PNAME_Table, PNAME_TextField, PNAME_ToplinkIterator, PNAME_Tree, PNAME_TreeTable

Fields inherited from class oracle.jbo.mom.PersistableDefObject

mEditedProperties, mEditedPropertyExprs

Fields inherited from class oracle.jbo.mom.DefinitionObject

DEF_MDS_CLIENT_KEY, DEF_SCOPE_ALL, DEF_SCOPE_PERS, DEF_SCOPE_SESSION, DEF_SCOPE_SHARED, DEF_SCOPE_SITE, DEF_SCOPE_USER, mBaseDefObject, mExtendedDefObjects, mObjectResolved, PERSDEF_MDS_CLIENT_KEY, PROPERTY_EXPRMAP

Fields inherited from class oracle.jbo.common.NamedObjectImpl

mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIX

Fields inherited from interface oracle.adf.model.binding.DCIExecutableDef

EXECUTABLE_ACTION, EXECUTABLE_ITERATORBINDING, EXECUTABLE_REGION

Fields inherited from interface oracle.jbo.mom.xml.DefPersistable

XML_STATEMENT

Constructor Summary

Constructors

Constructor and Description
DCExecutableBindingDef()
DCExecutableBindingDef(java.lang.String name) Internal: Applications should not use this method.

Method Summary

Modifier and Type	Method and Description
void	applyDiffChildren(DifferDetails dif, DiffResolver resolver) Applies changes to children defs.
void	applyDiffContents(DifferDetails dif, DiffResolver resolver) When diff/merge operation is requested, we have the following three def objects:
abstract java.lang.Object	createExecutableBinding(BindingContext ctx, DCBindingContainer ctr) Create an executable binding instance based on this definition in the given BindingContainer.
DifferDetails	diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of scalar values.
protected java.lang.String[]	getDependencyNames()
abstract int	getExecutableType() Return EXECUTABLE_REGION, EXECUTABLE_ITERATORBINDING or EXECUTABLE_ACTION based on what kind of binding this definition creates.
protected java.lang.String	getHintsSuffix()
protected java.lang.String	getPermissionClassName() Internal: Applications should not use this method.
protected java.lang.String	getPermissionTargetName() Internal: Applications should not use this method.
java.lang.String	getRefreshExpression()
int	getRefreshOption()
protected int	getRefreshOptionValue() Internal: Applications should not use this method.
java.lang.String	getXMLElementTag() Returns a piece of static info for the type of object this is invoked upon.
void	init(java.util.HashMap initValues) Internal: Applications should not use this method.
void	initializeExecutableBinding(BindingContext ctx, DCBindingContainer bindingContainer, java.lang.Object binding) Internal: Applications should not use this method.
static int	internalGetRefreshOptionFromString(java.lang.String str) *** For internal framework use only ***
protected boolean	internalHasPermission(DCBindingContainer ctr) Internal: Applications should not use this method.
boolean	isRefreshable(DCBindingContainer ctr, DCIExecutable exec, int refreshFlag) Internal: Applications should not use this method.
protected boolean	isRefreshable(DCBindingContainer ctr, DCIExecutable exec, int refreshFlag, boolean refreshDeferredOnCondition)
protected void	retrieveFromXML(DefElement xmlElement, java.util.HashMap valueTab) Internal: Applications should not use this method.

Methods inherited from class oracle.adf.model.binding.DCDefBase

convertToBoolean, convertToDataChangePolicy, convertToInt, convertToIntArray, convertToLong, createAndLoadFromXML, getDefClassName, getDefTypeId, getDefXMLNameSpace, getOrigObject, getPermissionDef, getPersonalizer, getPersonalizerClass, getSubType, initSubType, isDirty, isNew, loadChildrenFromXML, loadFromXML, loadPermissionDef, loadXMLContents, readXMLBoolean, readXMLInt, readXMLLong, readXMLString, readXMLStringArray, readXMLStringArrayList, readXMLStringArrayList, saveXMLContents, setDefClassName, setDirty, setNew, setOrigObject, setPermissionDef, setSubType, setupDefWriterFromMO, writeXMLContents

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addDefImport, addExtendedDefObject, addSavedDocName, adjustPropertyMapForWrite, allocatePropertyMap, allocatePropertyMapForEdits, beginDiffObjects, checkEditable, checkStructWithOld, close, createFromXML, deregisterDefObject, deregisterSessionObject, diffChildren, diffObjects, ensureDifferDetails, findDefImport, finishedLoading, getBaseDir, getBasePackage, getDefImports, getDefManager, getDefTypeName, getDefWriter, getDefXMLElementTag, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getEditVersionsAsString, getExtendedDefObjectsInternal, getFileName, getFullDirName, getFullFileName, getMajorVersion, getMergeableFullName, getMergeableName, getMinorVersion, getPropertyMap, getSavedDocNames, getSessionSyncLock, getSubstitutedNames, getSyncLock, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isCustomizationEnabled, isCustomizationEnabled, isEditable, isFromTip, isLoadBase, isMajorVersionChanged, isMinorVersionChanged, isPersonalizationEnabled, isPersonalizationEnabled, isPropertyExpression, loadDefImports, loadDefObject, loadXMLContentsNoResolve, lockDefinitionContext, mergeChanges, mergePropertyMap, objectRemoved, reapplyChanges, registerClass, registerDefObject, registerSessionDefObject, registerSiteDefObject, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setEditable, setEditableFlag, setEditableObject, setFullName, setFullNameInternal, setLoadBase, setMajorVersionChanged, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, staticUpdateChildrenList, unlockDefinitionContext, updateChildrenList, updateMdsKeyFromTip, verifyVersion, verifyVersionNullCheck, writeChildren, writeContents, writeHeaderForNew, writeObject, writeVersion

Methods inherited from class oracle.jbo.mom.DefinitionObject

addPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getBaseDefObject, getContainerDef, getContainerName, getDefinitionState, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, getRootBaseDefObject, isBaseDefFor, isComponentDefinition, isDeprecated, isDynamicDefinitionObject, isObjectResolved, isSubtypeOf, isSuppressUpdateCheck, loadCustomProperties, loadProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, resolveReferences, setBaseDefObject, setBaseDefObject, setDefScope, setMdsKey, setMdsReference, setName, setObjectResolved, setParent, setPropertySetName, staticLoadCustomProperties, staticLoadSchemaProperties, suppressUpdateCheck

Methods inherited from class oracle.jbo.common.NamedObjectImpl

getAllProperties, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionDef, getPropertyExpressionsMap, getPropertyNamesSet, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, resolvePropertyRaw, setPropertiesMap, setPropertiesMap2, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.adf.model.binding.DCIExecutableDef

getName

Methods inherited from interface oracle.jbo.mom.xml.DefPersistable

getFullName

Field Detail

PNAME_option

public static final java.lang.String PNAME_option

See Also:

Constant Field Values

PNAME_optionExpr

public static final java.lang.String PNAME_optionExpr

See Also:

Constant Field Values

PNAME_option_DEFAULT

public static final java.lang.String PNAME_option_DEFAULT

See Also:

Constant Field Values

PNAME_option_IF_NEEDED

public static final java.lang.String PNAME_option_IF_NEEDED

See Also:

Constant Field Values

PNAME_option_PREPARE

public static final java.lang.String PNAME_option_PREPARE

See Also:

Constant Field Values

PNAME_option_RENDER

public static final java.lang.String PNAME_option_RENDER

See Also:

Constant Field Values

PNAME_option_PREPARE_OPT

public static final java.lang.String PNAME_option_PREPARE_OPT

See Also:

Constant Field Values

PNAME_option_RENDER_OPT

public static final java.lang.String PNAME_option_RENDER_OPT

See Also:

Constant Field Values

PNAME_option_ALWAYS

public static final java.lang.String PNAME_option_ALWAYS

See Also:

Constant Field Values

PNAME_option_DEFER

public static final java.lang.String PNAME_option_DEFER

See Also:

Constant Field Values

PNAME_option_NEVER

public static final java.lang.String PNAME_option_NEVER

See Also:

Constant Field Values

PNAME_refreshAfter

public static final java.lang.String PNAME_refreshAfter

See Also:

Constant Field Values

PNAME_attrHintsSuffix

public static final java.lang.String PNAME_attrHintsSuffix

See Also:

Constant Field Values

PNAME_option_REFRESH_OPT

public static final java.lang.String PNAME_option_REFRESH_OPT

See Also:

Constant Field Values

PNAME_option_REFRESH

public static final java.lang.String PNAME_option_REFRESH

See Also:

Constant Field Values

RC_UNINIT

public static final int RC_UNINIT

See Also:

Constant Field Values

RC_DEFAULT

public static final int RC_DEFAULT

See Also:

Constant Field Values

RC_PREPARE

public static final int RC_PREPARE

See Also:

Constant Field Values

RC_PREPARE_OPT

public static final int RC_PREPARE_OPT

See Also:

Constant Field Values

RC_RENDER

public static final int RC_RENDER

See Also:

Constant Field Values

RC_RENDER_OPT

public static final int RC_RENDER_OPT

See Also:

Constant Field Values

RC_ALWAYS

public static final int RC_ALWAYS

See Also:

Constant Field Values

RC_NEVER

public static final int RC_NEVER

See Also:

Constant Field Values

RC_DEFER

public static final int RC_DEFER

See Also:

Constant Field Values

RC_REFRESH

public static final int RC_REFRESH

See Also:

Constant Field Values

RC_REFRESH_OPT

public static final int RC_REFRESH_OPT

See Also:

Constant Field Values

Constructor Detail

DCExecutableBindingDef

public DCExecutableBindingDef()

DCExecutableBindingDef

public DCExecutableBindingDef(java.lang.String name)

Internal: Applications should not use this method.

Method Detail

init

public void init(java.util.HashMap initValues)

Internal: Applications should not use this method.

Overrides:

init in class DCDefBase

getRefreshOptionValue

protected int getRefreshOptionValue()

Internal: Applications should not use this method.

getRefreshOption

public final int getRefreshOption()

Specified by:

getRefreshOption in interface DCIExecutableDef

getRefreshExpression

public final java.lang.String getRefreshExpression()

Specified by:

getRefreshExpression in interface DCIExecutableDef

internalGetRefreshOptionFromString

public static int internalGetRefreshOptionFromString(java.lang.String str)

*** For internal framework use only ***

getXMLElementTag

public java.lang.String getXMLElementTag()

Description copied from interface: PersistentDefinition

Returns a piece of static info for the type of object this is invoked upon. Examples are PreparedStatements for insert, update, delete, and String containing a base the select statement for retrieving instances of this type through the SQLInputStream

Specified by:

getXMLElementTag in interface PersistentDefinition

Specified by:

getXMLElementTag in class DCDefBase

Returns:

returns the Statement required to store in Persitent Storage. Incase of XML, it just returns the String. In the case of SQL a JDBC PreparedStatement is returned.

retrieveFromXML

protected void retrieveFromXML(DefElement xmlElement,
                               java.util.HashMap valueTab)

Internal: Applications should not use this method.

Overrides:

retrieveFromXML in class DCDefBase

getDependencyNames

protected java.lang.String[] getDependencyNames()

getExecutableType

public abstract int getExecutableType()

Description copied from interface: DCIExecutableDef

Return EXECUTABLE_REGION, EXECUTABLE_ITERATORBINDING or EXECUTABLE_ACTION based on what kind of binding this definition creates.

Specified by:

getExecutableType in interface DCIExecutableDef

createExecutableBinding

public abstract java.lang.Object createExecutableBinding(BindingContext ctx,
                                                         DCBindingContainer ctr)

Description copied from interface: DCIExecutableDef

Create an executable binding instance based on this definition in the given BindingContainer.

Specified by:

createExecutableBinding in interface DCIExecutableDef

initializeExecutableBinding

public void initializeExecutableBinding(BindingContext ctx,
                                        DCBindingContainer bindingContainer,
                                        java.lang.Object binding)

Internal: Applications should not use this method.

Specified by:

initializeExecutableBinding in interface DCIExecutableDef

isRefreshable

public boolean isRefreshable(DCBindingContainer ctr,
                             DCIExecutable exec,
                             int refreshFlag)

Internal: Applications should not use this method.

Specified by:

isRefreshable in interface DCIExecutableDef

isRefreshable

protected boolean isRefreshable(DCBindingContainer ctr,
                                DCIExecutable exec,
                                int refreshFlag,
                                boolean refreshDeferredOnCondition)

internalHasPermission

protected boolean internalHasPermission(DCBindingContainer ctr)

Internal: Applications should not use this method.

getPermissionTargetName

protected java.lang.String getPermissionTargetName()

Internal: Applications should not use this method.

getPermissionClassName

protected java.lang.String getPermissionClassName()

Internal: Applications should not use this method.

getHintsSuffix

protected java.lang.String getHintsSuffix()

diffContents

public DifferDetails diffContents(DiffMergeable docDef,
                                  DiffMergeable orgDef,
                                  DifferDetails difDetails)

Description copied from interface: DiffMergeable

Performs diff of scalar values. Typically, scalar attr values are grouped into String, int, and boolean arrays -- one set coming from 'this' definition and the other set coming from orgDef. Then, help methods on DifferBase can be used to diff the attr values and accumulate the details of diff in difDetails.

Here is example code snippet:

    private static final String DIFF_STRING_ELEMS[] =
    {
       "MyStringVal1",
       "MyStringVal2"
    };

    private static final String DIFF_INT_ELEMS[] =
    {
       "MyIntVal",
    }

    public DifferDetails diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
        orgDefImpl = () orgDef;

       final String editStringValues[] =
       {
          this.getMyStringVal1(),
          this.getMyStringVal2()
       };

       String orgStringValues[] = null;

       if (orgDef != null)
       {
          String orgV[] =
          {
             orgDefImpl.getMyStringVal1(),
             orgDefImpl.getMyStringVal2()
          };

          orgStringValues = orgV;
       }

       final int editIntValues[] =
       {
          this.getMyIntVal(),
       };

       int orgIntValues[] = null;

       if (orgDef != null)
       {
          int orgV[] =
          {
             orgDefImpl.getMyIntVal()
          };

          orgIntValues = orgV;
       }

       difDetails = DifferBase.diffStringArray(this, DIFF_STRING_ELEMS, editStringValues, orgStringValues, difDetails);
       difDetails = DifferBase.diffIntArray(this, DIFF_INT_ELEMS, editIntValues, orgIntValues, difDetails);

       return difDetails;
   }
 

Specified by:

diffContents in interface DiffMergeable

Overrides:

diffContents in class PersistableDefObject

Parameters:

docDef - the document-level definition

orgDef - the original definition. It could be null if the definition did not exist originally

difDetails - the DifferDetails that accumulate the details of diff from the document-level (top-level) def

Returns:

the DifferDetails that has all the details of diff

applyDiffContents

public void applyDiffContents(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

When diff/merge operation is requested, we have the following three def objects:

orgDef - original def object (from the branch point) editDef - def object into which changes are to be merge toMergeDef - def object to be merged (source of changes) For sandbox refresh operation, orgDef comes from the branch point, editDef from the sandbox, toMergeDef from the mainline of the repos. With these three defs, we first diff editDef against orgDef, producing editDifDetails.

Similarly, toMergeDef is diffed against orgDef, producing toMergeDifDetails. The diff engine then walks through these two sets of diffs and identifies conflicts. After the conflicts are all resolved, we apply appropriate changes to editDef.

applyDiffContents is called to apply changes to scalar values. dif contains the changed values to be applied to 'this' object. Use sample code like the following:

    public void applyDiffContents(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();
       Object[] updValues;

       // DIFF_STRING_ELEMS from the above example code
       for (int j = 0; j < DIFF_STRING_ELEMS.length; j++)
       {
          if ((updValues = (Object[]) detailMap.getValue(DIFF_STRING_ELEMS[j])) != null)
          {
             switch(j)
             {
             case 0:
                setMyStringVal1((String) updValues[0]);
                break;
             case 1:
                 setMyStringVal2((String) updValues[0]);
                break;
             }
          }
       }

       for (int j = 0; j < DIFF_INT_ELEMS.length; j++)
       {
          if ((updValues = (Object[]) detailMap.getValue(DIFF_INT_ELEMS[j])) != null)
          {
             switch(j)
             {
             case 0:
                setMyIntVal((Integer) updValues[0]);
                break;
             }
          }
       }
    }
 

Notice that the index specified in the case statement is the array index of the attr in the String, int, or boolean array.

Specified by:

applyDiffContents in interface DiffMergeable

Overrides:

applyDiffContents in class PersistableDefObject

Parameters:

dif - changes to be applied to 'this' def

resolver - the diff resolver used in diff/merge operation

applyDiffChildren

public void applyDiffChildren(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

Applies changes to children defs. dif contains the changes to be applied to the children. For each child def, this method should first retrieve the diff details for the child, which is of type DifferChildren. Then, it should call DifferChildren.applyDiffChanges(oracle.jbo.mom.DiffChildrenMerge, oracle.jbo.mom.DiffResolver) to perform the change operation.

applyChanges() requires a DiffChildrenMerge object, which has the insert, update, and remove methods. 'this' def object must provide implmementation of these operations.

Here is a sample:

    public void applyDiffChildren(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();

       if (detailMap != null)
       {
          DifferChildren difChild1 = (DifferChildren) detailMap.getValue();

          if (difVCs != null)
          {
             DiffChildrenMerge dm = new DiffChildrenMerge()
             {
                public void insertChild(Object id, Object value)
                {
                   .. perform insert op for Child1 ..
                }

                public void updateChild(Object id, Object value, Object oldValue)
                {
                   .. perform update op for Child1 ..
                }

                public void removeChild(Object id)
                {
                   .. perform remove op for Child1 ..
                }
             };

             difChild1.applyDiffChanges(dm, resolver);
          }

          // Similarly for Child2
       }
    }
 

Specified by:

applyDiffChildren in interface DiffMergeable

Overrides:

applyDiffChildren in class PersistableDefObject