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, 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 /st_odi_12.1.2.0.0/1 2013/09/09 20:29:17 dwenberg Exp $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LookupComponent.LookupType

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_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_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(MapComponent component)
LookupComponent(MapComponentOwner owner, java.lang.String name) Construct a new persistent lookup component.

Method Summary

Methods

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) A convenience method to create a new lookup component with the specified driver and lookup sources, using the specified join condition.
IMapComponent	getComponentForRole(java.lang.String inputRole) Gets the source component playing the specified input role, which can be either LEFT or RIGHT.
MapConnectorPoint	getDriverConnectorPoint()
IMapComponent	getDriverSource()
java.lang.String	getDriverSourceName()
MapExpression.ExecuteOnLocation	getExecuteOnHint() Return an execute location hint if the component supports it, otherwise "NO_HINT".
java.util.Map	getInScopeAttributeXMap(MapConnectorPoint inputPoint)
MapConnectorPoint	getLookupConnectorPoint()
IMapComponent	getLookupSource()
java.lang.String	getLookupSourceName()
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	setDriverTable(IDataStore driverTable)
void	setDriverTable(ReusableMapping driverRM)
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	setLookupTable(IDataStore lookupTable)
void	setLookupTable(ReusableMapping lookupRM)
void	setLookupType(LookupComponent.LookupType type)
void	setLookupType(java.lang.String type)

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

addJoinSource, connectReferencedSourcesToJoin, createInputConnectorPoint, findConnectorPointWithRole, getDerivedFromText, getDerivedJoins, getDerivedJoinsText, getJoinCondition, getJoinConditionText, getJoinOrder, getJoinSourceOrderText, getJoinType, getJoinTypeAsEnum, 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

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

customSyncComponent, fixExpressions, getBlockExpressionReferencedAttributes, getExecuteOnHintString, getIntegrationType, getNextAvailableInput, getNextAvailableInput, getNextAvailableOutput, invalidateExpressions, isAddInputConnectorPointAllowed, isAddOutputConnectorPointAllowed, isPassive, setExecuteOnHintByString

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

afterAddComponent, afterPropertyChange, afterRemoveComponent, allowInputAttribute, connectFrom, createInputConnectorPoint, createOutputConnectorPoint, createOutputConnectorPoint, customValidateProposedChildConnection, customValidateProposedChildScoping, equals, getBoundObjectFullName, getBoundObjectName, getBoundShortcutFullName, getComponentContext, getComponentCustomLocation, getComponentType, getSQLAccessName, getTypeName, handleChildMapChangeEvent, hashCode, initPhysicalNode, isBoundObjectDeleted, isCompositeComponentType, setComponentType, supportComponentOfType, toString

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

addComponent, addProperty, afterConnect, bindTo, bindTo, connectTo, connectTo, connectTo, connectTo, containsComponent, createComponent, createComponent, createComponent, createExpressionAttribute, createExpressionAttribute, createOutputConnectorPoint, createProperty, dump, dump, findAllComponents, findAllSplitPaths, findComponent, findComponentBoundTo, findComponentOfType, findConnector, findConnectorPoint, findInputAttribute, findOutputAttribute, findSubComponentOwner, generateUniqueComponentName, generateUniqueComponentName, generateUniqueConnectorName, generateUniqueName, generateUniqueName, getAdapter, getAlias, getAllComponents, getAllComponentsOfType, getAllExpressions, getAllPathsFrom, getAllPathsFrom, getAllProperties, getAllSubComponentOwners, getAttributeExpressions, getAttributes, getBooleanPropertyValue, getBoundObject, getBoundShortcut, getBoundTechnology, getBusinessName, getCachedIssues, getComponentAttributeMap, getComponentCategory, getComponentCount, getComponentLocation, getComponentOwner, getComponents, getComponentTypeName, getCompositeQualifier, getConnectorPointCount, getConnectorPointCount, getConnectorPoints, getConnectorPoints, getConnectorPointToLeaf, getConnectorTo, getDelegate, getDescription, getDisplayableObjectName, getDisplayableProperties, getDisplayableTypeName, getDomainInterfaceType, getDownstreamConnectedLeafComponents, getDownstreamConnectedPoints, getExpressionPropertyValue, getExpressionReferences, getExpressionValidationCode, getExtraCreatedObjects, getFlowConstraints, getFullName, getGlobalId, getGUID, getInputConnectorPoint, getInputConnectorPoint, getInputConnectorPointCount, getInputConnectorPoints, getInputPoint, getInScopeAttributes, getInScopeAttributeXMap, getInternalId, getIntPropertyValue, getLeafLevelComponents, getLeafLevelTargets, getMapRootContainer, getName, getNumericId, getOutputAttributeExpressions, getOutputAttributes, getOutputConnectorPoint, getOutputConnectorPoint, getOutputConnectorPointCount, getOutputConnectorPoints, getOutputPoint, getOwner, getOwningComponent, getPersistentClassName, getPersistentComponent, getPrefix, getProjectedAttributes, getProjectorOrMultiInputSource, getProperties, getProperty, getPropertyDefinitionOwner, getPropertyValue, getPropertyValueReference, getProposedConnectionIssues, getProposedConnectionIssues, getProposedScopingIssues, getQualifiedName, getRootComponentOwner, getRootContainer, getScopingInputPointForSource, getSecurityContainer, getSources, getStringPropertyValue, getStrongTypeClassName, getSyncState, getTargets, getTopLevelComponentsOfType, getTopLevelSources, getTopLevelTargets, getTopmostComponent, getUpstreamAttributeXMap, getUpstreamComponentOwner, getUpstreamConnectedLeafComponents, getUpstreamConnectedLeafPoints, getUpstreamConnectedPoints, getUpstreamInScopeLeafAttributes, getUpstreamInScopeLeafComponentsFor, getUpstreamInScopeLeafPoints, getUpstreamLeafAttributes, getUpstreamLeafAttributes, getUpstreamLeafConnectorPoints, getUpstreamLeafSources, getUpstreamSources, getUpstreamSplitPaths, hasCustomizedPersistenceMethodFor, invalidateDownstreamExpressions, invokeCustomizedPersistenceMethodFor, invokeMethod, isBound, isComponent, isComponentLevelConnectAllowed, isCompositeComponent, isDecorator, isEndpoint, isHidden, isInScope, isInScope, isMultiInputSelector, isOfType, isProjector, isPropertyDefined, isProposedConnectionValid, isProposedConnectionValid, isProposedScopingValid, isSelector, isSource, isSubComponent, isTarget, isUniqueComponentName, isUniqueComponentName, referencesObject, removeAllConnections, removeAllConnections, removeAllConnectionsAndReroute, removeAllConnectionsAndReroute, removeAllInputConnections, removeComponent, removeComponent, removeInputConnectorPoint, removeInputConnectorPoint, removeInputConnectorPoint, removeOutputConnectorPoint, removeOutputConnectorPoint, removeProperty, reorderInputConnectorPoint, reorderOutputConnectorPoint, rerouteConnections, setAlias, setAttributeExpressionText, setAttributeExpressionText, setBooleanPropertyValue, setBusinessName, setDescription, setIntPropertyValue, setIsHidden, setName, setPropertyValue, syncComponent, 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

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_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(MapComponent component)
                throws MappingException

Throws:

MappingException

LookupComponent

public LookupComponent(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)

getLookupSourceName

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

Throws:

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

AdapterException

MappingException

getDriverSourceName

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

Throws:

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

AdapterException

MappingException

getLookupSource

public IMapComponent getLookupSource()
                              throws MappingException,
                                     AdapterException

Throws:

MappingException

AdapterException

getDriverSource

public IMapComponent getDriverSource()
                              throws MappingException,
                                     AdapterException

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 MappingException,
                                         AdapterException

Description copied from class: JoinComponent

Gets the source component playing the specified input role, which can be either LEFT or RIGHT. The source component connected to the first input connector point is on the left and the source component connected to the second connector point is on the right. A source component is either a projector component or a multi-input selector component.

Overrides:

getComponentForRole in class JoinComponent

Parameters:

inputRole - the input role for which to find the input component.

Returns:

the input component for the specified role.

Throws:

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

AdapterException

getLookupConnectorPoint

public MapConnectorPoint getLookupConnectorPoint()
                                          throws PropertyException

Throws:

PropertyException

getDriverConnectorPoint

public MapConnectorPoint getDriverConnectorPoint()
                                          throws PropertyException

Throws:

PropertyException

setLookupTable

public void setLookupTable(IDataStore lookupTable)
                    throws MappingException,
                           AdapterException

Throws:

MappingException

AdapterException

setLookupTable

public void setLookupTable(ReusableMapping lookupRM)
                    throws MappingException,
                           AdapterException

Throws:

MappingException

AdapterException

setDriverTable

public void setDriverTable(IDataStore driverTable)
                    throws MappingException,
                           AdapterException

Throws:

MappingException

AdapterException

setDriverTable

public void setDriverTable(ReusableMapping driverRM)
                    throws MappingException,
                           AdapterException

Throws:

MappingException

AdapterException

setLookupType

public void setLookupType(LookupComponent.LookupType type)
                   throws PropertyException

Throws:

PropertyException

setLookupType

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

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

A convenience method to create a new lookup component with the specified driver and lookup sources, 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