oracle.odi.domain.mapping.xreference

Class MapExpressionXRef

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.root.Root

oracle.odi.domain.mapping.xreference.MapExpressionXRef

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity, oracle.odi.domain.mapping.IMapReferenceOwner, IMappingObject, IRoot

public class MapExpressionXRef
extends oracle.odi.domain.root.Root
implements oracle.odi.domain.mapping.IMapReferenceOwner

A cross reference object that is used by expressions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MapExpressionXRef(MapExpression owner, IExpressionReferencedObject refObj, MapPathSpecifier pathSpec, java.lang.String refText, java.lang.String refKey) Constructs a cross reference to a mapping IExpressionReferencedObject, owned by the given MapExpression owner, using the given reference key.
MapExpressionXRef(MapExpression owner, IExpressionReferencedObject refObj, java.lang.String refText, java.lang.String refKey) Constructs a cross reference to a mapping IExpressionReferencedObject, owned by the given MapExpression owner, using the given reference key.
MapExpressionXRef(MapExpression owner, IModelObject modelObj, java.lang.String refText, java.lang.String refKey) Constructs a cross reference to external object, owned by the given MapExpression owner, using the given reference key.

Method Summary

Modifier and Type	Method and Description
java.util.List	getAllMapReferences()
java.lang.String	getContextualName() Gets the full name of the referenced object, relative to the referencing context component.
MapExpression	getExpression() Gets the owner expression.
java.lang.String	getMinimizedRefText() Gets the minimized reference text (which does not have qualifier names) from currently referenced object.
java.util.List	getOrderedReferencePathPoints() Get the list of reference path points that are owned by this expression xref, in path order, starting from the source point and moving to the target point.
java.lang.String	getOriginalRefText() Gets the original text that was parsed to create this cross reference.
IRoot	getOwner() Gets the owner of this cross reference.
MapPathSpecifier	getPathSpecifier() Return the path specifier for this reference, if one was specified, else null.
MapAttribute	getReferencedAttribute() Gets the attribute that is referenced by this cross reference object, if any.
IExpressionReferencedObject	getReferencedObject() Gets the mapping referenced object.
java.lang.String	getReferencePrefix() Gets a prefix that is used to delimit or escape the reference, such as "#" or ":" for sequence.
java.lang.String	getReferenceSuffix() Gets reference suffix that adds specific meaning to the reference key, for example .NEXTVAL for sequence reference.
java.lang.String	getRefKey() Gets the reference key for this cross reference, used to index it in the expression object.
java.lang.String	getRefText() Gets the reference text based on currently referenced object.
boolean	isAttributeReference() Checks if this cross reference references a MapAttribute.
boolean	isValid() Checks if this reference is still valid, as of the last time the cross reference was validated.
java.lang.String	toString()

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, getGUID, getInternalId, getName, getPropertyDefinitionOwner, getRootContainer, getStrongTypeClassName, getSyncState, getValueHolderValue, 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.IMapReferenceOwner

getRootContainer

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Constructor Detail

MapExpressionXRef

public MapExpressionXRef(MapExpression owner,
                         IModelObject modelObj,
                         java.lang.String refText,
                         java.lang.String refKey)
                  throws MappingException,
                         AdapterException

Constructs a cross reference to external object, owned by the given MapExpression owner, using the given reference key.

Parameters:

owner - the cross reference owner.

modelObj - the external object.

refText - the text for the reference, from the original expression text.

refKey - the reference key, used to index references in an expression.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

AdapterException

MappingException

MapExpressionXRef

public MapExpressionXRef(MapExpression owner,
                         IExpressionReferencedObject refObj,
                         java.lang.String refText,
                         java.lang.String refKey)
                  throws MappingException

Constructs a cross reference to a mapping IExpressionReferencedObject, owned by the given MapExpression owner, using the given reference key.

Parameters:

owner - the cross reference owner.

refObj - the mapping reference object.

refText - the text for the reference, from the original expression text.

refKey - the reference key, used to index references in an expression.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

MappingException

MapExpressionXRef

public MapExpressionXRef(MapExpression owner,
                         IExpressionReferencedObject refObj,
                         MapPathSpecifier pathSpec,
                         java.lang.String refText,
                         java.lang.String refKey)
                  throws MappingException

Constructs a cross reference to a mapping IExpressionReferencedObject, owned by the given MapExpression owner, using the given reference key.

Parameters:

owner - the cross reference owner.

refObj - the mapping reference object.

pathSpec - The referencing path for the cross reference.

refText - the text for the reference, from the original expression text.

refKey - the reference key, used to index references in an expression.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

MappingException

Method Detail

getReferencedObject

public IExpressionReferencedObject getReferencedObject()

Gets the mapping referenced object.

Returns:

the referenced object.

getReferencedAttribute

public MapAttribute getReferencedAttribute()

Gets the attribute that is referenced by this cross reference object, if any. If the cross reference does not reference an attribute, return null.

Returns:

referenced MapAttribute object.

isAttributeReference

public boolean isAttributeReference()

Checks if this cross reference references a MapAttribute.

Returns:

true if the referenced object is of type MapAttribute, false otherwise.

getContextualName

public java.lang.String getContextualName()

Gets the full name of the referenced object, relative to the referencing context component.

Returns:

the full name of the referenced object.

getRefKey

public java.lang.String getRefKey()

Gets the reference key for this cross reference, used to index it in the expression object.

Returns:

the reference key of the cross reference.

isValid

public boolean isValid()

Checks if this reference is still valid, as of the last time the cross reference was validated.

Returns:

true if the cross reference is valid, false otherwise.

getOriginalRefText

public java.lang.String getOriginalRefText()

Gets the original text that was parsed to create this cross reference.

Returns:

the original reference text.

getRefText

public java.lang.String getRefText()
                            throws AdapterException

Gets the reference text based on currently referenced object.

Returns:

reference text calculated from currently referenced object if it exists, or the original reference text.

Throws:

AdapterException

getMinimizedRefText

public java.lang.String getMinimizedRefText()
                                     throws AdapterException

Gets the minimized reference text (which does not have qualifier names) from currently referenced object.

Returns:

the minimized reference text if current referenced object exists, or return the original minimized reference text.

Throws:

AdapterException

getOwner

public IRoot getOwner()

Gets the owner of this cross reference.

Specified by:

getOwner in interface IRoot

Specified by:

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

Returns:

the owner.

getExpression

public MapExpression getExpression()

Gets the owner expression.

Returns:

the owner expression.

getReferencePrefix

public java.lang.String getReferencePrefix()

Gets a prefix that is used to delimit or escape the reference, such as "#" or ":" for sequence. Returns a blank string if no prefix is required.

Returns:

the reference prefix.

getReferenceSuffix

public java.lang.String getReferenceSuffix()

Gets reference suffix that adds specific meaning to the reference key, for example .NEXTVAL for sequence reference.

Returns:

the reference suffix.

toString

public java.lang.String toString()

Overrides:

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

getAllMapReferences

public java.util.List getAllMapReferences()

Specified by:

getAllMapReferences in interface oracle.odi.domain.mapping.IMapReferenceOwner

getPathSpecifier

public MapPathSpecifier getPathSpecifier()

Return the path specifier for this reference, if one was specified, else null.

getOrderedReferencePathPoints

public java.util.List getOrderedReferencePathPoints()

Get the list of reference path points that are owned by this expression xref, in path order, starting from the source point and moving to the target point.

Returns: