oracle.jbo.server

Class ViewAccessorDef

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.server.DefObject

oracle.jbo.server.ViewAccessorDef

All Implemented Interfaces:

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

public class ViewAccessorDef
extends DefObject
implements ViewAccessor

Since:

release specific (what release of product did this appear in)

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

Constructor and Description
ViewAccessorDef()
ViewAccessorDef(java.lang.String name, java.lang.String viewDefFullName)
ViewAccessorDef(java.lang.String name, java.lang.String amUsageName, java.lang.String viewInstanceName)
ViewAccessorDef(ViewAccessorDef src) For internal framework use only.

Method Summary

Modifier and Type	Method and Description
void	addAppliedViewCriteria(PDefViewCriteria pVC)
void	addBoundParameter(java.lang.String name, ExpressionDef exprDef)
void	addBoundParameter(java.lang.String name, java.lang.String expr)
void	addBoundParameterUsingExprValueSupplier(java.lang.String name, ExpressionDef exprDef, java.lang.String viewDefFullName)
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:
void	applyViewAccessorVCs(ViewObjectImpl vo)
void	copyFrom(ViewAccessorDef other)
ViewObject	createViewObject(ApplicationModuleImpl am, java.lang.String voName)
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
DifferDetails	diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of scalar values.
java.lang.String	getAMUsageName()
java.util.List<PDefViewCriteria>	getAppliedViewCriterias()
java.util.ArrayList	getBoundParameterList()
BoundParameters	getBoundParameters()
RowDef	getDef()
int	getDefTypeId()
java.lang.String	getDefXMLElementTag()
java.lang.String	getExprEvalEntityUsageName()
static java.lang.String	getExprEvalEntityUsageNameFromRowSet(RowSet rs)
java.lang.String	getFileName()
java.lang.Class	getMessageBundleClass()
java.lang.String	getOrderBy()
ResourceBundleDef	getResourceBundleDef()
int	getResultIndex()
boolean	getRowLevelBinds()
java.lang.String	getViewDefFullName() Obtain the accessor view def full name.
java.lang.String	getViewInstanceName()
boolean	isDirty() This method returns if an Object is modified from last save/load
boolean	isEditable()
boolean	isForPersonalization()
boolean	isPreferredCriteriaAccessor()
boolean	isSharedInstance()
void	loadXMLContents(DefElement xmlElement, java.lang.String fullName)
PDefViewCriteria	lookupAppliedViewCriteria(java.lang.String name)
static ViewAccessorDef	lookupViewAccessorDef(java.lang.String vaDesc, ViewObjectImpl vo)
boolean	removeAppliedViewCriteria(java.lang.String name)
void	setAMUsageName(java.lang.String amUsageName)
protected void	setDefForComponent(ComponentObjectImpl comp)
void	setForPersonalization(boolean b)
void	setOrderBy(java.lang.String orderBy)
protected void	setParent(NamedObjectImpl parent) Sets this object's parent.
void	setResultIndex(int index)
void	setRowLevelBinds(boolean b)
void	setSharedInstance(boolean b)
void	setViewDefFullName(java.lang.String viewDefName)
void	setViewInstanceName(java.lang.String voName)
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.server.DefObject

addChildren, callFinishedLoading, ensureVariableManager, finishedLoading, getAdfmConfigStartupProperty, getAllProperties, getBaseDefObject, getBooleanAdfmConfigProperty, getDefXMLNameSpace, getVariableManager, getVarMgrParents, hasVariables, isDeprecated, isFromCustomization, loadProperties, loadVariables, resolvePropertyRaw, resolveReferences, setBaseDefObject, setBaseDefObject, setName

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addDefImport, addExtendedDefObject, addSavedDocName, adjustPropertyMapForWrite, allocatePDef, allocatePropertyMap, allocatePropertyMapForEdits, baseIsWriteObject, beginDiffObjects, buildChildName, buildFileName, checkEditable, checkEditableWithDefWriter, checkStructWithOld, close, createEditPDef, createFromXML, deregisterDefObject, deregisterHLDef, deregisterSessionObject, diffChildrenHLDefs, diffChildrenProperties, diffObjects, ensureDifferDetails, ensureDifferSkip, extractCustIntoPDef, findDefImport, forgetChanges, getBaseDir, getBasePackage, 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, getXMLElementTag, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isAutoMerged, isCreateEditPDef, isCustomizationEnabled, isCustomizationEnabled, 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, 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, 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.ViewAccessor

getName

Methods inherited from interface oracle.jbo.VariableManagerOwner

getName

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

getFullName

Methods inherited from interface oracle.jbo.PropertyManager

getProperty, removeProperty, setProperty

Constructor Detail

ViewAccessorDef

@Concealed
public ViewAccessorDef(ViewAccessorDef src)

For internal framework use only.

For internal use only. Application developers should not use this

ViewAccessorDef

public ViewAccessorDef()

ViewAccessorDef

public ViewAccessorDef(java.lang.String name,
                       java.lang.String viewDefFullName)

ViewAccessorDef

public ViewAccessorDef(java.lang.String name,
                       java.lang.String amUsageName,
                       java.lang.String viewInstanceName)

Method Detail

copyFrom

public void copyFrom(ViewAccessorDef other)

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.

isForPersonalization

public boolean isForPersonalization()

setForPersonalization

public void setForPersonalization(boolean b)

getDefTypeId

public int getDefTypeId()

Specified by:

getDefTypeId in class DefObject

getDef

public RowDef getDef()

isEditable

public boolean isEditable()

Overrides:

isEditable in class PersistableDefObject

getFileName

public java.lang.String getFileName()

Overrides:

getFileName in class PersistableDefObject

setParent

protected void setParent(NamedObjectImpl parent)

Description copied from class: DefObject

Sets this object's parent.

Overrides:

setParent in class DefObject

Parameters:

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

getMessageBundleClass

public java.lang.Class getMessageBundleClass()

Specified by:

getMessageBundleClass in interface VariableManagerOwnerBase

getResourceBundleDef

public ResourceBundleDef getResourceBundleDef()

Specified by:

getResourceBundleDef in interface VariableManagerOwnerBase

setDefForComponent

protected void setDefForComponent(ComponentObjectImpl comp)

Specified by:

setDefForComponent in class DefObject

unsetDefForComponent

protected void unsetDefForComponent(ComponentObjectImpl comp)

Specified by:

unsetDefForComponent in class DefObject

getViewDefFullName

public java.lang.String getViewDefFullName()

Description copied from interface: ViewAccessor

Obtain the accessor view def full name.

Specified by:

getViewDefFullName in interface ViewAccessor

Returns:

view def full name

setViewDefFullName

public void setViewDefFullName(java.lang.String viewDefName)

getAMUsageName

public java.lang.String getAMUsageName()

setAMUsageName

public void setAMUsageName(java.lang.String amUsageName)

getViewInstanceName

public java.lang.String getViewInstanceName()

setViewInstanceName

public void setViewInstanceName(java.lang.String voName)

isPreferredCriteriaAccessor

public boolean isPreferredCriteriaAccessor()

isSharedInstance

public boolean isSharedInstance()

setSharedInstance

public void setSharedInstance(boolean b)

getRowLevelBinds

public boolean getRowLevelBinds()

setRowLevelBinds

public void setRowLevelBinds(boolean b)

getOrderBy

public java.lang.String getOrderBy()

setOrderBy

public void setOrderBy(java.lang.String orderBy)

getAppliedViewCriterias

public java.util.List<PDefViewCriteria> getAppliedViewCriterias()

addAppliedViewCriteria

public void addAppliedViewCriteria(PDefViewCriteria pVC)

lookupAppliedViewCriteria

public PDefViewCriteria lookupAppliedViewCriteria(java.lang.String name)

removeAppliedViewCriteria

public boolean removeAppliedViewCriteria(java.lang.String name)

getBoundParameters

public BoundParameters getBoundParameters()

getBoundParameterList

public java.util.ArrayList getBoundParameterList()

addBoundParameter

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

addBoundParameter

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

addBoundParameterUsingExprValueSupplier

public void addBoundParameterUsingExprValueSupplier(java.lang.String name,
                                                    ExpressionDef exprDef,
                                                    java.lang.String viewDefFullName)

getResultIndex

public int getResultIndex()

setResultIndex

public void setResultIndex(int index)

createViewObject

@Concealed
public ViewObject createViewObject(ApplicationModuleImpl am,
                                              java.lang.String voName)

For internal use only. Application developers should not use this

Applications should not use this API

applyViewAccessorVCs

@Restricted
public void applyViewAccessorVCs(ViewObjectImpl vo)

For internal use only. Application developers should not use this

lookupViewAccessorDef

public static ViewAccessorDef lookupViewAccessorDef(java.lang.String vaDesc,
                                                    ViewObjectImpl vo)

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 DefObject

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

Overrides:

writeContents in class PersistableDefObject

Parameters:

jos - the Output storage for persistence

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class PersistableDefObject

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

Overrides:

diffContents 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

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 DefObject

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

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

Overrides:

applyDiffContents in class PersistableDefObject

Parameters:

dif - changes to be applied to 'this' def

resolver - the diff resolver used in diff/merge operation

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 DefObject

getExprEvalEntityUsageName

public java.lang.String getExprEvalEntityUsageName()

getExprEvalEntityUsageNameFromRowSet

public static java.lang.String getExprEvalEntityUsageNameFromRowSet(RowSet rs)