oracle.jbo.mom

Class PersistableDefObject

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

All Implemented Interfaces:

DiffMergeable, DiffSkippable, DefPersistable, PersistentDefinition, PropertyManager

Direct Known Subclasses:

AMDataModelComp, AMServiceViewUsage, AppModuleConfigImpl, AppModuleConfigImpl, BoundParameters, CategoryImpl, CodeSourceImpl.MethodSource, ContainerDefImpl, DCDefBase, DefObject, ExpressionDef, GenericResourceBundleDef, ListBindingDef, NamedObjectAnnotations, PermissionDefImpl, PersDefBase

public class PersistableDefObject
extends DefinitionObject
implements DefPersistable, DiffMergeable, DiffSkippable, PropertyManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistableDefObject.CustomizationType
static class	PersistableDefObject.PersonalizationType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JIT_PACKAGE_NAME
static boolean	mDebugToSkipEmptyDocForBug24949961
protected java.util.Map	mEditedProperties
protected java.util.Map	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

FLAG_DIRTY, FLAG_EDITABLE, FLAG_FROM_TIP, FLAG_LOAD_BASE, FLAG_LOAD_HL_DEFS, FLAG_MAJOR_VERSION_CHANGED, FLAG_MINOR_VERSION_CHANGED, FLAG_NEW, FLAG_NEW_RECURSE, FLAG_SKIP_WRITE, XML_STATEMENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PersistableDefObject()
	PersistableDefObject(DefinitionManager defMgr, int defScope)

Method Summary

Modifier and Type	Method and Description
java.util.Map	addChildren(java.util.Map m, boolean recurse, java.lang.Class cls)
java.lang.Object	addDefImport(java.lang.String defName, boolean doFind)
protected void	addExtendedDefObject(DefinitionObject extendedDefObject)
void	addSavedDocName(java.lang.String absoluteDocName)
protected java.util.HashMap	adjustPropertyMapForWrite()
PersDefBase	allocatePDef()
protected java.util.Map	allocatePropertyMap() For internal framework use only.
protected java.util.Map	allocatePropertyMapForEdits() For internal framework use only.
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:
static boolean	baseIsWriteObject(DefPersistable defObj, DefPersistable parentObj, DefWriter defWriter)
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.
static java.lang.String	buildChildName(java.lang.String elemType, java.lang.String childName, java.lang.Object child)
java.lang.String	buildFileName(java.lang.String objFullName)
protected void	callFinishedLoading()
void	checkEditable()
void	checkEditableWithDefWriter(DefWriter jos)
void	checkStructWithOld(PersistableDefObject pOldDef)
void	close()
PersDefBase	createEditPDef()
static PersistableDefObject	createFromXML(int defScope, DefinitionManager defMgr, java.lang.String fullName, java.lang.String metaObjectName, DefElement elem, DefinitionObject staticDef)
void	deregisterDefObject()
PersistableDefObject	deregisterHLDef(java.lang.String diffName)
void	deregisterSessionObject()
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
DifferDetails	diffChildrenHLDefs(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
DifferDetails	diffChildrenProperties(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
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.
DifferSkip	ensureDifferSkip()
void	extractCustIntoPDef(PersDefBase pDef)
protected java.lang.Object	findDefImport(java.lang.String defName)
protected void	finishedLoading()
void	forgetChanges()
java.lang.String	getBaseDir()
java.lang.String	getBasePackage()
java.util.Map	getChildren(boolean recurse, java.lang.Class cls)
java.util.List	getDefImports()
DefinitionManager	getDefManager()
java.lang.String	getDefTypeName() Returns the XML def type name of this defintion object, e.g., "PDefEntityObject".
DefWriter	getDefWriter()
java.lang.String	getDefXMLElementTag()
java.lang.String	getDefXMLNameSpace()
DifferSkip	getDifferSkip()
java.util.HashMap	getEditedPropertiesMap() For internal framework use only.
protected java.util.HashMap	getEditedPropertyExpressionsMap() For internal framework use only.
protected java.util.Map	getEditedPropertyMap() For internal framework use only.
PersistableDefObject	getEditObject()
java.lang.String	getEditVersionsAsString()
java.util.List<DefinitionObject>	getExtendedDefObjectsInternal()
java.lang.String	getFileName()
java.lang.String	getFullDirName()
java.lang.String	getFullFileName()
java.util.Map<java.lang.String,PersistableDefObject>	getHLDefMap()
java.lang.String	getIdentificationAttributeName() return the attribute name for identification on an xml element.
int	getMajorVersion()
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).
int	getMinorVersion()
DefPersistable	getOrigObject()
java.util.Map	getPropertyMap() Internal: Applications should not use this method.
java.util.Set<java.lang.String>	getPropertyNamesSet() Internal: Applications should not use this method.
java.util.List<java.lang.String>	getSavedDocNames()
protected java.lang.Object	getSessionSyncLock() Deprecated. use lockDefinitionContext() instead
java.lang.String[]	getSubstitutedNames(boolean recurse)
protected java.lang.Object	getSyncLock() Deprecated. use lockDefinitionContext() instead
java.lang.String	getXMLElementTag() Returns a piece of static info for the type of object this is invoked upon.
void	guaranteePath()
boolean	hasExtendedDefObjects()
boolean	includeCustomizationLayerInfo()
boolean	isAutoMerged()
boolean	isCreateEditPDef()
boolean	isCustomizationEnabled() For internal use only.
boolean	isCustomizationEnabled(PersistableDefObject.CustomizationType type) For internal use only.
boolean	isDirty() This method returns if an Object is modified from last save/load
boolean	isEditable()
boolean	isFromTip()
boolean	isInheritPolicyStrict()
boolean	isLoadBase()
boolean	isLoadHLDefs()
boolean	isMajorVersionChanged()
boolean	isMinorVersionChanged()
boolean	isNew() This method returns if this object is previously persisted.
boolean	isNewRecurse()
boolean	isPersonalizationEnabled() For internal use only.
boolean	isPersonalizationEnabled(PersistableDefObject.PersonalizationType type) For internal use only.
boolean	isPropertyExpression(java.lang.String hintName)
boolean	isSaveToJSON()
boolean	isSkipWrite()
boolean	isWriteObject(DefPersistable parentObj, DefWriter defWriter)
protected void	loadDefImports(DefElement xmlElement)
PersistableDefObject	loadDefObject(boolean forTip, boolean forEditOrig, boolean resolveDef)
void	loadXMLContents(DefElement xmlElement, java.lang.String fullName)
void	loadXMLContentsNoResolve(DefElement xmlElement, java.lang.String fullName)
protected void	lockDefinitionContext() Locks the definition object's definition context.
PersistableDefObject	lookupHLDef(java.lang.String id)
void	makeNew()
static boolean	mergeChanges(PersistableDefObject editObj, PersistableDefObject tipObj, PersistableDefObject origObj, DiffResolver resolver, java.lang.String transMajor, java.lang.String transMinor)
protected java.util.HashMap	mergeEditedPropertiesForJSON(boolean isEditLocal, java.util.Map origPropsMap, java.util.HashMap propsMap)
void	mergePropertyMap(java.util.Map m) For internal framework use only.
protected void	objectRemoved()
protected void	postSaveContents()
void	readJSONObject(java.lang.String fileName)
boolean	reapplyChanges(PersistableDefObject tipObj, DiffResolver resolver)
static void	registerClass(java.lang.String tagName, java.lang.Class cls)
void	registerDefObject()
PersistableDefObject	registerHLDef(PersistableDefObject hlDef)
void	registerSessionDefObject()
void	registerSiteDefObject()
void	reloadFromXMLContents()
void	remove()
boolean	removeAndDelete()
void	removeDefImport(java.lang.String defName)
protected boolean	removeExtendedDefObject(DefinitionObject extendedDefObject)
void	removeProperty(java.lang.String hintName, LocaleContext locale)
void	saveJSONContents()
void	saveXMLContents()
void	setCustomizationEnabled(java.util.EnumSet<PersistableDefObject.CustomizationType> types, boolean flag) For internal use only.
void	setCustomizationEnabled(PersistableDefObject.CustomizationType type, boolean flag) For internal use only.
void	setDefaultBaseDir(java.lang.String defaultBaseDir)
void	setDefMgr(DefinitionManager mgr)
void	setDirty(boolean b) This method marks the Object dirty
void	setEditable(boolean b)
void	setEditableFlag(boolean b)
void	setEditableObject(PersistableDefObject editObj)
void	setForRuntime()
void	setFullName(java.lang.String name) Give this object a fully-qualified name.
void	setFullNameInternal(java.lang.String name)
void	setLoadBase(boolean b)
void	setLoadHLDefs(boolean b)
void	setMajorVersionChanged(boolean b)
void	setNew(boolean b) This method marks the as previously persisted.
void	setNewRecurse(boolean b)
void	setOrigObject(DefPersistable origObject)
void	setPersonalizationEnabled(java.util.EnumSet<PersistableDefObject.PersonalizationType> types, boolean flag) For internal use only.
void	setPersonalizationEnabled(PersistableDefObject.PersonalizationType type, boolean flag) For internal use only.
void	setProperty(java.lang.String hintName, java.lang.Object hintValue, LocaleContext locale)
void	setPropertyExpression(java.lang.String hintName, java.lang.String hintExpression) Advanced API to be used in restricted scenarios.
void	setPropertyMap(java.util.Map m) For internal framework use only.
void	setSkipWrite(boolean b)
void	setupDefWriterFromMO(oracle.mds.core.MetadataObject mo)
void	setWholeDefDirty(boolean b)
void	setWholeDefNew(boolean b, boolean recurse)
static void	staticUpdateChildrenList(DefWriter jos, java.util.List lst, java.util.List orgLst, boolean useFullName, boolean writeDelta, boolean forceReplace, DefPersistable parentObj)
void	transferDefChangesInto(PersistableDefObject targetDef, boolean isToTransferAllChildren)
protected void	unlockDefinitionContext()
void	updateChildObject(DefWriter jos, DefPersistable child, DefPersistable orgChild, boolean useFullName, boolean writeDelta, boolean forceReplace)
void	updateChildrenList(DefWriter jos, java.util.List lst, java.util.List orgLst, boolean useFullName, boolean writeDelta, boolean forceReplace) Internal: Applications should not use this method.
void	updateMdsKeyFromTip(PersistableDefObject tipObj)
static void	verifyVersion(DefElement xmlElement, java.lang.String name)
static void	verifyVersionNullCheck(DefElement xmlElement, java.lang.String name, boolean nullOK)
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
void	writeHeaderForNew(DefWriter jos)
void	writeJSONContents()
void	writeObject(DefWriter jos) Objects should write their persistence output in this method
static void	writeVersion(DefWriter jos)
void	writeXMLContents()

Methods inherited from class oracle.jbo.mom.DefinitionObject

addPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getBaseDefObject, getContainerDef, getContainerName, getDefinitionState, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getMdsReferenceName, getPropertySetName, getPropertySetNames, getRootBaseDefObject, isBaseDefFor, isComponentDefinition, isDeprecated, isDynamicDefinitionObject, isObjectResolved, isSubtypeOf, isSuppressUpdateCheck, loadCustomProperties, loadProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, objectFound, objectInserted, 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, getPropertyExprEval, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, hasProperty, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, resolvePropertyRaw, setPropertiesMap, setPropertiesMap2, setProperty, setPropertyExpressionMap, setRawPropertyValue

Methods inherited from class java.lang.Object

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

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

getFullName

Methods inherited from interface oracle.jbo.PropertyManager

getProperty, removeProperty, setProperty

Field Detail

mEditedProperties

protected java.util.Map mEditedProperties

mEditedPropertyExprs

protected java.util.Map mEditedPropertyExprs

JIT_PACKAGE_NAME

public static java.lang.String JIT_PACKAGE_NAME

mDebugToSkipEmptyDocForBug24949961

public static boolean mDebugToSkipEmptyDocForBug24949961

Constructor Detail

PersistableDefObject

protected PersistableDefObject()

PersistableDefObject

public PersistableDefObject(DefinitionManager defMgr,
                            int defScope)

Method Detail

registerClass

public static void registerClass(java.lang.String tagName,
                                 java.lang.Class cls)

createFromXML

@Concealed
public static PersistableDefObject createFromXML(int defScope,
                                                            DefinitionManager defMgr,
                                                            java.lang.String fullName,
                                                            java.lang.String metaObjectName,
                                                            DefElement elem,
                                                            DefinitionObject staticDef)

getOrigObject

public DefPersistable getOrigObject()

Specified by:

getOrigObject in interface DefPersistable

setOrigObject

public void setOrigObject(DefPersistable origObject)

Specified by:

setOrigObject in interface DefPersistable

setFullNameInternal

public void setFullNameInternal(java.lang.String name)

setFullName

public void setFullName(java.lang.String name)

Description copied from class: NamedObjectImpl

Give this object a fully-qualified name.

Overrides:

setFullName in class NamedObjectImpl

Parameters:

name - 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

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

Returns:

full name of the def object

getSubstitutedNames

public java.lang.String[] getSubstitutedNames(boolean recurse)

registerDefObject

public void registerDefObject()

registerSiteDefObject

public void registerSiteDefObject()

registerSessionDefObject

public void registerSessionDefObject()

deregisterDefObject

public void deregisterDefObject()

deregisterSessionObject

public void deregisterSessionObject()

getDefManager

public DefinitionManager getDefManager()

lockDefinitionContext

@Concealed
protected void lockDefinitionContext()

Locks the definition object's definition context. This is typically only required internally. Call to this must be bracketed with a final unlockDefinitionContext().

For internal use only. Application developers should not use this

unlockDefinitionContext

@Concealed
protected void unlockDefinitionContext()

For internal use only. Application developers should not use this

getSyncLock

protected java.lang.Object getSyncLock()

Deprecated. use lockDefinitionContext() instead

getSessionSyncLock

protected java.lang.Object getSessionSyncLock()

Deprecated. use lockDefinitionContext() instead

hasExtendedDefObjects

public boolean hasExtendedDefObjects()

Overrides:

hasExtendedDefObjects in class DefinitionObject

getExtendedDefObjectsInternal

@Concealed
public java.util.List<DefinitionObject> getExtendedDefObjectsInternal()

Overrides:

getExtendedDefObjectsInternal in class DefinitionObject

For internal use only. Application developers should not use this

Internal framework use only.

addExtendedDefObject

protected void addExtendedDefObject(DefinitionObject extendedDefObject)

Overrides:

addExtendedDefObject in class DefinitionObject

removeExtendedDefObject

protected boolean removeExtendedDefObject(DefinitionObject extendedDefObject)

Overrides:

removeExtendedDefObject in class DefinitionObject

getEditVersionsAsString

public java.lang.String getEditVersionsAsString()

getMajorVersion

public int getMajorVersion()

getMinorVersion

public int getMinorVersion()

isMajorVersionChanged

public boolean isMajorVersionChanged()

setMajorVersionChanged

public void setMajorVersionChanged(boolean b)

isMinorVersionChanged

public boolean isMinorVersionChanged()

isDirty

public boolean isDirty()

Description copied from interface: DefPersistable

This method returns if an Object is modified from last save/load

Specified by:

isDirty in interface DefPersistable

Returns:

Returns true if the Object is dirty. Returns false otherwise.

setDirty

public void setDirty(boolean b)

Description copied from interface: DefPersistable

This method marks the Object dirty

Specified by:

setDirty in interface DefPersistable

Parameters:

b - If true the Object is marked Dirty.

setWholeDefDirty

public void setWholeDefDirty(boolean b)

checkStructWithOld

public void checkStructWithOld(PersistableDefObject pOldDef)

isNew

public boolean isNew()

Description copied from interface: DefPersistable

This method returns if this object is previously persisted.

Specified by:

isNew in interface DefPersistable

Returns:

true if the Object is previously persisted. Returns false otherwise.

setNew

public void setNew(boolean b)

Description copied from interface: DefPersistable

This method marks the as previously persisted. By default all objects are new objects. When the object is persisted first time, that object is marked as 'not new' object

Specified by:

setNew in interface DefPersistable

Parameters:

b - If true the Object is marked as new object.

isNewRecurse

public boolean isNewRecurse()

Specified by:

isNewRecurse in interface DefPersistable

setNewRecurse

public void setNewRecurse(boolean b)

Specified by:

setNewRecurse in interface DefPersistable

setWholeDefNew

public void setWholeDefNew(boolean b,
                           boolean recurse)

transferDefChangesInto

public void transferDefChangesInto(PersistableDefObject targetDef,
                                   boolean isToTransferAllChildren)

baseIsWriteObject

public static boolean baseIsWriteObject(DefPersistable defObj,
                                        DefPersistable parentObj,
                                        DefWriter defWriter)

isWriteObject

public boolean isWriteObject(DefPersistable parentObj,
                             DefWriter defWriter)

Specified by:

isWriteObject in interface DefPersistable

isLoadHLDefs

public boolean isLoadHLDefs()

setLoadHLDefs

public void setLoadHLDefs(boolean b)

isFromTip

public boolean isFromTip()

checkEditableWithDefWriter

public void checkEditableWithDefWriter(DefWriter jos)

checkEditable

public void checkEditable()

isEditable

public boolean isEditable()

setEditableFlag

public void setEditableFlag(boolean b)

setEditableObject

public void setEditableObject(PersistableDefObject editObj)

setEditable

public void setEditable(boolean b)

setForRuntime

public void setForRuntime()

isLoadBase

public boolean isLoadBase()

setLoadBase

public void setLoadBase(boolean b)

isSkipWrite

public boolean isSkipWrite()

Specified by:

isSkipWrite in interface DefPersistable

setSkipWrite

public void setSkipWrite(boolean b)

Specified by:

setSkipWrite in interface DefPersistable

getEditObject

public PersistableDefObject getEditObject()

getBaseDir

public java.lang.String getBaseDir()

getBasePackage

public java.lang.String getBasePackage()

setDefaultBaseDir

public void setDefaultBaseDir(java.lang.String defaultBaseDir)

setDefMgr

public void setDefMgr(DefinitionManager mgr)

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

getDefTypeName

public java.lang.String getDefTypeName()

Description copied from interface: DiffMergeable

Returns the XML def type name of this defintion object, e.g., "PDefEntityObject".

Specified by:

getDefTypeName in interface DiffMergeable

Returns:

XML def type name

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

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.

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

getIdentificationAttributeName

public java.lang.String getIdentificationAttributeName()

Description copied from interface: PersistentDefinition

return the attribute name for identification on an xml element. Note, for most def objects, the string "Name" should be returned; for someone that has no "Name" attribute, you need to designate one. e.g. For adfmcatalog.xml, "fullName" is returned For most other metadatas, "Name" is returned

Specified by:

getIdentificationAttributeName in interface PersistentDefinition

setupDefWriterFromMO

public void setupDefWriterFromMO(oracle.mds.core.MetadataObject mo)

getDefWriter

public DefWriter getDefWriter()

writeHeaderForNew

public void writeHeaderForNew(DefWriter jos)

writeObject

public void writeObject(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeObject in interface PersistentDefinition

Parameters:

jos - the Output storage for persistence

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

Parameters:

jos - the Output storage for persistence

getDifferSkip

public DifferSkip getDifferSkip()

Specified by:

getDifferSkip in interface DiffSkippable

ensureDifferSkip

public DifferSkip ensureDifferSkip()

Specified by:

ensureDifferSkip in interface DiffSkippable

lookupHLDef

public PersistableDefObject lookupHLDef(java.lang.String id)

getHLDefMap

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

deregisterHLDef

public PersistableDefObject deregisterHLDef(java.lang.String diffName)

registerHLDef

public PersistableDefObject registerHLDef(PersistableDefObject hlDef)

makeNew

public void makeNew()

buildChildName

public static java.lang.String buildChildName(java.lang.String elemType,
                                              java.lang.String childName,
                                              java.lang.Object child)

getChildren

public java.util.Map getChildren(boolean recurse,
                                 java.lang.Class cls)

addChildren

public java.util.Map addChildren(java.util.Map m,
                                 boolean recurse,
                                 java.lang.Class cls)

diffChildrenHLDefs

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

diffChildrenProperties

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

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

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)
    {
       <Your-def-class> orgDefImpl = (<Your-def-class>) 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

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

beginDiffObjects

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

Description copied from interface: DiffMergeable

This method is the entry point call when the diffing process begins on the document-level def. This document-level def may perform its setup or preparation operations and then traverse into nested (children) DiffMergeable's. 'this' object is the changed definition.

Specified by:

beginDiffObjects in interface DiffMergeable

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

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

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

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

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

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(<XML-tag-for-Child1>);

          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

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

Parameters:

dif - changes to be applied to 'this' def

resolver - the diff resolver used in diff/merge operation

reapplyChanges

public boolean reapplyChanges(PersistableDefObject tipObj,
                              DiffResolver resolver)

mergeChanges

@Concealed
public static boolean mergeChanges(PersistableDefObject editObj,
                                              PersistableDefObject tipObj,
                                              PersistableDefObject origObj,
                                              DiffResolver resolver,
                                              java.lang.String transMajor,
                                              java.lang.String transMinor)

isAutoMerged

public boolean isAutoMerged()

updateMdsKeyFromTip

@Concealed
public void updateMdsKeyFromTip(PersistableDefObject tipObj)

For internal use only. Application developers should not use this

updateChildObject

@Concealed
public void updateChildObject(DefWriter jos,
                                         DefPersistable child,
                                         DefPersistable orgChild,
                                         boolean useFullName,
                                         boolean writeDelta,
                                         boolean forceReplace)

updateChildrenList

@Concealed
public void updateChildrenList(DefWriter jos,
                                          java.util.List lst,
                                          java.util.List orgLst,
                                          boolean useFullName,
                                          boolean writeDelta,
                                          boolean forceReplace)

Internal: Applications should not use this method.

staticUpdateChildrenList

@Concealed
public static void staticUpdateChildrenList(DefWriter jos,
                                                       java.util.List lst,
                                                       java.util.List orgLst,
                                                       boolean useFullName,
                                                       boolean writeDelta,
                                                       boolean forceReplace,
                                                       DefPersistable parentObj)

getDefImports

public java.util.List getDefImports()

findDefImport

protected java.lang.Object findDefImport(java.lang.String defName)

addDefImport

public java.lang.Object addDefImport(java.lang.String defName,
                                     boolean doFind)

removeDefImport

public void removeDefImport(java.lang.String defName)

loadDefImports

protected void loadDefImports(DefElement xmlElement)

adjustPropertyMapForWrite

protected java.util.HashMap adjustPropertyMapForWrite()

includeCustomizationLayerInfo

public boolean includeCustomizationLayerInfo()

isInheritPolicyStrict

public boolean isInheritPolicyStrict()

writeChildren

public void writeChildren(DefWriter jos)

Description copied from interface: PersistentDefinition

Writes the Object's children to the Persistent storage

Specified by:

writeChildren in interface PersistentDefinition

Parameters:

jos - the Output storage for persistence

mergeEditedPropertiesForJSON

protected java.util.HashMap mergeEditedPropertiesForJSON(boolean isEditLocal,
                                                         java.util.Map origPropsMap,
                                                         java.util.HashMap propsMap)

isSaveToJSON

public boolean isSaveToJSON()

writeXMLContents

public void writeXMLContents()

writeJSONContents

public void writeJSONContents()

readJSONObject

public void readJSONObject(java.lang.String fileName)

getFileName

public java.lang.String getFileName()

isCreateEditPDef

public boolean isCreateEditPDef()

createEditPDef

public PersDefBase createEditPDef()

allocatePDef

public PersDefBase allocatePDef()

extractCustIntoPDef

public void extractCustIntoPDef(PersDefBase pDef)

loadDefObject

public PersistableDefObject loadDefObject(boolean forTip,
                                          boolean forEditOrig,
                                          boolean resolveDef)

saveXMLContents

public void saveXMLContents()

forgetChanges

public void forgetChanges()

reloadFromXMLContents

public void reloadFromXMLContents()

saveJSONContents

public void saveJSONContents()

postSaveContents

protected void postSaveContents()

addSavedDocName

@Concealed
public void addSavedDocName(java.lang.String absoluteDocName)

Parameters:

absoluteDocName - the document name for a regenerated file

For internal use only. Application developers should not use this

Called by DefObjectListener classes to mark a resolved conflict.

getSavedDocNames

@Concealed
public java.util.List<java.lang.String> getSavedDocNames()

Returns:

the list of document names for all the regenerated files.

For internal use only. Application developers should not use this

Called by MergeHelper to get the list of resolved conflicts.

finishedLoading

protected void finishedLoading()

Overrides:

finishedLoading in class DefinitionObject

callFinishedLoading

protected void callFinishedLoading()

Overrides:

callFinishedLoading in class DefinitionObject

loadXMLContents

public void loadXMLContents(DefElement xmlElement,
                            java.lang.String fullName)

loadXMLContentsNoResolve

public void loadXMLContentsNoResolve(DefElement xmlElement,
                                     java.lang.String fullName)

close

public void close()

objectRemoved

protected void objectRemoved()

Overrides:

objectRemoved in class DefinitionObject

remove

public void remove()

removeAndDelete

public boolean removeAndDelete()

getFullFileName

public java.lang.String getFullFileName()

buildFileName

public java.lang.String buildFileName(java.lang.String objFullName)

getFullDirName

public java.lang.String getFullDirName()

guaranteePath

public void guaranteePath()

verifyVersion

public static void verifyVersion(DefElement xmlElement,
                                 java.lang.String name)

verifyVersionNullCheck

public static void verifyVersionNullCheck(DefElement xmlElement,
                                          java.lang.String name,
                                          boolean nullOK)

writeVersion

public static void writeVersion(DefWriter jos)

getPropertyMap

public java.util.Map getPropertyMap()

Description copied from class: NamedObjectImpl

Internal: Applications should not use this method.

Overrides:

getPropertyMap in class NamedObjectImpl

Returns:

a reference to the properties Map

isPropertyExpression

public final boolean isPropertyExpression(java.lang.String hintName)

Overrides:

isPropertyExpression in class NamedObjectImpl

allocatePropertyMap

@Concealed
protected java.util.Map allocatePropertyMap()

For internal framework use only.

Overrides:

allocatePropertyMap in class NamedObjectImpl

For internal use only. Application developers should not use this

getPropertyNamesSet

@Concealed
public java.util.Set<java.lang.String> getPropertyNamesSet()

Description copied from class: NamedObjectImpl

Internal: Applications should not use this method.

Overrides:

getPropertyNamesSet in class NamedObjectImpl

Returns:

a set of property names

removeProperty

public void removeProperty(java.lang.String hintName,
                           LocaleContext locale)

Overrides:

removeProperty in class NamedObjectImpl

setProperty

public void setProperty(java.lang.String hintName,
                        java.lang.Object hintValue,
                        LocaleContext locale)

Overrides:

setProperty in class NamedObjectImpl

setPropertyExpression

@Restricted
public void setPropertyExpression(java.lang.String hintName,
                                              java.lang.String hintExpression)

Advanced API to be used in restricted scenarios.

Overrides:

setPropertyExpression in class NamedObjectImpl

Parameters:

hintName - the property name

hintExpression - expression that will be evaluated in the context of a row or definition object

allocatePropertyMapForEdits

@Concealed
protected java.util.Map allocatePropertyMapForEdits()

For internal framework use only.

For internal use only. Application developers should not use this

getEditedPropertiesMap

@Concealed
public java.util.HashMap getEditedPropertiesMap()

For internal framework use only.

For internal use only. Application developers should not use this

getEditedPropertyMap

@Concealed
protected java.util.Map getEditedPropertyMap()

For internal framework use only.

For internal use only. Application developers should not use this

getEditedPropertyExpressionsMap

@Concealed
protected java.util.HashMap getEditedPropertyExpressionsMap()

For internal framework use only.

For internal use only. Application developers should not use this

setPropertyMap

@Restricted
public void setPropertyMap(java.util.Map m)

For internal framework use only.

Overrides:

setPropertyMap in class NamedObjectImpl

For internal use only. Application developers should not use this

mergePropertyMap

@Concealed
public void mergePropertyMap(java.util.Map m)

For internal framework use only.

Overrides:

mergePropertyMap in class NamedObjectImpl

For internal use only. Application developers should not use this

isCustomizationEnabled

public boolean isCustomizationEnabled()

For internal use only. API may change in a future release.

Returns:

an enum that could be used to check if a definition has customization enabled.

isCustomizationEnabled

public boolean isCustomizationEnabled(PersistableDefObject.CustomizationType type)

For internal use only. API may change in a future release.

Returns:

an enum that could be used to check if a definition has customization enabled for the given type.

setCustomizationEnabled

public void setCustomizationEnabled(PersistableDefObject.CustomizationType type,
                                    boolean flag)

For internal use only. API may change in a future release. This API enables/disables customizing the definition for a given type.

setCustomizationEnabled

public void setCustomizationEnabled(java.util.EnumSet<PersistableDefObject.CustomizationType> types,
                                    boolean flag)

For internal use only. API may change in a future release. This API enables/disables customizing the definition for the given set of types.

isPersonalizationEnabled

public boolean isPersonalizationEnabled()

For internal use only. API may change in a future release.

Returns:

an enum that could be used to check if a definition has personalization enabled.

isPersonalizationEnabled

public boolean isPersonalizationEnabled(PersistableDefObject.PersonalizationType type)

For internal use only. API may change in a future release.

Returns:

an enum that could be used to check if a definition has personalization enabled for the given type.

setPersonalizationEnabled

public void setPersonalizationEnabled(PersistableDefObject.PersonalizationType type,
                                      boolean flag)

For internal use only. API may change in a future release. This API enables/disables personalizing the definition for a given type.

setPersonalizationEnabled

public void setPersonalizationEnabled(java.util.EnumSet<PersistableDefObject.PersonalizationType> types,
                                      boolean flag)

For internal use only. API may change in a future release. This API enables/disables personalizing the definition for the given set of types.