oracle.jbo.server

Class CodeSourceImpl.MethodSource

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.server.CodeSourceImpl.MethodSource

All Implemented Interfaces:

DiffMergeable, DefPersistable, PersistentDefinition

Enclosing class:

CodeSourceImpl

public class CodeSourceImpl.MethodSource
extends PersistableDefObject
implements DiffMergeable

Nested Class Summary

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

PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType

Field Summary

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.jbo.mom.xml.DefPersistable

XML_STATEMENT

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:
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
DifferDetails	diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of scalar values.
DifferDetails	diffObjects(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) The work-horse method performing diff between two defs of this def type.
DifferDetails	ensureDifferDetails(DifferDetails difDetails) Ensures that we have a valid DifferDetails.
boolean	equals(java.lang.Object other)
java.lang.String	getDefXMLElementTag()
java.lang.String	getDefXMLNameSpace()
java.lang.String	getFullName() Gets this object's fully-qualified name.
java.lang.String	getMergeableFullName() Returns the fully qualified name of the diff-mergeable definition object.
java.lang.String	getMergeableName() Returns the diff-mergeable definition's name (short form).
java.lang.String	getMethodCode()
java.lang.String	getName() Get the name of this object.
java.lang.String	getXMLElementTag() Returns a piece of static info for the type of object this is invoked upon.
void	setCanonicalAnnotation(java.lang.String canonicalAnnotation)
java.lang.String	toString()
void	writeContents(DefWriter jos) Objects should write their persistence output in this method

Methods inherited from class oracle.jbo.mom.PersistableDefObject

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

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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.jbo.mom.DiffMergeable

beginDiffObjects, getDefTypeName

Method Detail

setCanonicalAnnotation

@Concealed
public void setCanonicalAnnotation(java.lang.String canonicalAnnotation)

For internal use only. Application developers should not use this

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Description copied from class: NamedObjectImpl

Get the name of this object.

Overrides:

getName in class NamedObjectImpl

Returns:

the name given to this object.

getFullName

public java.lang.String getFullName()

Description copied from class: NamedObjectImpl

Gets this object's fully-qualified name.

Specified by:

getFullName in interface DefPersistable

Overrides:

getFullName in class NamedObjectImpl

Returns:

this object's fully-qualified name; the package name concatenated with the class name.

getMergeableName

public java.lang.String getMergeableName()

Description copied from interface: DiffMergeable

Returns the diff-mergeable definition's name (short form).

Specified by:

getMergeableName in interface DiffMergeable

Overrides:

getMergeableName in class PersistableDefObject

Returns:

name of the def object

getMergeableFullName

public java.lang.String getMergeableFullName()

Description copied from interface: DiffMergeable

Returns the fully qualified name of the diff-mergeable definition object. It must uniquely identify the def object.

Specified by:

getMergeableFullName in interface DiffMergeable

Overrides:

getMergeableFullName in class PersistableDefObject

Returns:

full name of the def object

getMethodCode

@Concealed
public java.lang.String getMethodCode()

For internal use only. Application developers should not use this

-- testing only

getDefXMLElementTag

@Concealed
public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class PersistableDefObject

For internal use only. Application developers should not use this

getXMLElementTag

@Concealed
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

Overrides:

getXMLElementTag in class PersistableDefObject

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.

For internal use only. Application developers should not use this

getDefXMLNameSpace

@Concealed
public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace in class PersistableDefObject

For internal use only. Application developers should not use this

writeContents

public void writeContents(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeContents in interface PersistentDefinition

Overrides:

writeContents in class PersistableDefObject

Parameters:

jos - the Output storage for persistence

ensureDifferDetails

public DifferDetails ensureDifferDetails(DifferDetails difDetails)

Description copied from interface: DiffMergeable

Ensures that we have a valid DifferDetails.

This method is to create a DifferDetails object to be used for diffing if necessary. The difDetails may come in as null. By calling this method, we can ensure that a non-null difDetails is there. So, instead of writing:

    if (difDetails == null)
    {
       difDetails = new DifferDetails(..);
    }
    difDetails.addDiffDetail(..);
 

we can write

    (difDetails = diffMergeable.ensureDifferDetails(difDetails)).addDiffDetail(..);
 

Specified by:

ensureDifferDetails in interface DiffMergeable

Overrides:

ensureDifferDetails in class PersistableDefObject

Parameters:

difDetails - the incoming DifferDetails. It may be null.

Returns:

the same difDetails if it wasn't null coming in, or a new DifferDetails if the incoming difDetails was null

diffObjects

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

Description copied from interface: DiffMergeable

The work-horse method performing diff between two defs of this def type. Most typically, it will call diffContents to diff scalar values and diffChildren to diff children objects. The children objects themselves are expected to be DiffMergeable. 'this' object is the changed definition.

Specified by:

diffObjects in interface DiffMergeable

Overrides:

diffObjects 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

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

diffChildren

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

Description copied from interface: DiffMergeable

Performs diff of children defs. This def should enumerate through all its children and diff them and accumulate details of diff into difDetails and return it at the end.

For example, if this def has Child1 and Child2, its implementation should look something like:

    public DifferDetails diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);

       return difDetails;
    }
 

where diffChildrenChild1() uses DifferChildren's helper method diffChildrenList to diff the child defs.

Specified by:

diffChildren in interface DiffMergeable

Overrides:

diffChildren 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