oracle.jbo.server

Class PDefComponentOperations

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.mom.PersDefBase

oracle.jbo.server.PDefComponentOperations

All Implemented Interfaces:

DiffMergeable, DiffSkippable, PersonalizableDef, DefPersistable, PersistentDefinition, PropertyManager

@Concealed
public class PDefComponentOperations
extends PersDefBase

For internal use only. Application developers should not use this

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.PersDefBase

APPLY_PERS_DB, APPLY_PERS_DEFAULT, APPLY_PERS_EVENTS, APPLY_PERS_PROPS, APPLY_PERS_QUERY, APPLY_PERS_STRUCT, APPLY_PERS_TO_BASE_DEF, APPLY_PERS_VALS, mUserPDefLogger

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

Constructor and Description
PDefComponentOperations() For internal framework use only.

Method Summary

Modifier and Type	Method and Description
void	addScriptOp(OperationDefinitionImpl opDef)
void	applyDiffChildren(DifferDetails dif, DiffResolver resolver) Applies changes to children defs.
void	applyPersonalization(int mode, java.lang.Object inst) For internal framework use only.
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
static PDefComponentOperations	findDefObject(java.lang.String name)
DefinitionObject	findStaticDefinitionObject(java.lang.String fullName) Deprecated.
int	getDefTypeId()
java.lang.String	getDefXMLElementTag() Deprecated.
java.lang.String	getDefXMLNameSpace()
OperationDefinitionsImpl	getScriptOps()
OperationDefinitionsImpl	getScriptRowOps()
java.lang.String	getXMLElementTag() Returns a piece of static info for the type of object this is invoked upon.
boolean	isDirty() This method returns if an Object is modified from last save/load
boolean	isObjectResolved()
void	loadXMLContents(DefElement xmlElement, java.lang.String fullName)
void	personalize(ComponentOperations compOps)
OperationDefinitionImpl	removeScriptOp(java.lang.String name)
void	resolveDefObject()
protected void	setDefForComponent(ComponentObjectImpl comp)
void	setEditable(boolean editable)
void	setFullName(java.lang.String fullName) Give this object a fully-qualified name.
void	setGlobal(boolean isGlobal)
void	setOwnerName(java.lang.String name)
protected void	unsetDefForComponent(ComponentObjectImpl comp)
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

Methods inherited from class oracle.jbo.mom.PersDefBase

applyPersonalization, applyPropertiesPersonalization, deregisterDefObject, deregisterSessionObject, getBasePackage, getFileName, getStaticDef, getStaticDefWithCheck, getTrimmedFullName, getTrimmedFullNameForDef, hasStaticDefElem, isAuditEnabled, isAuditEnabled, isAutoMerged, isDeprecated, loadSubclassXMLContents, loadXMLContents, mergePropertyMap, raiseCustomAuditEvent, registerDefObject, registerSessionDefObject, removeProperty, saveXMLContents, setDefinitionState, setFullName, setProperty, setPropertyExpression, setPropertyMap, setStaticDef, setStaticDefPublic

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addChildren, addDefImport, addExtendedDefObject, addSavedDocName, adjustPropertyMapForWrite, allocatePDef, allocatePropertyMap, allocatePropertyMapForEdits, applyDiffContents, baseIsWriteObject, beginDiffObjects, buildChildName, buildFileName, callFinishedLoading, checkEditable, checkEditableWithDefWriter, checkStructWithOld, close, createEditPDef, createFromXML, deregisterHLDef, diffChildrenHLDefs, diffChildrenProperties, diffContents, diffObjects, ensureDifferDetails, ensureDifferSkip, extractCustIntoPDef, findDefImport, finishedLoading, forgetChanges, getBaseDir, getChildren, getDefImports, getDefManager, getDefTypeName, getDefWriter, getDifferSkip, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getEditVersionsAsString, getExtendedDefObjectsInternal, getFullDirName, getFullFileName, getHLDefMap, getIdentificationAttributeName, getMajorVersion, getMergeableFullName, getMergeableName, getMinorVersion, getOrigObject, getPropertyMap, getPropertyNamesSet, getSavedDocNames, getSessionSyncLock, getSubstitutedNames, getSyncLock, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isCreateEditPDef, isCustomizationEnabled, isCustomizationEnabled, isEditable, isFromTip, isInheritPolicyStrict, isLoadBase, isLoadHLDefs, isMajorVersionChanged, isMinorVersionChanged, isNew, isNewRecurse, isPersonalizationEnabled, isPersonalizationEnabled, isPropertyExpression, isSaveToJSON, isSkipWrite, isWriteObject, loadDefImports, loadDefObject, loadXMLContentsNoResolve, lockDefinitionContext, lookupHLDef, makeNew, mergeChanges, mergeEditedPropertiesForJSON, objectRemoved, postSaveContents, readJSONObject, reapplyChanges, registerClass, registerHLDef, registerSiteDefObject, reloadFromXMLContents, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, saveJSONContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setEditableFlag, setEditableObject, setForRuntime, setFullNameInternal, setLoadBase, setLoadHLDefs, setMajorVersionChanged, setNew, setNewRecurse, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setSkipWrite, setupDefWriterFromMO, setWholeDefDirty, setWholeDefNew, staticUpdateChildrenList, transferDefChangesInto, unlockDefinitionContext, updateChildObject, updateChildrenList, updateMdsKeyFromTip, verifyVersion, verifyVersionNullCheck, writeHeaderForNew, writeJSONContents, writeObject, writeVersion, 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, isDynamicDefinitionObject, 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

Constructor Detail

PDefComponentOperations

@Concealed
public PDefComponentOperations()

For internal framework use only.

For internal use only. Application developers should not use this

Method Detail

setFullName

public void setFullName(java.lang.String fullName)

Description copied from class: NamedObjectImpl

Give this object a fully-qualified name.

Overrides:

setFullName in class PersDefBase

Parameters:

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

findStaticDefinitionObject

public DefinitionObject findStaticDefinitionObject(java.lang.String fullName)

Deprecated.

For internal framework use only.

Specified by:

findStaticDefinitionObject in interface PersonalizableDef

Specified by:

findStaticDefinitionObject in class PersDefBase

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

Overrides:

isDirty in class PersistableDefObject

Returns:

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

getScriptOps

@Concealed
public OperationDefinitionsImpl getScriptOps()

For internal use only. Application developers should not use this

removeScriptOp

@Concealed
public OperationDefinitionImpl removeScriptOp(java.lang.String name)

For internal use only. Application developers should not use this

addScriptOp

@Concealed
public void addScriptOp(OperationDefinitionImpl opDef)

For internal use only. Application developers should not use this

getScriptRowOps

@Concealed
public OperationDefinitionsImpl getScriptRowOps()

For internal use only. Application developers should not use this

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Deprecated.

For internal framework use only.

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class PersistableDefObject

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

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.

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 PersDefBase

Parameters:

jos - the Output storage for persistence

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

resolveDefObject

public void resolveDefObject()

Specified by:

resolveDefObject in interface PersonalizableDef

Overrides:

resolveDefObject in class PersDefBase

isObjectResolved

@Concealed
public boolean isObjectResolved()

Overrides:

isObjectResolved in class DefinitionObject

For internal use only. Application developers should not use this

getDefTypeId

@Concealed
public int getDefTypeId()

For internal use only. Application developers should not use this

setDefForComponent

@Concealed
protected void setDefForComponent(ComponentObjectImpl comp)

For internal use only. Application developers should not use this

unsetDefForComponent

@Concealed
protected void unsetDefForComponent(ComponentObjectImpl comp)

For internal use only. Application developers should not use this

findDefObject

@Concealed
public static PDefComponentOperations findDefObject(java.lang.String name)

For internal use only. Application developers should not use this

loadXMLContents

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

Overrides:

loadXMLContents in class PersDefBase

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace in class PersistableDefObject

setOwnerName

@Concealed
public void setOwnerName(java.lang.String name)

For internal use only. Application developers should not use this

setGlobal

@Concealed
public void setGlobal(boolean isGlobal)

For internal use only. Application developers should not use this

setEditable

public void setEditable(boolean editable)

Overrides:

setEditable in class PersistableDefObject

applyPersonalization

@Concealed
public void applyPersonalization(int mode,
                                            java.lang.Object inst)

For internal framework use only.

Specified by:

applyPersonalization in interface PersonalizableDef

Specified by:

applyPersonalization in class PersDefBase

For internal use only. Application developers should not use this

personalize

@Concealed
public void personalize(ComponentOperations compOps)

For internal use only. Application developers should not use this

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