oracle.odi.domain.mapping.expression

Class MapExpression

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.root.Root

oracle.odi.domain.mapping.expression.MapExpression

All Implemented Interfaces:

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

public class MapExpression
extends oracle.odi.domain.root.Root
implements IMapExpression, IMappingObject, oracle.odi.domain.mapping.IMapReferenceOwner

The basic expression class to be used by ODI mapping components. The expression is an arbitrary free-form snippet of text in any language (though most often SQL). It can contain references to attributes, in the form "ComponentNameOrAlias.AttributeName". These references are parsed out into a list of cross references for the expression, at validation time. The expression can also have an input connector point as an associated scoping point. If the associated scoping point is null, then the scope is considered to be all the input connector points of the component that owns the expression. The scope determines the upstream attributes in the graph that can be referenced by the expression.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapExpression.AggregationFunctionType
static class	MapExpression.ExecuteOnLocation This enumeration type defines the values for "Execute on Hint" property.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Vector	keywordList A list of keywords recognized in ODI expressions.

Method Summary

Modifier and Type	Method and Description
boolean	checkReferences() Checks to see if all references are still valid.
java.lang.Object	clone() Creates a new instance having same content values with this expression.
boolean	containsAggregationFunction(ITechnology techno) Returns true if this expression contains any kind of aggregation function call in the context of the specified technology.
boolean	containsAggregationFunction(ITechnology techno, MapExpression.AggregationFunctionType type) Returns true if this expression contains group-by type aggregation function call or window (analytical) function call in the context of the specified technology.
boolean	containsGroupByAggregationFunction(ITechnology techno) Returns true if this expression contains group-by type Aggregation function call in the context of the specified technology.
boolean	containsWindowFunction(ITechnology techno) Returns true if this expression contains a window (analytical) function call in the context of the specified technology.
java.util.List	getAllMapReferences()
oracle.odi.domain.mapping.MapComponentOwner	getComponentOwner() Returns the component owner that owns this expression or owns the component which owns this expression, or null if there is none.
MapExpressionXRef	getCrossReference(java.lang.String key) Gets the cross reference object from the list of cross references, for the given key.
java.util.Map	getCrossReferenceMap() Gets a map between reference key to MapExpressionXRef object.
java.util.List	getCrossReferences() Gets the full list of cross references for this expression, created when the expression was last parsed.
java.util.List	getCrossReferences(java.util.List inScopeComponents) Gets the full list of cross references for this expression, created when the expression was last parsed.
java.lang.String	getDisplayableObjectName() Returns descriptive name for this expression suitable for UI.
int	getDistinctReferenceCount() Gets the number of distinct references, with no duplicates, for this expression.
MapExpression.ExecuteOnLocation	getExecuteOnHint() Gets the execute on hint value for this expression.
ILogicalSchema	getExecuteOnLocation() Gets the execute on hint value of this expression.
java.lang.String	getExecuteOnLocationName() Gets the name for execute on hint value set on this expression.
java.util.Map	getExpressionMap() Gets a hash map keyed by scoping input connector point, and whose values are the expressions associated with the input connector point.
IMapExpressionOwner	getExpressionOwner() Gets the direct owner of this expression.
java.lang.String	getExpressionText(java.util.Map substitutes) Gets the expression text using the specified substitute text map for each referenced attribute.
java.util.List	getLanguages() Gets the list of languages that are used to interpret this expression in the logical mapping graph.
ITechnology	getLogicalExpressionTechnology() Returns the implementing technology for expressions owned by bound components, or mapping generic technology for expressions of unbound components.
IRoot	getOwner() Gets the owner of this expression.
MapAttribute	getOwningAttribute() Gets the attribute that owns this expression.
IMapComponent	getOwningComponent() Returns the component that owns this expression, or null if there is none.
IMapComponent	getOwningLeafComponent() Returns the component that owns this expression, or null if there is none.
MapConnectorPoint	getOwningLeafConnectorPoint() Returns the connector point that owns this expression, or null if there is none.
Property	getOwningProperty() Gets the property that owns this expression.
java.lang.String	getParsedText() Returns the parsed text of this expression.
int	getReferenceCount() Gets the current reference count for the expression.
java.util.List	getReferencedObjects() Gets a list of the referenced objects for this expressions.
oracle.odi.domain.mapping.MapRootContainer	getRootContainer() Get the owning FCO root container object for this object.
MapConnectorPoint	getScopingInputPoint() Gets the associated input connector point used for scoping.
java.lang.String	getTechnicalDescription() Returns the technical description property value of this expression
java.lang.String	getText() Gets the unparsed text of this expression.
java.util.List	getUnparsedIdentifiers() Gets a list of possible identifiers that do not match any objects.
boolean	hasReferenceTo(java.lang.Object modelObj) Returns true if this expression contains a reference to the specified object.
boolean	isNoParse() Checks if the expression parsing is disables.
boolean	isSimpleExpression() Returns true if this expression represents a simple reference to one upstream attribute.
oracle.odi.domain.mapping.expression.parser.tree.ExpressionNode	parseExpression() Checks if the expression has been invalidated, and if so, re-parses the expression.
oracle.odi.domain.mapping.expression.parser.tree.ExpressionNode	parseExpression(java.util.List inScopeComponents) Checks if the expression has been invalidated, and if so, re-parses the expression.
void	setExecuteOnHint(MapExpression.ExecuteOnLocation loc) Sets the execute on hint value for this expression
void	setExecuteOnLocation(ILogicalSchema loc) Sets the execute on hint to the given logical schema.
void	setExecuteOnLocationByName(java.lang.String name) Sets execute on hint value based on the String value given.
void	setExpressionOwner(IMapExpressionOwner owner) Sets the root owner for this expression.
void	setNoParse(boolean value) Sets a flag that prevents parsing of expression text.
void	setScopingInputPoint(MapConnectorPoint point) Sets the associated input scoping connector point for this expression.
void	setText(java.lang.String text) Sets the expression text.
java.lang.String	toString() Gets an informative String showing all the essential aspects of this expression.

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, getFCOContainer, getFullName, getGUID, getInternalId, getName, getPropertyDefinitionOwner, getStrongTypeClassName, getSyncState, getValueHolderValue, hasAdapter, hashCode, isNew, setCachedSyncState, validate, validate

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

getBigNumericId, getGlobalId, getNumericId, getParent

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getName

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

getBigNumericId, getGlobalId, getNumericId

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Field Detail

keywordList

public static java.util.Vector keywordList

A list of keywords recognized in ODI expressions. This is effectively a static final constant, and is thread safe.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates a new instance having same content values with this expression. The new expression instance shares no internal objects with this expression instance.

Overrides:

clone in class oracle.odi.domain.support.BusinessObject

Returns:

a deep cloned expression.

Throws:

CloneNotSupportedException.

java.lang.CloneNotSupportedException

setExpressionOwner

public void setExpressionOwner(IMapExpressionOwner owner)

Sets the root owner for this expression.

Parameters:

owner - the owner of this expression.

setScopingInputPoint

public void setScopingInputPoint(MapConnectorPoint point)

Sets the associated input scoping connector point for this expression. If set it means that all the upstream attribute scoping will be determined through the specified connector point. If null, then scoping will be determined using all input connector points of the owning component.

Parameters:

point - the connector point to be set as the scoping point.

getScopingInputPoint

public MapConnectorPoint getScopingInputPoint()

Gets the associated input connector point used for scoping.

Returns:

the scoping input point.

setNoParse

public void setNoParse(boolean value)

Sets a flag that prevents parsing of expression text.

Parameters:

value - if true, parsing of expression text is disabled.

isNoParse

public boolean isNoParse()

Checks if the expression parsing is disables.

Returns:

true if expression text parsing is disabled, false otherwise.

getOwner

public IRoot getOwner()

Gets the owner of this expression.

Specified by:

getOwner in interface IRoot

Specified by:

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

Returns:

the owner.

setText

public void setText(java.lang.String text)
             throws MappingException

Sets the expression text.

Parameters:

text - The text to set.

Throws:

AdapterException

MappingException

getText

public java.lang.String getText()

Gets the unparsed text of this expression.

Returns:

the original, unmodified expression text as set by the user.

getParsedText

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

Returns the parsed text of this expression.

Returns:

The pre-parsed text with special delimited references formatted as @{refKey}.

Throws:

PropertyException

AdapterException

MappingException

getUnparsedIdentifiers

public java.util.List getUnparsedIdentifiers()

Gets a list of possible identifiers that do not match any objects.

Returns:

a list of identifiers that failed to match anything.

getCrossReference

public MapExpressionXRef getCrossReference(java.lang.String key)
                                    throws MappingException,
                                           AdapterException

Gets the cross reference object from the list of cross references, for the given key.

Parameters:

key - the cross reference key.

Returns:

The cross reference object.

Throws:

oracle.odi.domain.mapping.expression.parser.ExpressionParseException

MappingException

AdapterException

getReferenceCount

public int getReferenceCount()

Gets the current reference count for the expression. Does not re-parse the expression.

Returns:

the number of cross references in this expression.

getDistinctReferenceCount

public int getDistinctReferenceCount()

Gets the number of distinct references, with no duplicates, for this expression. Does not re-parse the expression.

Returns:

the number of distinct cross references.

getReferencedObjects

public java.util.List getReferencedObjects()

Gets a list of the referenced objects for this expressions.

Returns:

all reference objects of this expression.

getCrossReferences

public java.util.List getCrossReferences()
                                  throws MappingException,
                                         AdapterException

Gets the full list of cross references for this expression, created when the expression was last parsed.

Returns:

The list of cross reference objects.

Throws:

MappingException

AdapterException

getCrossReferences

public java.util.List getCrossReferences(java.util.List inScopeComponents)
                                  throws MappingException,
                                         AdapterException

Gets the full list of cross references for this expression, created when the expression was last parsed.

Parameters:

inScopeComponents - the list of components that are considered in-scope for this expression. If the value is null, then the in-scope component list will be determined by the graph itself, which is the normal case.

Returns:

the list of cross reference objects.

Throws:

MappingException

AdapterException

getCrossReferenceMap

public java.util.Map getCrossReferenceMap()

Gets a map between reference key to MapExpressionXRef object.

Returns:

a lookup map from reference key to referenced object.

parseExpression

public oracle.odi.domain.mapping.expression.parser.tree.ExpressionNode parseExpression()
                                                                                throws MappingException,
                                                                                       AdapterException

Checks if the expression has been invalidated, and if so, re-parses the expression. The expression is invalidated by upstream components if something changes which would affect the parsing of the expression, such as changing or removing connections.

Throws:

MappingException

AdapterException

parseExpression

public oracle.odi.domain.mapping.expression.parser.tree.ExpressionNode parseExpression(java.util.List inScopeComponents)
                                                                                throws MappingException,
                                                                                       AdapterException

Checks if the expression has been invalidated, and if so, re-parses the expression. The expression is invalidated by upstream components if something changes which would affect the parsing of the expression, such as changing or removing connections.

Parameters:

inScopeComponents - the list of in scope components to restrict parsing of this expression.

Throws:

MappingException

AdapterException

checkReferences

public boolean checkReferences()
                        throws MappingException,
                               AdapterException

Checks to see if all references are still valid. A reference is valid if the target attribute still exists, and if it is in scope for this expression.

Returns:

True is all references are valid, else false

Throws:

MappingException

AdapterException

getOwningComponent

public IMapComponent getOwningComponent()

Returns the component that owns this expression, or null if there is none.

Returns:

the owner of this expression

getOwningLeafComponent

public IMapComponent getOwningLeafComponent()
                                     throws MappingException

Returns the component that owns this expression, or null if there is none. If the expression is owned by a composite component attribute, then return the child component via the parent/child connector point relationship.

Returns:

the leaf component (i.e., non-composite component) owner of this expression.

Throws:

MappingException

getOwningLeafConnectorPoint

public MapConnectorPoint getOwningLeafConnectorPoint()
                                              throws MappingException

Returns the connector point that owns this expression, or null if there is none. If the expression is owned by a composite component attribute, then return the child connector point via the parent/child connector point relationship.

Returns:

the connector point of the owning leaf component.

Throws:

MappingException

getOwningAttribute

public MapAttribute getOwningAttribute()

Gets the attribute that owns this expression. If the expression is not owned by an attribute, then return null.

Returns:

the attribute that owns this expression or null if it does not exist.

getOwningProperty

public Property getOwningProperty()

Gets the property that owns this expression. If the expression is not owned by a property, then return null.

Returns:

the property that owns this expression or null if it does not exist.

getLogicalExpressionTechnology

public ITechnology getLogicalExpressionTechnology()
                                           throws oracle.odi.domain.mapping.exception.MapComponentException,
                                                  AdapterException

Returns the implementing technology for expressions owned by bound components, or mapping generic technology for expressions of unbound components.

Returns:

the technology of the bound object of the owning component.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

AdapterException

getComponentOwner

public oracle.odi.domain.mapping.MapComponentOwner getComponentOwner()
                                                              throws oracle.odi.domain.mapping.exception.MapComponentException

Returns the component owner that owns this expression or owns the component which owns this expression, or null if there is none.

Returns:

the component owner of this expression or the owner of the owner of this expression.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

getExpressionOwner

public IMapExpressionOwner getExpressionOwner()

Gets the direct owner of this expression.

Returns:

the owner of this expression.

getExpressionMap

public java.util.Map getExpressionMap()
                               throws oracle.odi.domain.mapping.exception.MapComponentException

Gets a hash map keyed by scoping input connector point, and whose values are the expressions associated with the input connector point. This is mostly useful for the case where an attribute owns multiple expressions, and each one is associated with a scoping input point (e.g. set/union operator). The scoping input point is defined as the input point through which the expression references are resolved. If the expression owner is not an attribute, or no expressions are set for the owning attribute, then null is returned.

Returns:

The map that relates input connector points to associated attribute expressions.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

toString

public java.lang.String toString()

Gets an informative String showing all the essential aspects of this expression.

Overrides:

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

Returns:

information about this expression.

getExpressionText

public java.lang.String getExpressionText(java.util.Map substitutes)
                                   throws MappingException,
                                          AdapterException

Gets the expression text using the specified substitute text map for each referenced attribute. If a referenced attribute does not appear in the map, the full SQL access name for the attribute will be used.

Parameters:

substitutes -

Returns:

the string of the expression with attributes replaced by substitutes.

Throws:

MappingException

AdapterException

hasReferenceTo

public boolean hasReferenceTo(java.lang.Object modelObj)
                       throws MappingException,
                              AdapterException

Returns true if this expression contains a reference to the specified object. Also returns true if the specified object is in the ownership hierarchy of a referenced object for this expression.

Returns:

true if this expression has a reference to the model object, false otherwise.

Throws:

AdapterException

MappingException

containsAggregationFunction

public boolean containsAggregationFunction(ITechnology techno)
                                    throws MappingException,
                                           AdapterException

Returns true if this expression contains any kind of aggregation function call in the context of the specified technology. This includes a plain aggregation function call which would be used with a group-by clause, or an analytical window function call that would be used with the "OVER" keyword. If the technology is null, then the mapping generic technology is used.

Parameters:

techno - The technology whose supported aggregation functions will be checked. If null, the mapping generic technology is used. . * @return true if this expression contains an aggregate function call, false otherwise.

Throws:

MappingException

AdapterException

containsWindowFunction

public boolean containsWindowFunction(ITechnology techno)
                               throws MappingException,
                                      AdapterException

Returns true if this expression contains a window (analytical) function call in the context of the specified technology. Window functions are aggregation functions using the OVER keyword. If the technology is null, then the mapping generic technology is used.

Parameters:

techno - The technology whose supported aggregation functions will be checked. If null, the mapping generic technology is used. . * @return true if this expression contains an aggregate function call, false otherwise.

Throws:

MappingException

AdapterException

containsGroupByAggregationFunction

public boolean containsGroupByAggregationFunction(ITechnology techno)
                                           throws MappingException,
                                                  AdapterException

Returns true if this expression contains group-by type Aggregation function call in the context of the specified technology. If the technology is null, then the mapping generic technology is used.

Parameters:

techno - The technology whose supported aggregation functions will be checked. If null, the mapping generic technology is used. . * @return true if this expression contains an aggregate function call, false otherwise.

Throws:

MappingException

AdapterException

containsAggregationFunction

public boolean containsAggregationFunction(ITechnology techno,
                                           MapExpression.AggregationFunctionType type)
                                    throws MappingException,
                                           AdapterException

Returns true if this expression contains group-by type aggregation function call or window (analytical) function call in the context of the specified technology. If the technology is null, then the mapping generic technology is used.

Parameters:

techno - The technology whose supported aggregation functions will be checked. If null, the mapping generic technology is used.

type - WINDOW for a window (analytical) function, otherwise AGGREGATION for a regular aggregation function

Returns:

true if this expression contains an aggregate function call, false otherwise.

Throws:

MappingException

AdapterException

getLanguages

public java.util.List getLanguages()
                            throws oracle.odi.domain.mapping.exception.MapComponentException,
                                   AdapterException

Gets the list of languages that are used to interpret this expression in the logical mapping graph. Note that the actual executing languages used may be different once the owning component is assigned to an execution unit in the physical graph.

Returns:

The list of languages.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

AdapterException

getExecuteOnHint

public MapExpression.ExecuteOnLocation getExecuteOnHint()
                                                 throws MappingException

Gets the execute on hint value for this expression. The execute on hint will help determine if it is pushed upstream or downstream in the physical graph. If no hint has been set, then "NO_HINT" value is returned.

Returns:

the execute on hint.

Throws:

MappingException

setExecuteOnHint

public void setExecuteOnHint(MapExpression.ExecuteOnLocation loc)
                      throws MappingException

Sets the execute on hint value for this expression

Parameters:

loc - the execute on hit.

Throws:

MappingException

setExecuteOnLocation

public void setExecuteOnLocation(ILogicalSchema loc)
                          throws oracle.odi.domain.mapping.exception.MapComponentException,
                                 AdapterException

Sets the execute on hint to the given logical schema.

Parameters:

loc - the logical schema from which to calculate the value for execute on hint and set.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

AdapterException

getExecuteOnLocation

public ILogicalSchema getExecuteOnLocation()
                                    throws AdapterException,
                                           oracle.odi.domain.mapping.exception.MapComponentException

Gets the execute on hint value of this expression.

Returns:

the execute on hint value.

Throws:

AdapterException

oracle.odi.domain.mapping.exception.MapComponentException

setExecuteOnLocationByName

public void setExecuteOnLocationByName(java.lang.String name)
                                throws AdapterException,
                                       MappingException

Sets execute on hint value based on the String value given.

Parameters:

name - the String value for the execute on hint.

Throws:

AdapterException

MappingException

getExecuteOnLocationName

public java.lang.String getExecuteOnLocationName()
                                          throws AdapterException,
                                                 oracle.odi.domain.mapping.exception.MapComponentException

Gets the name for execute on hint value set on this expression.

Returns:

the String value of execute on hint value.

Throws:

AdapterException

oracle.odi.domain.mapping.exception.MapComponentException

isSimpleExpression

public boolean isSimpleExpression()
                           throws AdapterException,
                                  MappingException

Returns true if this expression represents a simple reference to one upstream attribute.

Returns:

true if this expression is simple, false otherwise.

Throws:

AdapterException

MappingException

getDisplayableObjectName

public java.lang.String getDisplayableObjectName()

Returns descriptive name for this expression suitable for UI.

Specified by:

getDisplayableObjectName in interface IRoot

Overrides:

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

Returns:

displayable object name.

getTechnicalDescription

public java.lang.String getTechnicalDescription()

Returns the technical description property value of this expression

Returns:

the technical description value.

getAllMapReferences

public java.util.List getAllMapReferences()

Specified by:

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

getRootContainer

public oracle.odi.domain.mapping.MapRootContainer getRootContainer()

Description copied from interface: IMappingObject

Get the owning FCO root container object for this object. It will be a Mapping or ReusableMapping object.

Specified by:

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

Specified by:

getRootContainer in interface IMappingObject

Overrides:

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