oracle.jbo.server

Class DefObject

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.server.DefObject

All Implemented Interfaces:

DiffMergeable, DiffSkippable, DefPersistable, PersistentDefinition, PropertyManager, VariableManagerOwner, VariableManagerOwnerBase

Direct Known Subclasses:

AssociationEnd, AttributeDefImpl, KeyDef, MetaObject, OperationDefinitionImpl, OperationDefinitionsImpl, OperationParamImpl, RowFinder, ViewAccessorDef, ViewFilterUsage

@Concealed
public abstract class DefObject
extends PersistableDefObject
implements VariableManagerOwner

For internal use only. Application developers should not use this

Default implementation of DefInterface implemented by all of JBO Definition classes.

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

JIT_PACKAGE_NAME, mDebugToSkipEmptyDocForBug24949961, 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

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	DefObject(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)
void	applyDiffChildren(DifferDetails dif, DiffResolver resolver) Applies changes to children defs.
protected void	callFinishedLoading()
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
VariableValueManager	ensureVariableManager() Returns this object's Variable Value Manager.
protected void	finishedLoading()
protected java.lang.Object	getAdfmConfigStartupProperty(java.lang.String propertyName, java.lang.String defaultValue)
java.util.HashMap	getAllProperties(java.util.HashMap map, LocaleContext locale)
DefinitionObject	getBaseDefObject()
protected boolean	getBooleanAdfmConfigProperty(java.lang.String propertyName, boolean defaultValue)
abstract int	getDefTypeId()
java.lang.String	getDefXMLNameSpace()
VariableValueManager	getVariableManager() Returns this object's current Variable Value Manager.
protected VariableValueManager[]	getVarMgrParents()
boolean	hasVariables() Returns a flag indicating whether this object has Variables or not.
boolean	isDeprecated(LocaleContext locale) For internal framework use only.
boolean	isFromCustomization()
protected void	loadProperties(DefElement xmlElement)
protected void	loadVariables(DefElement xmlElement)
protected java.lang.Object	resolvePropertyRaw(java.lang.String property, LocaleContext locale)
protected void	resolveReferences()
void	setBaseDefObject(DefinitionObject baseDefObject)
void	setBaseDefObject(DefinitionObject baseDefObject, boolean addToBaseDef)
protected abstract void	setDefForComponent(ComponentObjectImpl comp)
void	setName(java.lang.String name) Name this object.
protected void	setParent(NamedObjectImpl parent) Sets this object's parent.
protected abstract void	unsetDefForComponent(ComponentObjectImpl comp)
void	writeChildren(DefWriter jos) Writes the Object's children to the Persistent storage

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addDefImport, addExtendedDefObject, addSavedDocName, adjustPropertyMapForWrite, allocatePDef, allocatePropertyMap, allocatePropertyMapForEdits, applyDiffContents, baseIsWriteObject, beginDiffObjects, buildChildName, buildFileName, checkEditable, checkEditableWithDefWriter, checkStructWithOld, close, createEditPDef, createFromXML, deregisterDefObject, deregisterHLDef, deregisterSessionObject, diffChildrenHLDefs, diffChildrenProperties, diffContents, diffObjects, ensureDifferDetails, ensureDifferSkip, extractCustIntoPDef, findDefImport, forgetChanges, getBaseDir, getBasePackage, getChildren, getDefImports, getDefManager, getDefTypeName, getDefWriter, getDefXMLElementTag, getDifferSkip, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getEditVersionsAsString, getExtendedDefObjectsInternal, getFileName, getFullDirName, getFullFileName, getHLDefMap, getIdentificationAttributeName, getMajorVersion, getMergeableFullName, getMergeableName, getMinorVersion, getOrigObject, getPropertyMap, getPropertyNamesSet, getSavedDocNames, getSessionSyncLock, getSubstitutedNames, getSyncLock, getXMLElementTag, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isAutoMerged, isCreateEditPDef, isCustomizationEnabled, isCustomizationEnabled, isDirty, isEditable, isFromTip, isInheritPolicyStrict, isLoadBase, isLoadHLDefs, isMajorVersionChanged, isMinorVersionChanged, isNew, isNewRecurse, isPersonalizationEnabled, isPersonalizationEnabled, isPropertyExpression, isSaveToJSON, isSkipWrite, isWriteObject, loadDefImports, loadDefObject, loadXMLContents, loadXMLContentsNoResolve, lockDefinitionContext, lookupHLDef, makeNew, mergeChanges, mergeEditedPropertiesForJSON, mergePropertyMap, objectRemoved, postSaveContents, readJSONObject, reapplyChanges, registerClass, registerDefObject, registerHLDef, registerSessionDefObject, registerSiteDefObject, reloadFromXMLContents, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveJSONContents, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setEditable, setEditableFlag, setEditableObject, setForRuntime, setFullName, setFullNameInternal, setLoadBase, setLoadHLDefs, setMajorVersionChanged, setNew, setNewRecurse, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, setSkipWrite, setupDefWriterFromMO, setWholeDefDirty, setWholeDefNew, staticUpdateChildrenList, transferDefChangesInto, unlockDefinitionContext, updateChildObject, updateChildrenList, updateMdsKeyFromTip, verifyVersion, verifyVersionNullCheck, writeContents, writeHeaderForNew, writeJSONContents, writeObject, writeVersion, writeXMLContents

Methods inherited from class oracle.jbo.mom.DefinitionObject

addPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getContainerDef, getContainerName, getDefinitionState, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getMdsReferenceName, getPropertySetName, getPropertySetNames, getRootBaseDefObject, isBaseDefFor, isComponentDefinition, isDynamicDefinitionObject, isObjectResolved, isSubtypeOf, isSuppressUpdateCheck, loadCustomProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, objectFound, objectInserted, setDefScope, setMdsKey, setMdsReference, setObjectResolved, setPropertySetName, staticLoadCustomProperties, staticLoadSchemaProperties, suppressUpdateCheck

Methods inherited from class oracle.jbo.common.NamedObjectImpl

getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionDef, getPropertyExpressionsMap, getPropertyExprEval, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, hasProperty, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, 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.VariableManagerOwner

getName

Methods inherited from interface oracle.jbo.VariableManagerOwnerBase

getMessageBundleClass, getResourceBundleDef

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

getFullName

Methods inherited from interface oracle.jbo.PropertyManager

getProperty, removeProperty, setProperty

Constructor Detail

DefObject

protected DefObject(DefinitionManager defMgr,
                    int defScope)

Method Detail

setName

@Restricted
public void setName(java.lang.String name)

Name this object.

Overrides:

setName in class DefinitionObject

Parameters:

name - the name to be given to this object.

For internal use only. Application developers should not use this

getBaseDefObject

@Restricted
public DefinitionObject getBaseDefObject()

Overrides:

getBaseDefObject in class DefinitionObject

setBaseDefObject

public void setBaseDefObject(DefinitionObject baseDefObject)

Overrides:

setBaseDefObject in class DefinitionObject

setBaseDefObject

@Restricted
public void setBaseDefObject(DefinitionObject baseDefObject,
                                         boolean addToBaseDef)

Overrides:

setBaseDefObject in class DefinitionObject

resolveReferences

protected void resolveReferences()

Overrides:

resolveReferences in class DefinitionObject

finishedLoading

@Restricted
protected void finishedLoading()

Overrides:

finishedLoading in class PersistableDefObject

callFinishedLoading

@Restricted
protected void callFinishedLoading()

Overrides:

callFinishedLoading in class PersistableDefObject

setParent

protected void setParent(NamedObjectImpl parent)

Sets this object's parent.

Overrides:

setParent in class DefinitionObject

Parameters:

parent - the named object that is to be the parent of this object.

isFromCustomization

public boolean isFromCustomization()

isDeprecated

@Concealed
public boolean isDeprecated(LocaleContext locale)

For internal framework use only.

Overrides:

isDeprecated in class DefinitionObject

For internal use only. Application developers should not use this

loadProperties

@Restricted
protected void loadProperties(DefElement xmlElement)

Overrides:

loadProperties in class DefinitionObject

Parameters:

xmlElement - The XML element to load from.

loadVariables

protected void loadVariables(DefElement xmlElement)

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

Overrides:

writeChildren in class PersistableDefObject

Parameters:

jos - the Output storage for persistence

addChildren

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

Overrides:

addChildren in class PersistableDefObject

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

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

Overrides:

applyDiffChildren in class PersistableDefObject

getDefTypeId

public abstract int getDefTypeId()

setDefForComponent

protected abstract void setDefForComponent(ComponentObjectImpl comp)

unsetDefForComponent

protected abstract void unsetDefForComponent(ComponentObjectImpl comp)

getVariableManager

@Restricted
public VariableValueManager getVariableManager()

Description copied from interface: VariableManagerOwnerBase

Returns this object's current Variable Value Manager. It will return null 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.

VariableManagerOwnerBase.ensureVariableManager() in contrast, ensures that the Variable Value Manager is initialized (created).

Specified by:

getVariableManager in interface VariableManagerOwnerBase

Returns:

this object's current Variable Value Manager. May return null if one was not yet initialized.

getVarMgrParents

protected VariableValueManager[] getVarMgrParents()

hasVariables

public boolean hasVariables()

Description copied from interface: VariableManagerOwnerBase

Returns a flag indicating whether this object has Variables or not.

Specified by:

hasVariables in interface VariableManagerOwnerBase

Returns:

the flag indicating whether this object has Variables.

ensureVariableManager

@Restricted
public VariableValueManager ensureVariableManager()

Description copied from interface: VariableManagerOwnerBase

Returns this object's Variable Value Manager. If this object current has no Variable Value Manager, it will initialize (create) one.

Specified by:

ensureVariableManager in interface VariableManagerOwnerBase

Returns:

this object's Variable Value Manager. Will create a Variable Value Manager if this object had no Variable Value Manager.

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace in class PersistableDefObject

resolvePropertyRaw

protected java.lang.Object resolvePropertyRaw(java.lang.String property,
                                              LocaleContext locale)

Overrides:

resolvePropertyRaw in class NamedObjectImpl

getAllProperties

public java.util.HashMap getAllProperties(java.util.HashMap map,
                                          LocaleContext locale)

Overrides:

getAllProperties in class NamedObjectImpl

getBooleanAdfmConfigProperty

protected boolean getBooleanAdfmConfigProperty(java.lang.String propertyName,
                                               boolean defaultValue)

getAdfmConfigStartupProperty

protected java.lang.Object getAdfmConfigStartupProperty(java.lang.String propertyName,
                                                        java.lang.String defaultValue)