oracle.odi.domain.mapping

Class MapReference

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.root.Root

oracle.odi.domain.mapping.MapReference

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IModelObjectReference, IRepositoryEntity, IExpressionReferencedObject, IMappingObject, IRoot

public class MapReference
extends oracle.odi.domain.root.Root
implements IExpressionReferencedObject, IModelObjectReference

A class that references one external model object. The model object could be an ODI model object such as a datastore, variable, or sequence, or it could be a model object from a foreign repository such as BI Apps. The referenced object must implement a standard IModelObject interface. If an object that is to be referenced does not implement this interface, then an adapter object can be created that will wrap the foreign model object, and will implement the standard model object interface.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getFCOBigNumericId() Gets the first class object numeric ID of this reference.
java.lang.String	getFCOGlobalId() Gets the first class object global id.
java.lang.Integer	getFCONumericId() Deprecated.
IModelObject	getFCOObject() Gets the first class object referenced by this map reference.
java.lang.String	getFCOQualifiedName() Gets the fully qualified name for the first class object.
java.lang.String	getFullQualifiedName() Gets a combination of FCO qualified name (if any) and the referenced object qualified name.
java.lang.String	getName() Gets the name of the referenced object.
IMapping	getOwnerMapping() Gets the mapping that owns this map reference.
IModelObject	getReferencedObject() Gets the referenced object.
java.lang.String	getReferencedObjectName() Gets a fully qualified displayable name for the referenced object.
IModelObject	getReferencedShortcutObject() Gets the referenced object accessed through a shortcut.
java.lang.Number	getRefObjectBigNumericId() Gets the numeric ID of the referenced object.
java.lang.String	getRefObjectGlobalId() Gets the global id of the referenced object.
java.lang.Integer	getRefObjectNumericId() Deprecated.
java.lang.String	getRefText() Gets the reference text of this map reference.
IMapRootContainer	getRootContainerOwner() Gets the map root container of this reference.
java.lang.Number	getShortcutRefObjectBigNumericId() Gets the numeric ID for a reference to a shortcut object.
java.lang.Integer	getShortcutRefObjectNumericId() Deprecated.
int	getUsageCount() Get the usage count for this reference, which is the number of distinct mapping objects are using the reference.
boolean	isReferenceEquals(MapReference otherRef) Return true if this reference points to the same exact object as the specified other reference.
boolean	isReferenceValid() Checks if the referenced object is found (reference resolved).
void	refresh(boolean entityManagerRefresh) Forces the reference to be re-resolved by finding the referenced object using the persistence context.
java.lang.String	toString()
void	validateReference(java.lang.Object parentObj) Attempts to resolve the reference, and if found, updates the global id, numeric id, and qualified name fields.

Methods inherited from class oracle.odi.domain.root.Root

addCachedIssue, addCachedIssues, clearIssueCache, delete, displayIssues, displayIssues, displayIssues, dump, dump, dump, dump, dumpToString, equals, getCachedErrors, getCachedSyncState, getCachedValidationErrorMessage, getChildNamespaceId, getDisplayableObjectName, getFCOContainer, getFullName, getGUID, getInternalId, getPropertyDefinitionOwner, getRootContainer, getStrongTypeClassName, getSyncState, getValueHolderValue, handleMapChangeEvent, hasAdapter, hashCode, isNew, setCachedSyncState, validate, validate, validate

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

getBigNumericId, getGlobalId, getNumericId, getParent

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.domain.mapping.xreference.IExpressionReferencedObject

getBigNumericId, getNumericId

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Method Detail

getReferencedObject

public IModelObject getReferencedObject()
                                 throws AdapterException

Gets the referenced object.

Specified by:

getReferencedObject in interface IModelObjectReference

Returns:

the referenced object.

Throws:

AdapterException

isReferenceValid

public boolean isReferenceValid()

Checks if the referenced object is found (reference resolved).

Returns:

true if referenced object exists in the repository, false otherwise.

isReferenceEquals

public boolean isReferenceEquals(MapReference otherRef)

Return true if this reference points to the same exact object as the specified other reference. This will return false if one of the references being compared is a shortcut and the other is not.

Parameters:

otherRef - The reference to compare to this one.

Returns:

True if both references point to the exact same object.

getFullQualifiedName

public java.lang.String getFullQualifiedName()

Gets a combination of FCO qualified name (if any) and the referenced object qualified name.

Returns:

fully qualified name of the referenced object.

getRefObjectGlobalId

public java.lang.String getRefObjectGlobalId()

Gets the global id of the referenced object.

Specified by:

getRefObjectGlobalId in interface IModelObjectReference

Returns:

global id of the referenced object.

getFCOQualifiedName

public java.lang.String getFCOQualifiedName()

Gets the fully qualified name for the first class object. The referenced object may not be a second class object, such as a column, and this map reference also records the parent object of the reference object.

Specified by:

getFCOQualifiedName in interface IModelObjectReference

Returns:

the fully qualified name of the first class object.

getRootContainerOwner

public IMapRootContainer getRootContainerOwner()

Gets the map root container of this reference.

Returns:

the root container.

getName

public java.lang.String getName()

Gets the name of the referenced object.

Specified by:

getName in interface IModelObjectReference

Specified by:

getName in interface IExpressionReferencedObject

Specified by:

getName in interface IRoot

Overrides:

getName in class oracle.odi.domain.root.Root

Returns:

name of the referenced object.

getRefText

public java.lang.String getRefText()
                            throws AdapterException

Gets the reference text of this map reference. Reference text is the pattern that can be used in an expression text to find appearance of this reference.

Specified by:

getRefText in interface IExpressionReferencedObject

Returns:

the reference text for this map reference for pattern matching an expression text.

Throws:

AdapterException

getRefObjectNumericId

public java.lang.Integer getRefObjectNumericId()

Deprecated.

Specified by:

getRefObjectNumericId in interface IModelObjectReference

Returns:

numberic ID of the object

getRefObjectBigNumericId

public java.lang.Number getRefObjectBigNumericId()

Description copied from interface: IModelObjectReference

Gets the numeric ID of the referenced object.

Specified by:

getRefObjectBigNumericId in interface IModelObjectReference

Returns:

numberic ID of the object

getFCONumericId

public java.lang.Integer getFCONumericId()

Deprecated.

Specified by:

getFCONumericId in interface IModelObjectReference

Returns:

first class object numeric ID.

getFCOBigNumericId

public java.lang.Number getFCOBigNumericId()

Description copied from interface: IModelObjectReference

Gets the first class object numeric ID of this reference.

Specified by:

getFCOBigNumericId in interface IModelObjectReference

Returns:

first class object numeric ID.

getReferencedObjectName

public java.lang.String getReferencedObjectName()

Gets a fully qualified displayable name for the referenced object. If the reference is not resolvable, then return the original qualified name stored in the reference, with an indicator that shows it is not resolved.

Returns:

the fully qualified name of the reference object if it exists, otherwise, returns the original fully qualified name. For the latter case, a marker "[UNRESOLVED]" is appended to the result.

validateReference

public void validateReference(java.lang.Object parentObj)
                       throws AdapterException,
                              MappingException

Attempts to resolve the reference, and if found, updates the global id, numeric id, and qualified name fields. The parent object can be a different parent that the original parent, in that case the reference target is changed and the reference is resolved using the parent object and the object name parsed out from the original qualified name. This can be used for shortcut materialization.

Parameters:

parentObj - The new parent object to be used to resolve the reference. If null, then the original object is found.

Throws:

AdapterException

MappingException

getShortcutRefObjectNumericId

public java.lang.Integer getShortcutRefObjectNumericId()

Deprecated.

Specified by:

getShortcutRefObjectNumericId in interface IModelObjectReference

Returns:

numeric ID of a shortcut object.

getShortcutRefObjectBigNumericId

public java.lang.Number getShortcutRefObjectBigNumericId()

Description copied from interface: IModelObjectReference

Gets the numeric ID for a reference to a shortcut object.

Specified by:

getShortcutRefObjectBigNumericId in interface IModelObjectReference

Returns:

numeric ID of a shortcut object.

getReferencedShortcutObject

public IModelObject getReferencedShortcutObject()
                                         throws AdapterException

Gets the referenced object accessed through a shortcut. If this map reference does not point to a shortcut, a null is returned.

Specified by:

getReferencedShortcutObject in interface IModelObjectReference

Returns:

the referenced object by the shortcut referenced by this map reference, or null if this map reference does not reference a shortcut.

Throws:

AdapterException

getFCOGlobalId

public java.lang.String getFCOGlobalId()

Gets the first class object global id. The directly referenced object by this map reference could only be a second class object. In that case, this method gives information about which is the parent object of the directly referenced object.

Specified by:

getFCOGlobalId in interface IModelObjectReference

Returns:

the first class object global id of the referenced object.

getFCOObject

public IModelObject getFCOObject()
                          throws AdapterException

Gets the first class object referenced by this map reference. The directly referenced object by this map reference could only be a second class object. In that case, this method gives information about which is the parent object of the directly referenced object.
This method may return null if this reference is not yet resolved.

Specified by:

getFCOObject in interface IModelObjectReference

Returns:

the referenced first class object.

Throws:

AdapterException

toString

public java.lang.String toString()

Overrides:

toString in class oracle.odi.domain.root.Root

refresh

public void refresh(boolean entityManagerRefresh)
             throws AdapterException

Forces the reference to be re-resolved by finding the referenced object using the persistence context.

Parameters:

entityManagerRefresh - If true, it will detach the referenced object from the persistence context which will force a re-query of the object from the database. Use to detect object deletion in an external transaction.

Throws:

AdapterException

getOwnerMapping

public IMapping getOwnerMapping()
                         throws AdapterException

Gets the mapping that owns this map reference.

Specified by:

getOwnerMapping in interface IModelObjectReference

Returns:

the owner mapping

Throws:

AdapterException

getUsageCount

public int getUsageCount()

Get the usage count for this reference, which is the number of distinct mapping objects are using the reference.

Returns:

The usage count.