oracle.jbo.server

Class BoundParameters

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.server.BoundParameters

All Implemented Interfaces:

DiffMergeable, DiffSkippable, DefPersistable, PersistentDefinition, PropertyManager

Direct Known Subclasses:

ListBindParameters, RowFinderParameters

public class BoundParameters
extends PersistableDefObject

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	BoundParameters(DefinitionManager defMgr, int defScope)
	BoundParameters(int defScope)

Method Summary

Modifier and Type	Method and Description
void	addBoundParameter(BoundParameter param) Add a BoundParameter to the parameter list.
BoundParameter	addBoundParameter(DefElement elem)
void	addBoundParameter(java.lang.String name, ExpressionDef exprDef)
void	addBoundParameter(java.lang.String name, java.lang.String expr)
void	addBoundParameter(VariableImpl param) Deprecated. - use addBoundParameter(BoundParameter) instead.
BoundParameter	addBoundParameterWithExpression(java.lang.String name, java.lang.String expr)
void	applyDiffChildren(DifferDetails dif, DiffResolver resolver) Applies changes to children defs.
protected BoundParameter	createBoundParameter()
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
protected BoundParameter	getBoundParameter(java.lang.String name)
java.util.ArrayList	getBoundParameterList()
java.util.List<BoundParameter>	getBoundParameters()
java.lang.String	getDefXMLElementTag()
java.lang.String	getDefXMLNameSpace()
java.lang.String	getFullName() Gets this object's fully-qualified name.
java.lang.String	getMergeableFullName() Returns the fully qualified name of the diff-mergeable definition object.
java.lang.String	getName() Get the name of this object.
protected java.lang.String	getVarMapXMLElementTag()
boolean	isDirty() This method returns if an Object is modified from last save/load
void	loadXMLContents(DefElement xmlElement, java.lang.String fullName)
boolean	removeBoundParameter(java.lang.String name)
void	setDirty(boolean dirty) This method marks the Object dirty
int	size()
void	writeChildren(DefWriter jos) Writes the Object's children to the Persistent storage

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, deregisterDefObject, deregisterHLDef, deregisterSessionObject, diffChildrenHLDefs, diffChildrenProperties, diffContents, diffObjects, ensureDifferDetails, ensureDifferSkip, extractCustIntoPDef, findDefImport, finishedLoading, forgetChanges, getBaseDir, getBasePackage, getChildren, getDefImports, getDefManager, getDefTypeName, getDefWriter, getDifferSkip, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getEditVersionsAsString, getExtendedDefObjectsInternal, getFileName, getFullDirName, getFullFileName, getHLDefMap, getIdentificationAttributeName, getMajorVersion, getMergeableName, getMinorVersion, getOrigObject, getPropertyMap, getPropertyNamesSet, getSavedDocNames, getSessionSyncLock, getSubstitutedNames, getSyncLock, getXMLElementTag, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isAutoMerged, 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, mergePropertyMap, objectRemoved, postSaveContents, readJSONObject, reapplyChanges, registerClass, registerDefObject, registerHLDef, registerSessionDefObject, registerSiteDefObject, reloadFromXMLContents, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveJSONContents, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, 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, 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, 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.PropertyManager

getProperty, removeProperty, setProperty

Constructor Detail

BoundParameters

protected BoundParameters(DefinitionManager defMgr,
                          int defScope)

BoundParameters

public BoundParameters(int defScope)

Method Detail

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.

setDirty

public void setDirty(boolean dirty)

Description copied from interface: DefPersistable

This method marks the Object dirty

Specified by:

setDirty in interface DefPersistable

Overrides:

setDirty in class PersistableDefObject

Parameters:

dirty - If true the Object is marked Dirty.

getName

public java.lang.String getName()

Description copied from class: NamedObjectImpl

Get the name of this object.

Overrides:

getName in class NamedObjectImpl

Returns:

the name given to this object.

getFullName

public java.lang.String getFullName()

Description copied from class: NamedObjectImpl

Gets this object's fully-qualified name.

Specified by:

getFullName in interface DefPersistable

Overrides:

getFullName in class NamedObjectImpl

Returns:

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

getMergeableFullName

public java.lang.String getMergeableFullName()

Description copied from interface: DiffMergeable

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

Specified by:

getMergeableFullName in interface DiffMergeable

Overrides:

getMergeableFullName in class PersistableDefObject

Returns:

full name of the def object

size

public int size()

getBoundParameterList

public java.util.ArrayList getBoundParameterList()

getBoundParameters

public java.util.List<BoundParameter> getBoundParameters()

Returns:

a read-only list of BoundParameter

createBoundParameter

protected BoundParameter createBoundParameter()

getBoundParameter

protected BoundParameter getBoundParameter(java.lang.String name)

addBoundParameter

@Concealed
public BoundParameter addBoundParameter(DefElement elem)

For internal use only. Application developers should not use this

addBoundParameter

@Restricted
public void addBoundParameter(java.lang.String name,
                                          java.lang.String expr)

For internal use only. Application developers should not use this

addBoundParameterWithExpression

@Concealed
public BoundParameter addBoundParameterWithExpression(java.lang.String name,
                                                                 java.lang.String expr)

For internal use only. Application developers should not use this

addBoundParameter

@Restricted
public void addBoundParameter(VariableImpl param)

Deprecated. - use addBoundParameter(BoundParameter) instead.

For internal use only. Application developers should not use this

addBoundParameter

@Concealed
public void addBoundParameter(java.lang.String name,
                                         ExpressionDef exprDef)

For internal use only. Application developers should not use this

addBoundParameter

public void addBoundParameter(BoundParameter param)

Add a BoundParameter to the parameter list.

Parameters:

param - parameter to be added.

removeBoundParameter

public boolean removeBoundParameter(java.lang.String name)

loadXMLContents

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

Overrides:

loadXMLContents in class PersistableDefObject

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

getVarMapXMLElementTag

protected java.lang.String getVarMapXMLElementTag()

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class PersistableDefObject

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace 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