oracle.odi.domain.mapping.component

Class LookupComponent

java.lang.Object

oracle.odi.domain.mapping.MapComponentDelegator

oracle.odi.domain.mapping.MapComponentDelegate

oracle.odi.domain.mapping.component.DefaultDelegate

oracle.odi.domain.mapping.component.JoinComponent

oracle.odi.domain.mapping.component.LookupComponent

All Implemented Interfaces:

IModelObject, IModelObjectBase, IMapComponent, IRepositoryEntity, IMapComponentOwner, IMappingObject, INamedObject, IPropertyOwner, IRoot

public class LookupComponent
extends JoinComponent

The lookup component is a mapping component with specialized join functionality, allowing the lookup of columns from a lookup table. It is functionally equivalent to a left outer join. The driving table becomes the left side of the left outer join, so all records of the driving table will participate in the join. The lookup may be generated as either a left outer join or a correlated sub query.

Since:

12.1.2.0.0

Version:

$Header: odi/src/javadev/odi.mapping/src/oracle/odi/domain/mapping/component/LookupComponent.java /main/51 2015/08/18 18:39:41 jfklein Exp $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LookupComponent.LookupType ATTENTIION: 1, To support OWB lookup migration, the concept Multiple Match Rows and No Match Rows introduced 2, To back support ODI 12.1.2, the LookupType property was reused as new meaning 3, The migration combination as following OWB_MULTIPLE_MATCH_ROWS OWB_NO_MATCH_ROWS ODI12.1.2_LOOKUP_TYPE ODI12.1.3_MULTIPLE_MATCH_ROWS ODI12.1.3_NO_MATCH_ROWS ODI12.1.3_SQL_IMPL ALL_ROWS DEFAULT_VALUES LEFT_OUTER ALL_ROWS(LEFT_OUTER) DEFAULT_VALUES LEFT_OUTER_JOIN ALL_ROWS NO_ROW N/A ALL_ROWS(LEFT_OUTER) NO_ROW INNER_JOIN ERROR DEFAULT_VALUES EXPRESSION_IN_SELECT ERROR(ERROR_WHEN_MULTIPLE_ROW) DEFAULT_VALUES EXPRESSION_IN_SELECT NTH_SINGLE_ROW DEFAULT_VALUES N/A NTH_SINGLE_ROW DEFAULT_VALUES LEFT_OUTER_JOIN ANY_SINGLE_ROW DEFAULT_VALUES N/A ANY_SINGLE_ROW DEFAULT_VALUES EXPRESSION_IN_SELECT FIRST_SINGLE_ROW DEFAULT_VALUES N/A FIRST_SINGLE_ROW DEFAULT_VALUES EXPRESSION_IN_SELECT LAST_SINGLE_ROW DEFAULT_VALUES N/A LAST_SINGLE_ROW DEFAULT_VALUES EXPRESSION_IN_SELECT The tricky part one: when Multiple Match Rows populated with ALL_ROWS(actual value is LEFT_OUTER to back support ODI12.1.2) + No Match Rows populated with DEFAULT_VALUES meaning the implementation using LEFT_OUTER_JOIN which same as ODI12.1.2's behavior The tricky part two: when Multiple Match Rows populated with ALL_ROWS(actual value is LEFT_OUTER to back support ODI12.1.2) + No Match Rows populated with NO_ROW meaning the implementation using INNER_JOIN which is new behavior introduced by ODI12.1.3 to support OWB(ALL_ROWS+NO_ROW) The tricky part three: when Multiple Match Rows populated with ERROR(actual value is EXPRESSION_IN_SELECT to back support ODI12.1.2) + No Match Rows populated with DEFAULT_VALUES meaning the implementation using EXPRESSION_IN_SELECT which is same as ODI12.1.2's behavior.
static class	LookupComponent.NO_MATCH_ROWS The NO_MATCH_ROWS enumeration specifies the behavior when no matching rows are found in the lookup table.

Nested classes/interfaces inherited from class oracle.odi.domain.mapping.component.DefaultDelegate

DefaultDelegate.DefaultAttributeDelegate, DefaultDelegate.DefaultConnectorPointDelegate

Nested classes/interfaces inherited from class oracle.odi.domain.mapping.MapComponentDelegate

oracle.odi.domain.mapping.MapComponentDelegate.AttributeDelegate, oracle.odi.domain.mapping.MapComponentDelegate.MapConnectorPointDelegate

Nested classes/interfaces inherited from interface oracle.odi.domain.mapping.IMapComponent

IMapComponent.ComponentCategory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE_NAME The component type name.
static java.lang.String	DRIVER_ROLE
static java.lang.String	JOIN_TYPE_ALL_ROWS Join type property value for all rows.
static java.lang.String	JOIN_TYPE_ERROR_WHEN_MULTIPLE_ROW Join type property value for all rows.
static java.lang.String	JOIN_TYPE_EXPRESSION_IN_SELECT Join type property value for expression in select.
static java.lang.String	LOOKUP_ROLE
static java.lang.String	PROPKEY_LOOKUP_INPUT_ROLE
static java.lang.String	PROPKEY_LOOKUP_IS_JOIN
static java.lang.String	PROPKEY_LOOKUP_TABLE

Fields inherited from class oracle.odi.domain.mapping.component.JoinComponent

JOIN_TYPE_CROSS, JOIN_TYPE_FULL_OUTER, JOIN_TYPE_INNER, JOIN_TYPE_LEFT_OUTER, JOIN_TYPE_NATURAL, JOIN_TYPE_RIGHT_OUTER, PROPKEY_ACTIVE_INDICATOR, PROPKEY_DEFAULT_JOIN, PROPKEY_DERIVED_FROM, PROPKEY_DERIVED_JOINS, PROPKEY_GENERATE_ANSI, PROPKEY_JOIN_CONDITION, PROPKEY_JOIN_INPUT_ROLE, PROPKEY_JOIN_ORDER, PROPKEY_JOIN_SOURCE_ORDER, PROPKEY_JOIN_TYPE, PROPKEY_TECHNICAL_DESCRIPTION

Fields inherited from class oracle.odi.domain.mapping.component.DefaultDelegate

VARIABLE_COMPONENT_TYPE_NAME

Fields inherited from class oracle.odi.domain.mapping.MapComponentDelegate

JAVA_LOGGER

Constructor Summary

Constructors

Constructor and Description
LookupComponent(oracle.odi.domain.mapping.MapComponentOwner owner, java.lang.String name) Construct a new persistent lookup component.

Method Summary

Modifier and Type	Method and Description
static LookupComponent	createLookup(IMapComponent driverSource, IMapComponent lookupSource, java.lang.String joinConditionText) Creates a new lookup component with the specified driver and lookup sources, using the specified join condition.
static LookupComponent	createLookup(java.lang.String lookupName, IMapComponent driverSource, IMapComponent lookupSource, java.lang.String joinConditionText) Creates a new lookup component with the specified driver and lookup source components, using the specified join condition.
IMapComponent	getComponentForRole(java.lang.String inputRole) Gets the source component for the specified role, "DRIVER" or "LOOKUP".
MapConnectorPoint	getDriverConnectorPoint() Gets the input connector point associated with the driver source.
IMapComponent	getDriverSource() Gets the driver (left side of join) source map component.
MapExpression.ExecuteOnLocation	getExecuteOnHint() Return an execute location hint if the component supports it, otherwise "NO_HINT".
java.util.Map	getInScopeAttributeXMap(MapConnectorPoint inputPoint)
java.util.List	getInScopeLookupAttributes() Gets a list of map attributes which are in-scope through the lookup connector point
oracle.odi.mapping.generation.JoinTable.JoinType	getJoinTypeAsEnum() Gets the enum value of the join condition type property.
java.lang.String	getLookupAttributeDefaultValue(java.lang.String attrName) Get the default value of a lookup attribute
java.lang.String	getLookupAttributeOrderBy(java.lang.String attrName) Gets the "order by" modifier (ASC/DESC) for the specified attribute
java.util.Map	getLookupAttributesDefaultValue() Get all lookup attributes default values
MapConnectorPoint	getLookupConnectorPoint() Gets the input connector point associated with the lookup source.
IMapComponent	getLookupSource() Gets the lookup (right side of join) source component.
LookupComponent.NO_MATCH_ROWS	getNoMatchRows() Gets the lookup option to be applied if no rows are matched in the lookup table.
int	getNthRowNumber() Gets the row number to return if multiple matching rows are found in the lookup table.
MapAttribute[]	getOrderedLookupAttributes() Gets an array of all lookup attributes, ordering specified by the attribute order by property.
void	initializeConnectorPoint(MapConnectorPoint point) Initializes the connector points.
boolean	isDerived() Checks if this join component is a derived join.
boolean	isGenerateANSISyntax() Determines whether ANSI syntax will be generated.
void	setDriverComponent(IMapComponent driverComp) Sets the driver component for this component and connects them.
void	setDriverComponent(OutputConnectorPoint driverCompOCP) Sets the driver component connection for this component.
void	setDriverTable(IDataStore driverTable) Sets the driver component connection for this component, using a source data store (table or file).
void	setDriverTable(ReusableMapping driverRM) Sets the driver component connection for this component, using a source reusable mapping.
void	setExecuteOnHint(MapExpression.ExecuteOnLocation hint) Set the execute-on hint for this component, if applicable, otherwise throw exception.
void	setJoinType(oracle.odi.mapping.generation.JoinTable.JoinType type) Sets the join type as enum.
void	setJoinType(java.lang.String type) Sets the join condition type as a string.
void	setLookupAttributeDefaultValue(java.util.Map attributeDefaultValueMap) Set the attributes' default values
void	setLookupAttributeDefaultValue(java.lang.String attrName, java.lang.String defaultValue) Set a certain attribute's default value
void	setLookupAttributeOrderBy(java.util.Map attributeOrderByMap) Set attributes' order fashion according to a Map containing the order info
void	setLookupAttributeOrderBy(java.lang.String attrName, java.lang.String pOrderBy) Sets the order by modifier (ASC/DESC) for the given attribute.
void	setLookupComponent(IMapComponent lookupComp) Sets the lookup component connection for this component and connects them.
void	setLookupComponent(OutputConnectorPoint lookupCompOCP) Sets the lookup component connection for this component.
void	setLookupTable(IDataStore lookupTable) Sets the lookup component connection for this component, using a source data store (table or file).
void	setLookupTable(ReusableMapping lookupRM) Sets the lookup component connection for this component, using a source reusable mapping.
void	setLookupType(LookupComponent.LookupType type) Sets the lookup type, either left outer join or sub select
void	setLookupType(java.lang.String type) Sets the lookup type, either left outer join or sub select
void	setNoMatchRows(LookupComponent.NO_MATCH_ROWS noMatchRows) Specifies the lookup behavior if no rows are matched in the lookup table.
void	setNthRowNumber(int nthRowNumber) Sets the row number to return if multiple matching rows are found in the lookup table.

Methods inherited from class oracle.odi.domain.mapping.component.JoinComponent

addJoinSource, connectReferencedSourcesToJoin, createInputConnectorPoint, findConnectorPointWithRole, getDerivedFromText, getDerivedJoins, getDerivedJoinsText, getJoinCondition, getJoinConditionText, getJoinOrder, getJoinSourceOrderText, getJoinType, getLeftSourceName, getOrderedJoinSources, getReferencedSources, getRightSourceName, getSourceNameForRole, getTechnicalDescription, handleMapChangeEvent, hasUserDefinedJoinOrder, isCrossJoin, isDefaultJoin, isFullOuterJoin, isInnerJoin, isJoinInsideDataset, isLeftOrRightOuterJoin, isLeftOuterJoin, isNaturalJoin, isRightOuterJoin, isValidForTechnology, joinSources, joinSources, setDerivedFromText, setDerivedJoinsText, setGenerateANSISyntax, setJoinConditionText, setJoinOrder, setJoinSourceOrderText, setPropertyValue

Methods inherited from class oracle.odi.domain.mapping.component.DefaultDelegate

customInvalidateExpressions, customSyncComponent, getBlockExpressionReferencedAttributes, getBlockExpressionReferencedAttributesWithPath, getExecuteOnHintString, getIntegrationType, getNextAvailableInput, getNextAvailableInput, getNextAvailableOutput, isAddInputConnectorPointAllowed, isAddOutputConnectorPointAllowed, isPassive, setExecuteOnHintByString

Methods inherited from class oracle.odi.domain.mapping.MapComponentDelegate

afterAddComponent, afterConnect, afterRemoveComponent, connectFrom, createInputConnectorPoint, createOutputConnectorPoint, createOutputConnectorPoint, customValidateProposedChildConnection, customValidateProposedChildScoping, equals, getBoundObjectFullName, getBoundObjectName, getBoundShortcutFullName, getComponentContext, getComponentCustomLocation, getComponentType, getSQLAccessName, getSQLAliasName, getTypeName, handleChildMapChangeEvent, hashCode, initPhysicalNode, isAttributeExecuteOnLocationHidden, isBoundObjectDeleted, isCardinalitySource, isCompositeComponentType, isExpressionHidden, isTargetLoadingSupported, setComponentType, supportComponentOfType, toString

Methods inherited from class oracle.odi.domain.mapping.MapComponentDelegator

addComponent, addProperty, bindTo, bindTo, connectTo, connectTo, connectTo, connectTo, containsComponent, createComponent, createComponent, createComponent, createOutputConnectorPoint, createProperty, disableMapChangeEventHandling, dump, dump, enableMapChangeEventHandling, findAllComponents, findComponent, findComponentBoundTo, findComponentOfType, findComponentsBoundTo, findConnector, findConnectorPoint, findInputAttribute, findOutputAttribute, findSubComponentOwner, generateUniqueComponentName, generateUniqueComponentName, generateUniqueConnectorName, generateUniqueName, generateUniqueName, getAdapter, getAlias, getAllComponents, getAllComponentsOfType, getAllExpressions, getAllProperties, getAllSignatureOwnerHolders, getAllSubComponentOwners, getAttributeExpressions, getAttributes, getBigNumericId, getBooleanPropertyValue, getBoundObject, getBoundShortcut, getBoundTechnology, getBusinessName, getCachedIssues, getComponentAttributeMap, getComponentCategory, getComponentCount, getComponentLocation, getComponentLocation, getComponentOwner, getComponents, getComponentTypeName, getConcreteObject, getConnectorPointCount, getConnectorPointCount, getConnectorPoints, getConnectorPoints, getConnectorPointToLeaf, getConnectorTo, getDelegate, getDescription, getDisplayableObjectName, getDisplayableProperties, getDisplayableTypeName, getDomainInterfaceType, getDownstreamConnectedLeafComponents, getDownstreamConnectedPoints, getExpressionPropertyValue, getExpressionReferences, getFlowConstraints, getFullName, getGlobalId, getGUID, getInputConnectorPoint, getInputConnectorPoint, getInputConnectorPointCount, getInputConnectorPoints, getInputPoint, getInScopeAttributes, getInternalId, getIntPropertyValue, getLeafLevelComponents, getLeafLevelEndpoints, getLeafLevelTargets, getMapRootContainer, getName, getNumericId, getOutputAttributeExpressions, getOutputAttributes, getOutputConnectorPoint, getOutputConnectorPoint, getOutputConnectorPointCount, getOutputConnectorPoints, getOutputPoint, getOwner, getOwningComponent, getParent, getPersistentClassName, getPrefix, getProjectedAttributes, getProperties, getProperty, getPropertyDefinitionOwner, getPropertyValue, getPropertyValueReference, getProposedConnectionIssues, getQualifiedName, getRootComponentOwner, getRootContainer, getSecurityContainer, getSources, getStringPropertyValue, getStrongTypeClassName, getSyncState, getTargetLoadOrder, getTargetLoadOrderText, getTargets, getTopLevelComponentsOfType, getTopLevelSignatureOwnerHolders, getTopLevelSources, getTopLevelTargets, getTopmostComponent, getUpstreamAttributeXMap, getUpstreamConnectedLeafComponents, getUpstreamConnectedLeafPoints, getUpstreamConnectedPoints, getUpstreamInScopeLeafAttributes, getUpstreamInScopeLeafComponentsFor, getUpstreamInScopeLeafPoints, getUpstreamLeafAttributes, getUpstreamLeafAttributes, getUpstreamLeafConnectorPoints, getUpstreamLeafConnectorPoints, getUpstreamLeafSources, getUpstreamSources, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor, invokeMethod, is11gMapping, isBound, isComponent, isComponentLevelConnectAllowed, isCompositeComponent, isCreatePersistentComponents, isDecorator, isEndpoint, isExpandableComponent, isHidden, isInScope, isInScope, isMapChangeEventHandlingEnabled, isMultiInputSelector, isOfType, isProjector, isPropertyDefined, isProposedConnectionValid, isSelector, isSignatureOwner, isSignatureOwnerHolder, isSource, isSubComponent, isTarget, isUniqueComponentName, isUniqueComponentName, referencesObject, removeAllConnections, removeAllConnections, removeAllInputConnections, removeComponent, removeComponent, removeInputConnectorPoint, removeInputConnectorPoint, removeInputConnectorPoint, removeOutputConnectorPoint, removeOutputConnectorPoint, removeProperty, reorderInputConnectorPoint, reorderOutputConnectorPoint, setAlias, setAttributeExpressionText, setAttributeExpressionText, setBooleanPropertyValue, setBusinessName, setDescription, setIntPropertyValue, setIsHidden, setName, syncComponent, validate, validate, validate, validateProperties

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

COMPONENT_TYPE_NAME

public static final java.lang.String COMPONENT_TYPE_NAME

The component type name. Must match the component name in Definitions.xml.

See Also:

Constant Field Values

PROPKEY_LOOKUP_TABLE

public static final java.lang.String PROPKEY_LOOKUP_TABLE

See Also:

Constant Field Values

PROPKEY_LOOKUP_INPUT_ROLE

public static final java.lang.String PROPKEY_LOOKUP_INPUT_ROLE

See Also:

Constant Field Values

PROPKEY_LOOKUP_IS_JOIN

public static final java.lang.String PROPKEY_LOOKUP_IS_JOIN

See Also:

Constant Field Values

DRIVER_ROLE

public static final java.lang.String DRIVER_ROLE

See Also:

Constant Field Values

LOOKUP_ROLE

public static final java.lang.String LOOKUP_ROLE

See Also:

Constant Field Values

JOIN_TYPE_ALL_ROWS

public static final java.lang.String JOIN_TYPE_ALL_ROWS

Join type property value for all rows.

See Also:

Constant Field Values

JOIN_TYPE_ERROR_WHEN_MULTIPLE_ROW

public static final java.lang.String JOIN_TYPE_ERROR_WHEN_MULTIPLE_ROW

Join type property value for all rows.

See Also:

Constant Field Values

JOIN_TYPE_EXPRESSION_IN_SELECT

public static final java.lang.String JOIN_TYPE_EXPRESSION_IN_SELECT

Join type property value for expression in select.

See Also:

Constant Field Values

Constructor Detail

LookupComponent

public LookupComponent(oracle.odi.domain.mapping.MapComponentOwner owner,
                       java.lang.String name)
                throws MappingException,
                       AdapterException

Construct a new persistent lookup component.

Parameters:

owner - The component owner that will own the new component.

name - The name for the new component.

Throws:

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

AdapterException

MappingException

Method Detail

getInScopeAttributeXMap

public java.util.Map getInScopeAttributeXMap(MapConnectorPoint inputPoint)
                                      throws MappingException,
                                             AdapterException

Specified by:

getInScopeAttributeXMap in interface IMapComponentOwner

Overrides:

getInScopeAttributeXMap in class oracle.odi.domain.mapping.MapComponentDelegate

Parameters:

inputPoint - The connector point where the upstream attribute search will begin.

Returns:

A hash map containing the attributes, keyed by attribute reference name.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

AdapterException

MappingException

initializeConnectorPoint

public void initializeConnectorPoint(MapConnectorPoint point)
                              throws oracle.odi.domain.mapping.exception.MapComponentException,
                                     PropertyException

Description copied from class: DefaultDelegate

Initializes the connector points. Called after a group is added, in case extra custom initialization is needed for the particular component. Default version does nothing.

Overrides:

initializeConnectorPoint in class JoinComponent

Parameters:

point - the group to be initialized

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

isDerived

public boolean isDerived()

Description copied from class: JoinComponent

Checks if this join component is a derived join.

Overrides:

isDerived in class JoinComponent

Returns:

true if this join component is derived from other joins.

See Also:

JoinComponent.getDerivedFrom(Dataset)

getInScopeLookupAttributes

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

Gets a list of map attributes which are in-scope through the lookup connector point

Returns:

list of attributes

Throws:

MappingException

AdapterException

getLookupSource

public IMapComponent getLookupSource()
                              throws MappingException,
                                     AdapterException

Gets the lookup (right side of join) source component.

Returns:

lookup map component.

Throws:

MappingException

AdapterException

getDriverSource

public IMapComponent getDriverSource()
                              throws MappingException,
                                     AdapterException

Gets the driver (left side of join) source map component.

Returns:

driver map component

Throws:

MappingException

AdapterException

isGenerateANSISyntax

public boolean isGenerateANSISyntax()
                             throws PropertyException

Determines whether ANSI syntax will be generated.

Overrides:

isGenerateANSISyntax in class JoinComponent

Returns:

true if ANSI syntax will be generated, otherwise false.

Throws:

PropertyException

getComponentForRole

public IMapComponent getComponentForRole(java.lang.String inputRole)
                                  throws PropertyException,
                                         oracle.odi.domain.mapping.exception.MapComponentException,
                                         MappingException,
                                         AdapterException

Gets the source component for the specified role, "DRIVER" or "LOOKUP".

Overrides:

getComponentForRole in class JoinComponent

Parameters:

inputRole - input role property, values are DRIVER, LOOKUP, LEFT, or RIGHT

Returns:

map component for the given role.

Throws:

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

AdapterException

getLookupConnectorPoint

public MapConnectorPoint getLookupConnectorPoint()
                                          throws PropertyException

Gets the input connector point associated with the lookup source.

Returns:

input connector point for the lookup

Throws:

PropertyException

getDriverConnectorPoint

public MapConnectorPoint getDriverConnectorPoint()
                                          throws PropertyException

Gets the input connector point associated with the driver source.

Returns:

input connector point for the driver

Throws:

PropertyException

setLookupTable

public void setLookupTable(IDataStore lookupTable)
                    throws MappingException,
                           AdapterException

Sets the lookup component connection for this component, using a source data store (table or file). The lookup component is the right side of the join, where non matching rows are excluded. The setDriverTable method is the companion to this method. This method is a convenience method, accepting a source model object, the file or table. The actual DataStore mapping component is created if it does not yet exist.

Parameters:

lookupTable - source model object to be used as the lookup.

Throws:

MappingException

AdapterException

See Also:

setLookupTable

setLookupTable

public void setLookupTable(ReusableMapping lookupRM)
                    throws MappingException,
                           AdapterException

Sets the lookup component connection for this component, using a source reusable mapping. The lookup component is the right side of the join, where non matching rows are excluded. The setDriverTable method is the companion to this method. This method is a convenience method, accepting a source model object, the reusable mapping. The actual reusable mapping component (usage of the reusable mapping) is created if it does not yet exist.

Parameters:

lookupRM - source model object to be used as the lookup.

Throws:

MappingException

AdapterException

See Also:

setLookupTable

setDriverTable

public void setDriverTable(IDataStore driverTable)
                    throws MappingException,
                           AdapterException

Sets the driver component connection for this component, using a source data store (table or file). The driver component is the left side of the join (left outer or subselect), where all rows are selected. The setLookupTable method is the companion to this method. This method is a convenience method, accepting a source model object. The actual Datastore or File component is created if it does not yet exist.

Parameters:

driverTable - source model object (datastore or file) to be connected (through a DataStore or File source component) to this component as the driver.

Throws:

MappingException

AdapterException

See Also:

setLookupTable

setDriverTable

public void setDriverTable(ReusableMapping driverRM)
                    throws MappingException,
                           AdapterException

Sets the driver component connection for this component, using a source reusable mapping. The driver component is the left side of the join, where all rows are selected. The setLookupTable method is the companion to this method. This method is a convenience method, accepting a source reusable mapping. The actual reusable mapping component is created if it does not yet exist.

Parameters:

driverRM - source reusable mapping to be connected to this component as the driver.

Throws:

MappingException

AdapterException

See Also:

setLookupTable

setDriverComponent

public void setDriverComponent(OutputConnectorPoint driverCompOCP)
                        throws MappingException,
                               AdapterException

Sets the driver component connection for this component. The driver component is the left side of the join, where all rows are selected. The setLookupComponent method is the companion to this method. This method is similar to another version which accepts a component parameter. This method is needed when the driver component has multiple output connections, and using the component as a parameter would cause ambiguity about which output connector to use for the connection.

Parameters:

driverCompOCP - output connector point of the driver component.

Throws:

MappingException

AdapterException

See Also:

setLookupTable

setLookupComponent

public void setLookupComponent(OutputConnectorPoint lookupCompOCP)
                        throws MappingException,
                               AdapterException

Sets the lookup component connection for this component. The lookup component is the right side of the join, where non-matching rows are excluded. The setDriverComponent method is the companion to this method. This method is similar to another version which accepts a component parameter. This method is needed when the lookup component has multiple output connections, and using the component as a parameter would cause ambiguity about which output connector to use for the connection.

Parameters:

lookupCompOCP - output connector point of the lookup component.

Throws:

MappingException

AdapterException

See Also:

setLookupTable

setDriverComponent

public void setDriverComponent(IMapComponent driverComp)
                        throws MappingException,
                               AdapterException

Sets the driver component for this component and connects them. The driver component is the left side of the join, where all rows are selected. The setLookupComponent method is the companion to this method.

Parameters:

driverCompOCP - output connector point of the driver component.

Throws:

MappingException

AdapterException

See Also:

setLookupTable

setLookupComponent

public void setLookupComponent(IMapComponent lookupComp)
                        throws MappingException,
                               AdapterException

Sets the lookup component connection for this component and connects them. The lookup component is the right side of the join, where non-matching rows are excluded. The setDriverComponent method is the companion to this method.

Parameters:

lookupCompOCP - output connector point of the lookup component.

Throws:

MappingException

AdapterException

See Also:

setLookupTable

setLookupType

public void setLookupType(LookupComponent.LookupType type)
                   throws PropertyException

Sets the lookup type, either left outer join or sub select

Parameters:

type - LookupType.LEFT_OUTER, LookupType.EXPRESSION_IN_SELECT

Throws:

PropertyException

setLookupType

public void setLookupType(java.lang.String type)
                   throws PropertyException

Sets the lookup type, either left outer join or sub select

Parameters:

type - LEFT_OUTER, EXPRESSION_IN_SELECT

Throws:

PropertyException

setJoinType

public void setJoinType(oracle.odi.mapping.generation.JoinTable.JoinType type)
                 throws PropertyException

Description copied from class: JoinComponent

Sets the join type as enum.

Overrides:

setJoinType in class JoinComponent

Parameters:

type - the enum value for the join type

Throws:

PropertyException

setJoinType

public void setJoinType(java.lang.String type)
                 throws PropertyException

Description copied from class: JoinComponent

Sets the join condition type as a string.

Overrides:

setJoinType in class JoinComponent

Parameters:

type - the join condition type.

Throws:

PropertyException

createLookup

public static LookupComponent createLookup(java.lang.String lookupName,
                                           IMapComponent driverSource,
                                           IMapComponent lookupSource,
                                           java.lang.String joinConditionText)
                                    throws MappingException,
                                           AdapterException

Creates a new lookup component with the specified driver and lookup source components, using the specified join condition.

Parameters:

lookupName - The name of the new lookup component.

driverSource - The first source to connect to the lookup input.

lookupSource - The second source to connect to the lookup input.

Returns:

The newly created lookup component

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

AdapterException

MappingException

createLookup

public static LookupComponent createLookup(IMapComponent driverSource,
                                           IMapComponent lookupSource,
                                           java.lang.String joinConditionText)
                                    throws MappingException,
                                           AdapterException

Creates a new lookup component with the specified driver and lookup sources, using the specified join condition.

Parameters:

driverSource - The first source to connect to the lookup input.

lookupSource - The second source to connect to the lookup input.

Returns:

The newly created lookup component

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

AdapterException

MappingException

getExecuteOnHint

public MapExpression.ExecuteOnLocation getExecuteOnHint()
                                                 throws PropertyException

Description copied from interface: IMapComponent

Return an execute location hint if the component supports it, otherwise "NO_HINT".

Overrides:

getExecuteOnHint in class JoinComponent

Throws:

PropertyException

setExecuteOnHint

public void setExecuteOnHint(MapExpression.ExecuteOnLocation hint)
                      throws PropertyException

Description copied from interface: IMapComponent

Set the execute-on hint for this component, if applicable, otherwise throw exception.

Overrides:

setExecuteOnHint in class JoinComponent

Throws:

PropertyException

getLookupAttributeDefaultValue

public java.lang.String getLookupAttributeDefaultValue(java.lang.String attrName)
                                                throws MappingException

Get the default value of a lookup attribute

Parameters:

attrName - Attribute name

Returns:

Default value as a string

Throws:

MappingException

getLookupAttributesDefaultValue

public java.util.Map getLookupAttributesDefaultValue()
                                              throws MappingException,
                                                     AdapterException

Get all lookup attributes default values

Returns:

All pairs of attribute name and its default value.

Throws:

MappingException

AdapterException

setLookupAttributeDefaultValue

public void setLookupAttributeDefaultValue(java.util.Map attributeDefaultValueMap)
                                    throws MappingException

Set the attributes' default values

Parameters:

attributeDefaultValueMap - Pairs of attribute name and default values

Throws:

MappingException

setLookupAttributeOrderBy

public void setLookupAttributeOrderBy(java.util.Map attributeOrderByMap)
                               throws MappingException

Set attributes' order fashion according to a Map containing the order info

Parameters:

attributeOrderByMap -

Throws:

MappingException

setLookupAttributeDefaultValue

public void setLookupAttributeDefaultValue(java.lang.String attrName,
                                           java.lang.String defaultValue)
                                    throws MappingException

Set a certain attribute's default value

Parameters:

attrName - Attribute name

defaultValue - The default value

Throws:

MappingException

getLookupAttributeOrderBy

public java.lang.String getLookupAttributeOrderBy(java.lang.String attrName)
                                           throws MappingException,
                                                  AdapterException

Gets the "order by" modifier (ASC/DESC) for the specified attribute

Parameters:

attrName - unqualified name of attribute to get the modifier for.

Throws:

MappingException

AdapterException

setLookupAttributeOrderBy

public void setLookupAttributeOrderBy(java.lang.String attrName,
                                      java.lang.String pOrderBy)
                               throws MappingException,
                                      AdapterException

Sets the order by modifier (ASC/DESC) for the given attribute. The entire ORDER BY property is changed to reflect this single attribute change, as the property specifies the ordering of all attributes. This method is used by LookupLogicalGraphNodeWrapper.setLookupAttributeOrderBy to set the ordering selected by a user in the attribute spread table.

Parameters:

attrName - unqualified name of the attribute, e.g. MapAttribute.getName()

orderBy - order by modifier, either ASC or DESC

Throws:

MappingException

AdapterException

getOrderedLookupAttributes

public MapAttribute[] getOrderedLookupAttributes()
                                          throws MappingException,
                                                 AdapterException

Gets an array of all lookup attributes, ordering specified by the attribute order by property. This list is used by the LookupLogicalGraphNodeWrapper.getOrderedLookupAttributes to build the attribute spread table in the correct order. That table allows a user to specify the ordering (ASC/DESC) and default value for each attribute.

Returns:

lookup attribute list

Throws:

MappingException

AdapterException

getNoMatchRows

public LookupComponent.NO_MATCH_ROWS getNoMatchRows()
                                             throws PropertyException

Gets the lookup option to be applied if no rows are matched in the lookup table. Valid values are: NO_MATCH_ROWS.NO_ROW: no rows are returned, NO_MATCH_ROWS.DEFAULT_VALUES: an artificial row with default values is returned

Returns:

noMatchRows option for lookup behavior if no rows are matched in the lookup table.

Throws:

PropertyException

setNoMatchRows

public void setNoMatchRows(LookupComponent.NO_MATCH_ROWS noMatchRows)
                    throws PropertyException

Specifies the lookup behavior if no rows are matched in the lookup table. Valid values are: NO_MATCH_ROWS.NO_ROW: no rows are returned, NO_MATCH_ROWS.DEFAULT_VALUES: an artificial row with default values is returned

Parameters:

noMatchRows - option for lookup behavior if no rows are matched in the lookup table.

Throws:

PropertyException

getNthRowNumber

public int getNthRowNumber()
                    throws PropertyException

Gets the row number to return if multiple matching rows are found in the lookup table.

Returns:

row number to return if multiple matching rows are found

Throws:

PropertyException

setNthRowNumber

public void setNthRowNumber(int nthRowNumber)
                     throws PropertyException

Sets the row number to return if multiple matching rows are found in the lookup table.

Parameters:

nthRowNumber - row number to return if multiple matching rows are found

Throws:

PropertyException

getJoinTypeAsEnum

public oracle.odi.mapping.generation.JoinTable.JoinType getJoinTypeAsEnum()
                                                                   throws PropertyException

Gets the enum value of the join condition type property. The join condition type indicates whether the join is an inner, or left/right/full outer join.

Overrides:

getJoinTypeAsEnum in class JoinComponent

Returns:

The join condition type.

Throws:

PropertyException