oracle.jbo.server

Class AssociationEnd

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.server.DefObject

oracle.jbo.server.AssociationEnd

All Implemented Interfaces:

DiffMergeable, DefPersistable, PersistentDefinition, VariableManagerOwner, VariableManagerOwnerBase

public class AssociationEnd
extends DefObject

 NAME
      AssociationEnd.java -
 DESCRIPTION


 NOTES


 VERSION
 MODIFIED   (MM/DD/YY)
 

Nested Class Summary

Nested classes/interfaces inherited from class oracle.jbo.mom.PersistableDefObject

PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mAliasName
protected AttributeDefImpl[]	mColumnAttrs
protected java.util.ArrayList	mColumns
protected java.lang.String	mDBObjectName
protected boolean	mIntersectInit
protected java.lang.String	mOrderByClause

Fields inherited from class oracle.jbo.mom.PersistableDefObject

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

XML_STATEMENT

Method Summary

Modifier and Type	Method and Description
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:
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.
AssociationDefImpl	getAccessor()
java.lang.String	getAliasName()
java.util.List	getAttrDefNames()
AttributeDefImpl[]	getAttributeDefImpls()
java.util.ArrayList	getAttributeNames()
int	getCardinality()
java.util.ArrayList	getColumns()
java.lang.String	getDBObjectName()
int	getDefTypeId()
java.lang.String	getDefXMLElementTag()
java.util.List	getIntersectAttrDefNames()
java.lang.String	getLockLevelStr(boolean nullForDefault)
oracle.jbo.server.AssociationEnd.LockLevel	getLockLevelValue(java.lang.String s, boolean processDefault)
java.lang.Class	getMessageBundleClass()
java.lang.String	getOrderByClause()
DefObject	getOwner()
java.lang.String	getOwnerName()
ResourceBundleDef	getResourceBundleDef()
boolean[]	getUnboundAttributeFlags()
java.lang.String[]	getUnboundAttributeNames()
byte	getUpdateableFlag()
ViewDefImpl	getUsesViewObject()
java.lang.String	getUsesViewObjectName()
java.lang.String	getViewCriteriaName()
boolean	hasContainer()
boolean	isCascadeDelete()
boolean	isCascadeUpdate()
boolean	isCustomWhere()
boolean	isDeleteContainee()
boolean	isEffectiveDated()
boolean	isEffectiveDatedDuringJoin() EffectiveDatedDuringJoin controls if the entity usages are effective dated when the join view definition is created.
boolean	isLockContainer()
boolean	isLockTopContainer()
boolean	isPartitionUsingWhereClause()
boolean	isSource()
boolean	isSuppressEvent()
boolean	isUpdateHistoryColumn()
void	loadXMLContents(DefElement xmlElement, java.lang.String fullName)
protected void	resolveIntersectColumns()
void	setAliasName(java.lang.String s)
void	setAttributeDefImpls(AttributeDefImpl[] attrs)
void	setAttributeNames(java.util.ArrayList arr)
void	setCardinality(int i)
void	setCascadeDelete(boolean b)
void	setCascadeUpdate(boolean b)
void	setDBObjectName(java.lang.String s)
protected void	setDefForComponent(ComponentObjectImpl comp)
void	setDeleteContainee(boolean b)
void	setDirty(boolean b) This method marks the Object dirty
void	setEffectiveDated(boolean b)
void	setEffectiveDatedDuringJoin(boolean b) Controls if the entity usages are effective dated when the join view definition is created.
void	setHasContainer(boolean b)
void	setLockContainer(boolean b) Sets flag to lock only the immediate container in this composition hierarchy.
void	setLockLevel(oracle.jbo.server.AssociationEnd.LockLevel b) Sets flag to lock the topmost container in this composition hierarchy.
void	setLockTopContainer(boolean b) Sets flag to lock the topmost container in this composition hierarchy.
void	setOrderByClause(java.lang.String s)
void	setOwner(DefObject owner)
void	setOwnerName(java.lang.String ownerName)
protected void	setParent(NamedObjectImpl parent) Sets this object's parent.
void	setPartitionUsingWhereClause(boolean b)
void	setSource(boolean b)
void	setSuppressEvent(boolean b)
void	setUnboundAttributeNames(java.lang.String[] arr)
void	setUpdateableFlag(byte updateable)
void	setUpdateHistoryColumn(boolean b)
void	setUsesViewObject(ViewDefImpl usesViewObject)
void	setUsesViewObjectName(java.lang.String usesViewObjectName)
protected void	setViewCriteriaName(java.lang.String vcName)
void	setViewCriteriaName2(java.lang.String vcName)
protected void	unsetDefForComponent(ComponentObjectImpl comp)
boolean	useFindByKey()
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

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, allocatePropertyMap, allocatePropertyMapForEdits, beginDiffObjects, checkEditable, checkStructWithOld, close, createFromXML, deregisterDefObject, deregisterSessionObject, diffObjects, ensureDifferDetails, findDefImport, getBaseDir, getBasePackage, getDefImports, getDefManager, getDefTypeName, getDefWriter, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getEditVersionsAsString, getExtendedDefObjectsInternal, getFileName, getFullDirName, getFullFileName, getMajorVersion, getMergeableFullName, getMergeableName, getMinorVersion, getOrigObject, getPropertyMap, getSavedDocNames, getSessionSyncLock, getSubstitutedNames, getSyncLock, getXMLElementTag, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isCustomizationEnabled, isCustomizationEnabled, isDirty, isEditable, isFromTip, isLoadBase, isMajorVersionChanged, isMinorVersionChanged, isNew, isPersonalizationEnabled, isPersonalizationEnabled, isPropertyExpression, loadDefImports, loadDefObject, loadXMLContentsNoResolve, lockDefinitionContext, mergeChanges, mergePropertyMap, objectRemoved, reapplyChanges, registerClass, registerDefObject, registerSessionDefObject, registerSiteDefObject, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setEditable, setEditableFlag, setEditableObject, setFullName, setFullNameInternal, setLoadBase, setMajorVersionChanged, setNew, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, setupDefWriterFromMO, staticUpdateChildrenList, unlockDefinitionContext, updateChildrenList, updateMdsKeyFromTip, verifyVersion, verifyVersionNullCheck, writeHeaderForNew, writeObject, writeVersion, writeXMLContents

Methods inherited from class oracle.jbo.mom.DefinitionObject

addPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getContainerDef, getContainerName, getDefinitionState, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, getRootBaseDefObject, isBaseDefFor, isComponentDefinition, isDynamicDefinitionObject, isObjectResolved, isSubtypeOf, isSuppressUpdateCheck, loadCustomProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, 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, getPropertyNamesSet, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setPropertiesMap, setPropertiesMap2, setProperty

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.mom.xml.DefPersistable

getFullName

Field Detail

mDBObjectName

protected java.lang.String mDBObjectName

mAliasName

protected java.lang.String mAliasName

mOrderByClause

protected java.lang.String mOrderByClause

mColumns

protected java.util.ArrayList mColumns

mColumnAttrs

protected AttributeDefImpl[] mColumnAttrs

mIntersectInit

protected boolean mIntersectInit

Method Detail

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.

setDirty

public void setDirty(boolean b)

Description copied from interface: DefPersistable

This method marks the Object dirty

Specified by:

setDirty in interface DefPersistable

Overrides:

setDirty in class PersistableDefObject

Parameters:

b - If true the Object is marked Dirty.

resolveIntersectColumns

protected void resolveIntersectColumns()

getDefTypeId

public int getDefTypeId()

Specified by:

getDefTypeId in class DefObject

setDefForComponent

protected void setDefForComponent(ComponentObjectImpl comp)

Specified by:

setDefForComponent in class DefObject

unsetDefForComponent

protected void unsetDefForComponent(ComponentObjectImpl comp)

Specified by:

unsetDefForComponent in class DefObject

setViewCriteriaName2

public void setViewCriteriaName2(java.lang.String vcName)

setViewCriteriaName

protected void setViewCriteriaName(java.lang.String vcName)

getAccessor

public AssociationDefImpl getAccessor()

getOwner

public DefObject getOwner()

setOwner

public void setOwner(DefObject owner)

getOwnerName

public java.lang.String getOwnerName()

setOwnerName

public void setOwnerName(java.lang.String ownerName)

getUsesViewObject

public ViewDefImpl getUsesViewObject()

getViewCriteriaName

public java.lang.String getViewCriteriaName()

setUsesViewObject

public void setUsesViewObject(ViewDefImpl usesViewObject)

getUsesViewObjectName

public java.lang.String getUsesViewObjectName()

setUsesViewObjectName

public void setUsesViewObjectName(java.lang.String usesViewObjectName)

isSource

public boolean isSource()

setSource

public void setSource(boolean b)

getUpdateableFlag

public byte getUpdateableFlag()

setUpdateableFlag

public void setUpdateableFlag(byte updateable)

isCascadeUpdate

public boolean isCascadeUpdate()

setCascadeUpdate

public void setCascadeUpdate(boolean b)

isCascadeDelete

public boolean isCascadeDelete()

setCascadeDelete

public void setCascadeDelete(boolean b)

isDeleteContainee

public boolean isDeleteContainee()

setDeleteContainee

public void setDeleteContainee(boolean b)

setLockLevel

public void setLockLevel(oracle.jbo.server.AssociationEnd.LockLevel b)

Sets flag to lock the topmost container in this composition hierarchy.

isLockTopContainer

public boolean isLockTopContainer()

setLockTopContainer

public void setLockTopContainer(boolean b)

Sets flag to lock the topmost container in this composition hierarchy.

isLockContainer

public boolean isLockContainer()

setLockContainer

public void setLockContainer(boolean b)

Sets flag to lock only the immediate container in this composition hierarchy. TopLevel container is not locked based on this flag.

isUpdateHistoryColumn

public boolean isUpdateHistoryColumn()

setUpdateHistoryColumn

public void setUpdateHistoryColumn(boolean b)

hasContainer

public boolean hasContainer()

setHasContainer

public void setHasContainer(boolean b)

getCardinality

public int getCardinality()

setCardinality

public void setCardinality(int i)

useFindByKey

public boolean useFindByKey()

getDBObjectName

public java.lang.String getDBObjectName()

setDBObjectName

public void setDBObjectName(java.lang.String s)

getAliasName

public java.lang.String getAliasName()

setAliasName

public void setAliasName(java.lang.String s)

getOrderByClause

public java.lang.String getOrderByClause()

setOrderByClause

public void setOrderByClause(java.lang.String s)

getColumns

public java.util.ArrayList getColumns()

getIntersectAttrDefNames

public java.util.List getIntersectAttrDefNames()

isSuppressEvent

public boolean isSuppressEvent()

setSuppressEvent

public void setSuppressEvent(boolean b)

isEffectiveDated

public boolean isEffectiveDated()

setEffectiveDated

public void setEffectiveDated(boolean b)

isEffectiveDatedDuringJoin

public boolean isEffectiveDatedDuringJoin()

EffectiveDatedDuringJoin controls if the entity usages are effective dated when the join view definition is created. See setEffectiveDatedDuringJoin(boolean).

Returns:

a boolean of the option

setEffectiveDatedDuringJoin

public void setEffectiveDatedDuringJoin(boolean b)

Controls if the entity usages are effective dated when the join view definition is created. For example consider an association between Person and TaxBracket entities with both being effective dated. Consider PersonTaxRecord view definition that contains a join of both Person and TaxRecord Entity usages based on the above association. If the Person's date of birth drives the effective date of TaxRecord then we don't want the framework to generate effective date where clause for TaxRecord usage. Instead we can have a view criteria or a custom where clause to generate Person.Birthdate between TaxRecord.StarEffectiveDate and TaxRecord.EndEffectiveDate. In the above association mark EffectiveDatedDuringJoin property of TaxBracket end of the association to false.

Parameters:

b - a flag to change the behavior as explained above.

getAttributeDefImpls

public AttributeDefImpl[] getAttributeDefImpls()

setAttributeDefImpls

public void setAttributeDefImpls(AttributeDefImpl[] attrs)

getAttributeNames

public java.util.ArrayList getAttributeNames()

getAttrDefNames

public java.util.List getAttrDefNames()

setAttributeNames

public void setAttributeNames(java.util.ArrayList arr)

getUnboundAttributeFlags

public boolean[] getUnboundAttributeFlags()

getUnboundAttributeNames

public java.lang.String[] getUnboundAttributeNames()

setUnboundAttributeNames

public void setUnboundAttributeNames(java.lang.String[] arr)

isPartitionUsingWhereClause

public boolean isPartitionUsingWhereClause()

setPartitionUsingWhereClause

public void setPartitionUsingWhereClause(boolean b)

isCustomWhere

public boolean isCustomWhere()

getMessageBundleClass

public java.lang.Class getMessageBundleClass()

getResourceBundleDef

public ResourceBundleDef getResourceBundleDef()

getLockLevelValue

public oracle.jbo.server.AssociationEnd.LockLevel getLockLevelValue(java.lang.String s,
                                                                    boolean processDefault)

getLockLevelStr

public java.lang.String getLockLevelStr(boolean nullForDefault)

loadXMLContents

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

Overrides:

loadXMLContents in class PersistableDefObject

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class PersistableDefObject

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

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

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)
    {
        orgDefImpl = () 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();

          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