public abstract class PDefComponentObjectBase extends PersDefBase implements VariableManagerOwner, ResourceBundleOwner, ComponentOperationsManager
PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationTypeAPPLY_PERS_DEFAULT, APPLY_PERS_PROPS, APPLY_PERS_QUERY, APPLY_PERS_STRUCT, mUserPDefLoggermEditedProperties, mEditedPropertyExprsDEF_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_EXPRMAPmFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIXXML_STATEMENT| Constructor and Description |
|---|
PDefComponentObjectBase() |
PDefComponentObjectBase(DefinitionObject staticDef) |
| Modifier and Type | Method and Description |
|---|---|
void |
addOperation(OperationDefinitionImpl opDef) |
OperationDefinitionImpl |
addScriptOperation(java.lang.String id,
java.lang.String name,
java.lang.String returnType,
java.util.LinkedHashMap<java.lang.String,java.lang.String> params,
java.lang.String body)
Deprecated.
|
void |
applyDiffChildren(DifferDetails dif,
DiffResolver resolver)
Applies changes to children defs.
|
protected void |
applyDiffChildrenPDefComponentOperations(DifferDetails dif,
DiffResolver resolver) |
void |
applyDiffContents(DifferDetails dif,
DiffResolver resolver)
When diff/merge operation is requested, we have the following
three def objects:
|
DifferDetails |
beginDiffObjects(DiffMergeable docDef,
DiffMergeable orgDef,
DifferDetails difDetails)
This method is the entry point call when the diffing process
begins on the document-level def.
|
DifferDetails |
diffChildren(DiffMergeable docDef,
DiffMergeable orgDef,
DifferDetails difDetails)
Performs diff of children defs.
|
protected DifferDetails |
diffChildrenPDefComponentOperations(DiffMergeable docDef,
DiffMergeable orgDef,
DifferDetails difDetails) |
DifferDetails |
diffContents(DiffMergeable docDef,
DiffMergeable orgDef,
DifferDetails difDetails)
Performs diff of scalar values.
|
ExprCodeSource |
editCodeSource(ExprCodeSource codeSource)
Notify that ComponentOperationsManager that the client expects to
edit the CodeSource.
|
CodeSourceImpl |
ensureCodeSource(ExprDef exprDef)
Ensure a named code source in the operations manager.
|
VariableValueManager |
ensureVariableManager()
Returns this object's Variable Value Manager.
|
OperationDefinitionImpl |
findOperationDefinition(java.lang.String id) |
java.util.HashMap |
getAllProperties(java.util.HashMap map,
LocaleContext locale) |
java.lang.String |
getDefXMLNameSpace() |
java.lang.String |
getEditVersionsAsString() |
oracle.jbo.server.InheritPersonalization |
getInheritPersonalizationValue() |
protected int |
getLoadSubclassLevel() |
int |
getMajorVersion() |
java.lang.Class |
getMessageBundleClass() |
int |
getMinorVersion() |
protected java.lang.String |
getNoPersDefObjectName(java.lang.String metaObjectName) |
OperationDefinitionsImpl |
getOperationDefinitions()
Return the operation definitions.
|
java.util.ArrayList |
getPersonalizedVariables() |
ResourceBundleDef |
getResourceBundleDef() |
java.lang.String |
getResourcePrefix() |
OperationDefinitionsImpl |
getRowOperationDefinitions()
Return the row operation definitions.
|
VariableValueManager |
getVariableManager()
Returns this object's current Variable Value Manager.
|
boolean |
hasPersonalizedComponentOperations() |
boolean |
hasVariables()
Returns a flag indicating whether this object has
Variables or not.
|
protected void |
loadDefVersions(DefElement xmlElement) |
void |
loadXMLContents(DefElement xmlElement,
java.lang.String fullName) |
ExprCodeSource |
lookupCodeSource(java.lang.String name) |
ExprDef |
lookupExprDef(OwnerType type,
java.lang.String path)
Search for an ExprDef in the ComponentOperationsManager's namespace.
|
OperationDefinitionImpl |
lookupOperationDefinition(java.lang.String id) |
PDefVariable |
lookupPersonalizedVariable(java.lang.String varName) |
OperationDefinitionImpl |
lookupRowOperationDefinition(java.lang.String name,
java.lang.String returnType,
java.lang.Class[] params) |
void |
personalizeOperations(ComponentOperations operDef) |
PDefVariable |
personalizeVariable(java.lang.String varName) |
void |
removeOperation(java.lang.String opId) |
void |
removePersonalizedVariable(java.lang.String varName) |
protected java.lang.Object |
resolvePropertyRaw(java.lang.String property,
LocaleContext locale) |
void |
setEditable(boolean editable) |
void |
setInheritPersonalizationStrValue(java.lang.String s) |
protected void |
setVariableManager(VariableValueManager mgr) |
void |
updateMdsKeyFromTip(PersistableDefObject tipObj) |
void |
writeChildren(DefWriter jos)
Writes the Object's children to the Persistent storage
|
void |
writeContents(DefWriter jos)
Objects should write their persistence output in this method
|
applyPersonalization, applyPersonalization, applyPropertiesPersonalization, deregisterDefObject, findStaticDefinitionObject, getBasePackage, getFileName, getStaticDef, getStaticDefWithCheck, getTrimmedFullName, getTrimmedFullNameForDef, hasStaticDefElem, isAuditEnabled, isAuditEnabled, isDeprecated, loadSubclassXMLContents, loadXMLContents, mergePropertyMap, raiseCustomAuditEvent, registerDefObject, registerSessionDefObject, removeProperty, resolveDefObject, saveXMLContents, setDefinitionState, setFullName, setFullName, setProperty, setPropertyExpression, setPropertyMap, setStaticDef, setStaticDefPublicaddDefImport, addExtendedDefObject, addSavedDocName, adjustPropertyMapForWrite, allocatePropertyMap, allocatePropertyMapForEdits, checkEditable, checkStructWithOld, close, createFromXML, deregisterSessionObject, diffObjects, ensureDifferDetails, findDefImport, finishedLoading, getBaseDir, getDefImports, getDefManager, getDefTypeName, getDefWriter, getDefXMLElementTag, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getExtendedDefObjectsInternal, getFullDirName, getFullFileName, getMergeableFullName, getMergeableName, getOrigObject, getPropertyMap, getSavedDocNames, getSessionSyncLock, getSubstitutedNames, getSyncLock, getXMLElementTag, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isCustomizationEnabled, isCustomizationEnabled, isDirty, isEditable, isFromTip, isLoadBase, isMajorVersionChanged, isMinorVersionChanged, isNew, isPersonalizationEnabled, isPersonalizationEnabled, isPropertyExpression, loadDefImports, loadDefObject, loadXMLContentsNoResolve, lockDefinitionContext, mergeChanges, objectRemoved, reapplyChanges, registerClass, registerSiteDefObject, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setEditableFlag, setEditableObject, setFullNameInternal, setLoadBase, setMajorVersionChanged, setNew, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setupDefWriterFromMO, staticUpdateChildrenList, unlockDefinitionContext, updateChildrenList, verifyVersion, verifyVersionNullCheck, writeHeaderForNew, writeObject, writeVersion, writeXMLContentsaddPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getBaseDefObject, getContainerDef, getContainerName, getDefinitionState, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, getRootBaseDefObject, isBaseDefFor, isComponentDefinition, isDynamicDefinitionObject, isObjectResolved, isSubtypeOf, isSuppressUpdateCheck, loadCustomProperties, loadProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, resolveReferences, setBaseDefObject, setBaseDefObject, setDefScope, setMdsKey, setMdsReference, setName, setObjectResolved, setParent, setPropertySetName, staticLoadCustomProperties, staticLoadSchemaProperties, suppressUpdateCheckgetFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionDef, getPropertyExpressionsMap, getPropertyNamesSet, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setPropertiesMap, setPropertiesMap2, setPropertyclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetNamegetFullNamegetFullNamepublic PDefComponentObjectBase()
public PDefComponentObjectBase(DefinitionObject staticDef)
public boolean hasVariables()
VariableManagerOwnerBasehasVariables in interface VariableManagerOwnerBasepublic VariableValueManager getVariableManager()
VariableManagerOwnerBasenull if Variable Value Manager has
been initialized.
When a framework object is first created, its Variable Value Manager may be null. This method does not initialize (create) the Variable Value Manager.
in contrast, ensures
that the Variable Value Manager is initialized (created).VariableManagerOwnerBase.ensureVariableManager()
getVariableManager in interface VariableManagerOwnerBasenull if one was not yet initialized.protected void setVariableManager(VariableValueManager mgr)
public VariableValueManager ensureVariableManager()
VariableManagerOwnerBaseensureVariableManager in interface VariableManagerOwnerBasepublic java.lang.Class getMessageBundleClass()
getMessageBundleClass in interface VariableManagerOwnerBasepublic ResourceBundleDef getResourceBundleDef()
getResourceBundleDef in interface ResourceBundleOwnergetResourceBundleDef in interface VariableManagerOwnerBasepublic java.lang.String getResourcePrefix()
getResourcePrefix in interface ResourceBundleOwnerpublic java.util.ArrayList getPersonalizedVariables()
public PDefVariable lookupPersonalizedVariable(java.lang.String varName)
public void personalizeOperations(ComponentOperations operDef)
public PDefVariable personalizeVariable(java.lang.String varName)
public void removePersonalizedVariable(java.lang.String varName)
@Concealed public OperationDefinitionImpl lookupOperationDefinition(java.lang.String id)
public OperationDefinitionImpl lookupRowOperationDefinition(java.lang.String name, java.lang.String returnType, java.lang.Class[] params)
@Concealed public OperationDefinitionImpl findOperationDefinition(java.lang.String id)
@Concealed public ExprCodeSource lookupCodeSource(java.lang.String name)
@Concealed public boolean hasPersonalizedComponentOperations()
@Concealed public void addOperation(OperationDefinitionImpl opDef)
public OperationDefinitionImpl addScriptOperation(java.lang.String id, java.lang.String name, java.lang.String returnType, java.util.LinkedHashMap<java.lang.String,java.lang.String> params, java.lang.String body)
@Concealed public void removeOperation(java.lang.String opId)
public void loadXMLContents(DefElement xmlElement, java.lang.String fullName)
public void writeChildren(DefWriter jos)
PersistentDefinitionwriteChildren in interface PersistentDefinitionwriteChildren in class PersistableDefObjectjos - the Output storage for persistencepublic void writeContents(DefWriter jos)
PersistentDefinitionwriteContents in interface PersistentDefinitionjos - the Output storage for persistencepublic void updateMdsKeyFromTip(PersistableDefObject tipObj)
updateMdsKeyFromTip in class PersistableDefObjectpublic DifferDetails beginDiffObjects(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
DiffMergeableDiffMergeable's. 'this' object is the
changed definition.
beginDiffObjects in interface DiffMergeablebeginDiffObjects in class PersistableDefObjectdocDef - the document-level definitionorgDef - the original definition. It could be
null if the definition did not exist originallydifDetails - the DifferDetails that accumulate
the details of diff from the document-level (top-level) defDifferDetails that has all the details
of diffprotected DifferDetails diffChildrenPDefComponentOperations(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
public DifferDetails diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
DiffMergeabledifDetails 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.
diffChildren in interface DiffMergeablediffChildren in class PersistableDefObjectdocDef - the document-level definitionorgDef - the original definition. It could be
null if the definition did not exist originallydifDetails - the DifferDetails that accumulate
the details of diff from the document-level (top-level) defDifferDetails that has all the details
of diffprotected void applyDiffChildrenPDefComponentOperations(DifferDetails dif, DiffResolver resolver)
public void applyDiffChildren(DifferDetails dif, DiffResolver resolver)
DiffMergeabledif 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
}
}
applyDiffChildren in interface DiffMergeableapplyDiffChildren in class PersistableDefObjectpublic void setEditable(boolean editable)
setEditable in class PersistableDefObjectpublic OperationDefinitionsImpl getOperationDefinitions()
OperationContainergetOperationDefinitions in interface OperationContainerpublic OperationDefinitionsImpl getRowOperationDefinitions()
OperationContainergetRowOperationDefinitions in interface OperationContainerpublic CodeSourceImpl ensureCodeSource(ExprDef exprDef)
ComponentOperationsManager#updateCodeSource to update the component
operations manager with any updates that are made to this CodeSource.ensureCodeSource in interface ComponentOperationsManagerexprDef - a null exprDef may be used to indicate the a
built-in code source.public ExprCodeSource editCodeSource(ExprCodeSource codeSource)
ComponentOperationsManagereditCodeSource in interface ComponentOperationsManagerpublic ExprDef lookupExprDef(OwnerType type, java.lang.String path)
ComponentOperationsManagerlookupExprDef in interface ComponentOperationsManagertype - the {@link oracle.jbo.common.OwnerType) of the expressionpath - the (@link ExprDef#getPath} of the expressionpublic oracle.jbo.server.InheritPersonalization getInheritPersonalizationValue()
public void setInheritPersonalizationStrValue(java.lang.String s)
protected int getLoadSubclassLevel()
public java.lang.String getEditVersionsAsString()
getEditVersionsAsString in class PersistableDefObjectpublic int getMajorVersion()
getMajorVersion in class PersistableDefObjectpublic int getMinorVersion()
getMinorVersion in class PersistableDefObjectprotected void loadDefVersions(DefElement xmlElement)
protected java.lang.String getNoPersDefObjectName(java.lang.String metaObjectName)
protected java.lang.Object resolvePropertyRaw(java.lang.String property,
LocaleContext locale)
resolvePropertyRaw in class NamedObjectImplpublic java.util.HashMap getAllProperties(java.util.HashMap map,
LocaleContext locale)
getAllProperties in class NamedObjectImplpublic java.lang.String getDefXMLNameSpace()
getDefXMLNameSpace in interface PersistentDefinitiongetDefXMLNameSpace in class PersistableDefObjectpublic DifferDetails diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
DiffMergeableorgDef. 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;
}
diffContents in interface DiffMergeablediffContents in class PersistableDefObjectdocDef - the document-level definitionorgDef - the original definition. It could be
null if the definition did not exist originallydifDetails - the DifferDetails that accumulate
the details of diff from the document-level (top-level) defDifferDetails that has all the details
of diffpublic void applyDiffContents(DifferDetails dif, DiffResolver resolver)
DiffMergeable
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.
applyDiffContents in interface DiffMergeableapplyDiffContents in class PersistableDefObjectdif - changes to be applied to 'this' defresolver - the diff resolver used in diff/merge operation