oracle.odi.domain.mapping.physical

Class MapPhysicalExpression

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.root.Root

oracle.odi.domain.mapping.physical.MapPhysicalExpression

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IModelObject, IModelObjectBase, IMapExpression, IRepositoryEntity, IMapExpressionOwner, oracle.odi.domain.mapping.IMapReferenceOwner, IExpressionReferencedObject, IMappingObject, IRoot

public class MapPhysicalExpression
extends oracle.odi.domain.root.Root
implements IMapExpressionOwner, oracle.odi.domain.mapping.IMapReferenceOwner, IExpressionReferencedObject, IMapExpression

A class representing the physical usage of an attribute expression in the logical graph. Some attribute expressions can be pushed to another physical node in the physical graph, possibly in another execution unit, for execution. The rules for when the expressions can be pushed are as follows:

1) An expression cannot be pushed through a projector component, only through selector components.

2) If an expression is pushed upstream (for example from a target attribute), the component to which it is pushed must have all the expression's referenced attributes in scope.

3) If an expression is pushed downstream (for example from an expression component attribute), it cannot be pushed past a component where the expression is used.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
MapPhysicalExpression	findSourcePhysicalExpression() Find the source physical expression corresponding to this pushed physical expression.
MapPhysicalExpression	findTargetPhysicalExpression() Find the target physical expression that was pushed to another node from this expression.
java.lang.String	getAlias()
java.util.List	getAllMapReferences()
MapPhysicalNode	getCurrentExecutionNode() Return the node where the expression will be executed.
ExecutionUnit	getCurrentExecutionUnit() Return the execution unit where this physical expression will be executed.
java.lang.String	getDisplayableTypeName() Get a user-displayable type name for the object.
MapAttribute	getGeneratedLogicalAttribute() Get MapAttribute from generated logical expression.
MapExpression	getGeneratedLogicalExpression() Get the logical expression that should be generated for this physical expression.
java.lang.String	getGeneratedParsedText()
java.lang.String	getGeneratedText()
IMapRootContainer	getMapRootContainer() Get the owning root container for this object.
java.lang.String	getMinimizedRefText() Gets the minimized reference text for this object.
IPropertyOwner	getOwner() Gets the mapping owner (or parent) of this object.
ExecutionUnit	getOwningExecutionUnit()
MapPhysicalNode	getOwningNode() Get the physical node that owns this expression.
MapPhysicalNode	getPushedFrom()
MapPhysicalNode	getPushToNode() Get the physical node to which this expression has been pushed.
ExecutionUnit	getPushToUnit()
java.util.List	getPushToUnitCandidates() Get a list of execution units to which this expression can be pushed.
MapExpression	getRefLogicalExpression() Get the referenced logical expression for this physical expression object.
IExpressionReferencedObject	getRefObject()
java.lang.String	getRefText() Gets the reference text for this object.
MapPhysicalNode	getSourceNode() Get the source node that corresponds to the logical component that owns the logical expression.
int	hashCode()
boolean	hasSequence()
boolean	isPushed()
boolean	isPushedDueToHint()
boolean	isPushedFromOtherNode()
boolean	isPushToAllowed(ExecutionUnit exUnit) Return true if this node can legally be pushed to the specified execution unit.
RootIssue	isPushToAllowed(MapPhysicalNode node) Return true if it is allowed to push the evaluation of the expression to the specified physical node.
void	pushTo(ExecutionUnit exUnit) Push the expression execution to the specified execution unit.
void	pushTo(MapPhysicalNode node) Push the evaluation of the expression to the specified physical node.
void	restoreExpression() Undo any pushes that have been done on this expression.
void	setIsPushedDueToHint(boolean value)
java.lang.String	toString()
boolean	validate(java.util.List result, boolean debug) Validates the object, and adds all error, warning, or informational issues that are found by validation to the specified issue list.

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

addCachedIssue, addCachedIssues, clearIssueCache, delete, displayIssues, displayIssues, displayIssues, dump, dump, dump, dump, dumpToString, getCachedErrors, getCachedSyncState, getCachedValidationErrorMessage, getChildNamespaceId, getDisplayableObjectName, getFCOContainer, getFullName, getGUID, getInternalId, getName, getPropertyDefinitionOwner, getRootContainer, getStrongTypeClassName, getSyncState, getValueHolderValue, handleMapChangeEvent, hasAdapter, isNew, setCachedSyncState, 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.IMapExpressionOwner

getName

Methods inherited from interface oracle.odi.domain.root.IRoot

dump, dump, getDisplayableObjectName, getGUID, getStrongTypeClassName, validate, validate

Methods inherited from interface oracle.odi.domain.root.IMappingObject

getRootContainer

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getInternalId, getParent

Methods inherited from interface oracle.odi.domain.mapping.IMapReferenceOwner

getRootContainer

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

getBigNumericId, getName, getNumericId

Methods inherited from interface oracle.odi.domain.adapter.IModelObject

getName

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Method Detail

getPushToNode

public MapPhysicalNode getPushToNode()

Get the physical node to which this expression has been pushed. The pushed-to node is the node corresponding to the physical location where the expression will actually be evaluated in the generated code.

Returns:

getGeneratedLogicalExpression

public MapExpression getGeneratedLogicalExpression()
                                            throws MappingException,
                                                   AdapterException

Get the logical expression that should be generated for this physical expression. For the simple case this will just be the referenced logical expression. For the case where this physical expression represents another physical expression that has been to the owning node, the returned expression might be a transient generated logical expression that represents a reference to the pushed expression.

Returns:

Throws:

PropertyException

MappingException

AdapterException

getGeneratedLogicalAttribute

public MapAttribute getGeneratedLogicalAttribute()
                                          throws MappingException,
                                                 AdapterException

Get MapAttribute from generated logical expression. For the case the physical expression is pushed to another node, the method will find the original expression and find the corresponding MapAttribute.

Returns:

Throws:

MappingException

AdapterException

getPushedFrom

public MapPhysicalNode getPushedFrom()

getGeneratedParsedText

public java.lang.String getGeneratedParsedText()
                                        throws MappingException,
                                               AdapterException

Throws:

MappingException

AdapterException

getRefText

public java.lang.String getRefText()

Description copied from interface: IExpressionReferencedObject

Gets the reference text for this object. The reference text is the text that would be used in an expression to reference this object.

Specified by:

getRefText in interface IExpressionReferencedObject

Returns:

the reference text.

getGeneratedText

public java.lang.String getGeneratedText()
                                  throws MappingException,
                                         AdapterException

Throws:

MappingException

AdapterException

isPushToAllowed

public RootIssue isPushToAllowed(MapPhysicalNode node)
                          throws MappingException,
                                 AdapterException

Return true if it is allowed to push the evaluation of the expression to the specified physical node. This method is quite expensive to call in terms of performance.

Parameters:

node - The node corresponding to the physical location where the expression would be evaluated.

Returns:

A RootIssue instance whose severity is set to "INFO" if the push would be allowed, or "ERROR" if it would not be allowed. If the severity is "ERROR", the error description will contain a translated message about why it is not allowed.

Throws:

MappingException

AdapterException

pushTo

public void pushTo(MapPhysicalNode node)
            throws MappingException,
                   AdapterException

Push the evaluation of the expression to the specified physical node.

Parameters:

node - The node corresponding to the physical location where the expression will be evaluated.

Throws:

MappingException

AdapterException

restoreExpression

public void restoreExpression()

Undo any pushes that have been done on this expression.

isPushToAllowed

public boolean isPushToAllowed(ExecutionUnit exUnit)

Return true if this node can legally be pushed to the specified execution unit.

Parameters:

exUnit - The proposed push-to execution unit.

Throws:

MappingException

pushTo

public void pushTo(ExecutionUnit exUnit)
            throws MappingException,
                   AdapterException

Push the expression execution to the specified execution unit.

Parameters:

exUnit - The target execution unit.

Throws:

MappingException

AdapterException

getCurrentExecutionUnit

public ExecutionUnit getCurrentExecutionUnit()

Return the execution unit where this physical expression will be executed.

getCurrentExecutionNode

public MapPhysicalNode getCurrentExecutionNode()

Return the node where the expression will be executed. This is the owner node if the expression is not pushed, else the push-to node if it is pushed.

getOwningExecutionUnit

public ExecutionUnit getOwningExecutionUnit()

getPushToUnitCandidates

public java.util.List getPushToUnitCandidates()

Get a list of execution units to which this expression can be pushed.

Returns:

The list of execution units.

Throws:

MappingException

getPushToUnit

public ExecutionUnit getPushToUnit()

findSourcePhysicalExpression

public MapPhysicalExpression findSourcePhysicalExpression()

Find the source physical expression corresponding to this pushed physical expression.

Parameters:

physExpr - The pushed physical expression.

Returns:

findTargetPhysicalExpression

public MapPhysicalExpression findTargetPhysicalExpression()

Find the target physical expression that was pushed to another node from this expression.

Parameters:

physExpr - The pushed physical expression.

Returns:

isPushed

public boolean isPushed()

isPushedFromOtherNode

public boolean isPushedFromOtherNode()

getRefLogicalExpression

public MapExpression getRefLogicalExpression()

Get the referenced logical expression for this physical expression object.

isPushedDueToHint

public boolean isPushedDueToHint()

setIsPushedDueToHint

public void setIsPushedDueToHint(boolean value)

getSourceNode

public MapPhysicalNode getSourceNode()

Get the source node that corresponds to the logical component that owns the logical expression. This will be the physical expression owner if the expression has not been pushed. If it has been pushed, it will be the pushed-from node.

Returns:

The source node.

getOwningNode

public MapPhysicalNode getOwningNode()

Get the physical node that owns this expression.

Returns:

getOwner

public IPropertyOwner getOwner()

Description copied from interface: IRoot

Gets the mapping owner (or parent) of this object. Some objects may have an external adapter owner and would return null from this method - for example the mapping object is owned by an adapter container (e.g. OdiFolder) object, which is not an instance of IRoot, so null would be returned.

Specified by:

getOwner in interface IRoot

Specified by:

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

Returns:

The owner class instance.

validate

public boolean validate(java.util.List result,
                        boolean debug)

Description copied from interface: IRoot

Validates the object, and adds all error, warning, or informational issues that are found by validation to the specified issue list.

Specified by:

validate in interface IRoot

Overrides:

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

Parameters:

result - A list of issues that were found by validation.

debug - If true, then informational issues are added that provide information about the structure of the metadata and the state of this object.

Returns:

true if any errors were found, else false.

getMapRootContainer

public IMapRootContainer getMapRootContainer()
                                      throws oracle.odi.domain.mapping.exception.MapComponentException

Description copied from interface: IMapExpressionOwner

Get the owning root container for this object.

Specified by:

getMapRootContainer in interface IMapExpressionOwner

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

equals

public boolean equals(java.lang.Object obj)

Overrides:

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

hashCode

public int hashCode()

Overrides:

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

toString

public java.lang.String toString()

Overrides:

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

getDisplayableTypeName

public java.lang.String getDisplayableTypeName()

Description copied from interface: IRoot

Get a user-displayable type name for the object.

Specified by:

getDisplayableTypeName in interface IRoot

Specified by:

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

getAlias

public java.lang.String getAlias()

getRefObject

public IExpressionReferencedObject getRefObject()

hasSequence

public boolean hasSequence()
                    throws MappingException,
                           AdapterException

Throws:

MappingException

AdapterException

getAllMapReferences

public java.util.List getAllMapReferences()

Specified by:

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

getMinimizedRefText

public java.lang.String getMinimizedRefText()
                                     throws AdapterException

Description copied from interface: IExpressionReferencedObject

Gets the minimized reference text for this object. The minimized reference text is the text that would be used in an expression to reference this object, without any parent composite component (dataset) qualifiers.

Specified by:

getMinimizedRefText in interface IExpressionReferencedObject

Returns:

the minimized reference text.

Throws:

AdapterException