oracle.odi.domain.mapping.component

Class JoinComponent

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

All Implemented Interfaces:

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

Direct Known Subclasses:

LookupComponent

public class JoinComponent
extends DefaultDelegate

Delegate class for the join interface component.

Nested Class Summary

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 for this component.
static java.lang.String	JOIN_TYPE_CROSS Join type property value for cross join.
static java.lang.String	JOIN_TYPE_FULL_OUTER Join type property value for full outer join.
static java.lang.String	JOIN_TYPE_INNER Join type property value for inner join.
static java.lang.String	JOIN_TYPE_LEFT_OUTER Join type property value for left outer join.
static java.lang.String	JOIN_TYPE_NATURAL Join type property value for natural join.
static java.lang.String	JOIN_TYPE_RIGHT_OUTER Join type property value for right outer join.
static java.lang.String	PROPKEY_ACTIVE_INDICATOR Property key name for the active indicator property.
static java.lang.String	PROPKEY_DEFAULT_JOIN Property key name for the default join property
static java.lang.String	PROPKEY_DERIVED_FROM Property key name for the derived from property
static java.lang.String	PROPKEY_DERIVED_JOINS Property key name for the derived joins property
static java.lang.String	PROPKEY_GENERATE_ANSI Property key name for the ordered join property.
static java.lang.String	PROPKEY_JOIN_CONDITION Property key name for the join condition property.
static java.lang.String	PROPKEY_JOIN_INPUT_ROLE
static java.lang.String	PROPKEY_JOIN_ORDER Property key name for the join order property.
static java.lang.String	PROPKEY_JOIN_SOURCE_ORDER Property key name for the join source order property
static java.lang.String	PROPKEY_JOIN_TYPE Property key name for the join type property.
static java.lang.String	PROPKEY_TECHNICAL_DESCRIPTION Property key name for the 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

Method Summary

Modifier and Type	Method and Description
void	addJoinSource(IMapComponent source, java.lang.String conditionText) Adds a join source to an existing join.
void	connectReferencedSourcesToJoin() Adds input connections from sources that are referenced in the join condition.
MapConnectorPoint	createInputConnectorPoint(java.lang.String name) Adds an input connector point if name is null or empty --> a new input connector point, even if unconnected input connector points exists if name is not empty --> a new input connector point with the specified name if there are no remaining unconnected input connector points, otherwise an existing unconnected input connector point is renamed and returned
MapConnectorPoint	findConnectorPointWithRole(java.lang.String pRole) Finds the connector point for the specified input role.
IMapComponent	getComponentForRole(java.lang.String inputRole) Gets the source component playing the specified input role, which can be either LEFT or RIGHT.
java.lang.String	getDerivedFromText() Returns the "derived from" property value for a join.
java.util.List	getDerivedJoins(Dataset dataset) Gets the list of derived joins that are derived from this join.
java.lang.String	getDerivedJoinsText() Gets the comma separated list of names of derived join components that are derived from this join.
MapExpression.ExecuteOnLocation	getExecuteOnHint() Return an execute location hint if the component supports it, otherwise "NO_HINT".
MapExpression	getJoinCondition() Gets the expression value for the join condition property.
java.lang.String	getJoinConditionText() Gets the expression text value for the join condition property.
int	getJoinOrder() Gets the join order property value, as an integer.
java.lang.String	getJoinSourceOrderText() Gets the join source order text as a comma separated list of source component names.
java.lang.String	getJoinType() Gets the string value of the join condition type property.
oracle.odi.mapping.generation.JoinTable.JoinType	getJoinTypeAsEnum() Gets the enum value of the join condition type property.
java.lang.String	getLeftSourceName() Gets the name of the source component playing the role of "left" join source.
java.util.List	getOrderedJoinSources() Gets the list of ordered join sources (from left to right).
java.util.List	getReferencedSources() Gets the sources that are referenced by the join condition for the join component.
java.lang.String	getRightSourceName() Gets the name of the source component playing the role of "right" join source.
java.lang.String	getSourceNameForRole(java.lang.String inputRole) Gets the name of the source component playing the specified input role, which can be either LEFT or RIGHT.
java.lang.String	getTechnicalDescription() If this is a Join/Filter/LookUp/Datastore Component return technical description of corresponding expression
void	handleMapChangeEvent(oracle.odi.domain.mapping.MapChangeEvent event)
boolean	hasUserDefinedJoinOrder() Checks if the join order is user-defined.
void	initializeConnectorPoint(MapConnectorPoint point) Initializes the connector points.
boolean	isCrossJoin() Checks if this join is a cross join.
boolean	isDefaultJoin() Checks if this join component is a default join.
boolean	isDerived() Checks if this join component is a derived join.
boolean	isFullOuterJoin() Checks if this join is a full outer join.
boolean	isGenerateANSISyntax() Gets the "generate ANSI syntax" boolean property value.
boolean	isInnerJoin() Checks if this join is an inner join.
boolean	isJoinInsideDataset() Checks if this join is within a Dataset.
boolean	isLeftOrRightOuterJoin() Checks if this join is a left or right outer join.
boolean	isLeftOuterJoin() Checks if this join is a left outer join.
boolean	isNaturalJoin() Checks if this join is a natural join.
boolean	isRightOuterJoin() Checks if this join is a right outer join.
boolean	isValidForTechnology(ITechnology techno, java.util.List issues) Check whether component is valid for a technology.
static JoinComponent	joinSources(IMapComponent source1, IMapComponent source2, java.lang.String joinConditionText) Creates a new join component to join the two specified sources, using the specified join condition.
static JoinComponent	joinSources(java.lang.String joinName, IMapComponent source1, IMapComponent source2, java.lang.String joinConditionText) Creates a new join component to join the two specified sources, using the specified join condition.
void	setDerivedFromText(java.lang.String text) Sets the "derived from" property text.
void	setDerivedJoinsText(java.lang.String derivedJoins) Sets the list of names for joins derived from this join.
void	setExecuteOnHint(MapExpression.ExecuteOnLocation hint) Set the execute-on hint for this component, if applicable, otherwise throw exception.
void	setGenerateANSISyntax(boolean generateANSISyntax) Sets the generate ANSI syntax flag.
void	setJoinConditionText(java.lang.String text) Sets the join condition text for the join condition expression property for the component.
void	setJoinOrder(int order) Sets the join order, as an integer value.
void	setJoinSourceOrderText(java.lang.String text) Sets the join source order text for the join source order property.
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	setPropertyValue(java.lang.String key, java.lang.Object value) Set a property value for the property with the specified key name.

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, beforePropertyChange, connectFrom, createInputConnectorPoint, createOutputConnectorPoint, createOutputConnectorPoint, customValidateProposedChildConnection, customValidateProposedChildScoping, equals, getBoundObjectFullName, getBoundObjectName, getBoundShortcutFullName, getComponentContext, getComponentCustomLocation, getComponentType, getInScopeAttributeXMap, getSQLAccessName, getSQLAliasName, getTypeName, handleChildMapChangeEvent, hashCode, initPhysicalNode, isAttributeExecuteOnLocationHidden, isBoundObjectDeleted, isCardinalitySource, isCompositeComponentType, isExpressionHidden, isTargetLoadingSupported, propertyValueGetterHook, 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 for this component.

See Also:

Constant Field Values

PROPKEY_JOIN_CONDITION

public static final java.lang.String PROPKEY_JOIN_CONDITION

Property key name for the join condition property.

See Also:

Constant Field Values

PROPKEY_JOIN_TYPE

public static final java.lang.String PROPKEY_JOIN_TYPE

Property key name for the join type property.

See Also:

Constant Field Values

PROPKEY_GENERATE_ANSI

public static final java.lang.String PROPKEY_GENERATE_ANSI

Property key name for the ordered join property.

See Also:

Constant Field Values

PROPKEY_JOIN_ORDER

public static final java.lang.String PROPKEY_JOIN_ORDER

Property key name for the join order property.

See Also:

Constant Field Values

PROPKEY_JOIN_SOURCE_ORDER

public static final java.lang.String PROPKEY_JOIN_SOURCE_ORDER

Property key name for the join source order property

See Also:

Constant Field Values

PROPKEY_DERIVED_FROM

public static final java.lang.String PROPKEY_DERIVED_FROM

Property key name for the derived from property

See Also:

Constant Field Values

PROPKEY_DERIVED_JOINS

public static final java.lang.String PROPKEY_DERIVED_JOINS

Property key name for the derived joins property

See Also:

Constant Field Values

PROPKEY_ACTIVE_INDICATOR

public static final java.lang.String PROPKEY_ACTIVE_INDICATOR

Property key name for the active indicator property.

See Also:

Constant Field Values

PROPKEY_DEFAULT_JOIN

public static final java.lang.String PROPKEY_DEFAULT_JOIN

Property key name for the default join property

See Also:

Constant Field Values

JOIN_TYPE_INNER

public static final java.lang.String JOIN_TYPE_INNER

Join type property value for inner join.

See Also:

Constant Field Values

JOIN_TYPE_LEFT_OUTER

public static final java.lang.String JOIN_TYPE_LEFT_OUTER

Join type property value for left outer join.

See Also:

Constant Field Values

JOIN_TYPE_RIGHT_OUTER

public static final java.lang.String JOIN_TYPE_RIGHT_OUTER

Join type property value for right outer join.

See Also:

Constant Field Values

JOIN_TYPE_FULL_OUTER

public static final java.lang.String JOIN_TYPE_FULL_OUTER

Join type property value for full outer join.

See Also:

Constant Field Values

JOIN_TYPE_NATURAL

public static final java.lang.String JOIN_TYPE_NATURAL

Join type property value for natural join.

See Also:

Constant Field Values

JOIN_TYPE_CROSS

public static final java.lang.String JOIN_TYPE_CROSS

Join type property value for cross join.

See Also:

Constant Field Values

PROPKEY_JOIN_INPUT_ROLE

public static final java.lang.String PROPKEY_JOIN_INPUT_ROLE

See Also:

Constant Field Values

PROPKEY_TECHNICAL_DESCRIPTION

public static final java.lang.String PROPKEY_TECHNICAL_DESCRIPTION

Property key name for the technical description

See Also:

Constant Field Values

Constructor Detail

JoinComponent

public JoinComponent(oracle.odi.domain.mapping.MapComponent component)
              throws MappingException

For internal use only. Join delegate constructor.

Parameters:

component -

Throws:

MappingException

JoinComponent

public JoinComponent(MapComponentType componentType)
              throws oracle.odi.domain.mapping.exception.MapComponentException

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

JoinComponent

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

Constructs a new persistent join component.

Parameters:

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

name - the name for the new component.

Throws:

PropertyException

MappingException

AdapterException

Method Detail

createInputConnectorPoint

public MapConnectorPoint createInputConnectorPoint(java.lang.String name)
                                            throws MappingException

Adds an input connector point
if name is null or empty --> a new input connector point, even if unconnected input connector points exists
if name is not empty --> a new input connector point with the specified name if there are no remaining unconnected input connector points, otherwise an existing unconnected input connector point is renamed and returned

Overrides:

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

Parameters:

name - name of the connector point

Returns:

The newly created input connector point, or an unused existing one, or null.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

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.

Parameters:

point - the group to be initialized

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

getSourceNameForRole

public java.lang.String getSourceNameForRole(java.lang.String inputRole)
                                      throws MappingException,
                                             AdapterException

Gets the name of 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.

Parameters:

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

Returns:

the name of the input component for the specified role.

Throws:

MappingException

AdapterException

getComponentForRole

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

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.

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

findConnectorPointWithRole

public MapConnectorPoint findConnectorPointWithRole(java.lang.String pRole)
                                             throws PropertyException

Finds the connector point for the specified input role.

Parameters:

pRole - the role for which an input connector point is to be found.

Returns:

the input connector point for the role.

Throws:

PropertyException

getLeftSourceName

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

Gets the name of the source component playing the role of "left" join source. 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.

Returns:

the left source component

Throws:

MappingException

AdapterException

getRightSourceName

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

Gets the name of the source component playing the role of "right" join source. 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.

Returns:

the right source component

Throws:

MappingException

AdapterException

getJoinCondition

public MapExpression getJoinCondition()
                               throws PropertyException

Gets the expression value for the join condition property.

Returns:

the join condition expression.

Throws:

PropertyException

isGenerateANSISyntax

public boolean isGenerateANSISyntax()
                             throws PropertyException

Gets the "generate ANSI syntax" boolean property value.

Returns:

the "generate ANSI syntax" flag

Throws:

PropertyException

setGenerateANSISyntax

public void setGenerateANSISyntax(boolean generateANSISyntax)
                           throws PropertyException

Sets the generate ANSI syntax flag.

Parameters:

generateANSISyntax - the flag for generating ANSI syntax.

Throws:

PropertyException

getJoinOrder

public int getJoinOrder()
                 throws PropertyException

Gets the join order property value, as an integer.

Returns:

the join order number. If there is no user defined join order, return -1.

Throws:

PropertyException

setJoinOrder

public void setJoinOrder(int order)
                  throws PropertyException

Sets the join order, as an integer value.

Parameters:

order - the integer join order value.

Throws:

PropertyException

hasUserDefinedJoinOrder

public boolean hasUserDefinedJoinOrder()
                                throws PropertyException

Checks if the join order is user-defined.

Returns:

true if join order is user defined, false, otherwise.

Throws:

PropertyException

getOrderedJoinSources

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

Gets the list of ordered join sources (from left to right).

Returns:

the join sources in proper order

Throws:

AdapterException

MappingException

setJoinSourceOrderText

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

Sets the join source order text for the join source order property.

Parameters:

text - The new join source order text.

Throws:

PropertyException

MappingException

getJoinSourceOrderText

public java.lang.String getJoinSourceOrderText()
                                        throws MappingException

Gets the join source order text as a comma separated list of source component names. The first two component names in this list are from the left and right components of this join, respectively. And the remaining names are from additional sources referenced in the join condition.

Returns:

the text for join source order property.

Throws:

MappingException

getDerivedFromText

public java.lang.String getDerivedFromText()
                                    throws PropertyException

Returns the "derived from" property value for a join. The "derived from" property only makes sense for a derived join. If this method is called on a regular join, it returns an empty string.

Returns:

The text value of the "derived from" property, which is a comma separated list of names of join components from which this derived join derives. This method never returns null.

Throws:

PropertyException

setDerivedFromText

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

Sets the "derived from" property text. This property is set only on a derived join. It lists all the regular joins this derived join derives from.

Parameters:

text - the new "derived from" text value, which is a comma separated list of names of join components from which this derived join derives.

Throws:

MappingException

getDerivedJoins

public java.util.List getDerivedJoins(Dataset dataset)
                               throws oracle.odi.domain.mapping.exception.MapComponentException,
                                      MappingException,
                                      AdapterException

Gets the list of derived joins that are derived from this join.

A prerequisite of this method is that the expression value is parsed, and all the cross references are valid. If this is not true, e.g., in the case when the join is just removed, this method will not return correct list of derived joins. For such case, consider using the method findDerivedJoins in Dataset.

Parameters:

dataset - find the derived joins in this dataset

Returns:

a list of joins derived from this join.

Throws:

AdapterException

MappingException

oracle.odi.domain.mapping.exception.MapComponentException

See Also:

Dataset.findDerivedJoins(JoinComponent)

getDerivedJoinsText

public java.lang.String getDerivedJoinsText()
                                     throws PropertyException

Gets the comma separated list of names of derived join components that are derived from this join.

Returns:

a list of names for joins derived from this join. This method never returns null.

Throws:

PropertyException

setDerivedJoinsText

public void setDerivedJoinsText(java.lang.String derivedJoins)
                         throws MappingException

Sets the list of names for joins derived from this join.

Parameters:

derivedJoins - a comma separated list of derived join names.

Throws:

MappingException

getJoinConditionText

public java.lang.String getJoinConditionText()
                                      throws PropertyException

Gets the expression text value for the join condition property.

Returns:

The join condition expression text.

Throws:

PropertyException

getJoinType

public java.lang.String getJoinType()
                             throws PropertyException

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

Returns:

the join condition type.

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.

Returns:

The join condition type.

Throws:

PropertyException

setJoinConditionText

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

Sets the join condition text for the join condition expression property for the component.

Parameters:

text - the new join condition expression text.

Throws:

PropertyException

MappingException

setPropertyValue

public void setPropertyValue(java.lang.String key,
                             java.lang.Object value)
                      throws PropertyException

Description copied from interface: IPropertyOwner

Set a property value for the property with the specified key name.

Specified by:

setPropertyValue in interface IPropertyOwner

Overrides:

setPropertyValue in class oracle.odi.domain.mapping.MapComponentDelegator

Parameters:

key - The name of the property whose value will be set.

value - The object value of the property. The interpretation of the object type will be determined by the type of the property.

Throws:

PropertyException

setJoinType

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

Sets the join condition type as a string.

Parameters:

type - the join condition type.

Throws:

PropertyException

setJoinType

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

Sets the join type as enum.

Parameters:

type - the enum value for the join type

Throws:

PropertyException

getReferencedSources

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

Gets the sources that are referenced by the join condition for the join component.

Returns:

a list of referenced sources. If this join component is within a dataset, the list is also ordered: the the first element in the return list is the left source and the second is the right source, and the remaining sources in the list are additional sources referenced in the join condition.

Throws:

MappingException

AdapterException

joinSources

public static JoinComponent joinSources(java.lang.String joinName,
                                        IMapComponent source1,
                                        IMapComponent source2,
                                        java.lang.String joinConditionText)
                                 throws MappingException,
                                        AdapterException

Creates a new join component to join the two specified sources, using the specified join condition. The join must not have any existing input connections.

Parameters:

joinName - the name of the new join component.

source1 - the first source to connect to the join input.

source2 - the second source to connect to the join input.

Returns:

the newly created join component.

Throws:

MappingException

AdapterException

joinSources

public static JoinComponent joinSources(IMapComponent source1,
                                        IMapComponent source2,
                                        java.lang.String joinConditionText)
                                 throws MappingException,
                                        AdapterException

Creates a new join component to join the two specified sources, using the specified join condition. The join must not have any existing input connections.

Parameters:

source1 - the first source to connect to the join input.

source2 - the second source to connect to the join input.

Returns:

the newly created join component

Throws:

MappingException

AdapterException

addJoinSource

public void addJoinSource(IMapComponent source,
                          java.lang.String conditionText)
                   throws MappingException

Adds a join source to an existing join. The condition is "AND" with the existing condition.

Parameters:

source - the source to add to the join.

conditionText - the condition that relates the source to the existing join sources.

Throws:

MappingException

connectReferencedSourcesToJoin

public void connectReferencedSourcesToJoin()
                                    throws MappingException,
                                           AdapterException

Adds input connections from sources that are referenced in the join condition. The connections will be added in order and all extra unconnected input connector points will be deleted.

Throws:

MappingException

AdapterException

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 DefaultDelegate

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 DefaultDelegate

Throws:

PropertyException

isJoinInsideDataset

public boolean isJoinInsideDataset()
                            throws oracle.odi.domain.mapping.exception.MapComponentException

Checks if this join is within a Dataset.

Returns:

true if this join component is within a Dataset, false otherwise.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

isDerived

public boolean isDerived()

Checks if this join component is a derived join.

Returns:

true if this join component is derived from other joins.

See Also:

getDerivedFrom(Dataset)

isDefaultJoin

public boolean isDefaultJoin()
                      throws MappingException

Checks if this join component is a default join.

Returns:

true if this join is the default join, false, otherwise.

Throws:

MappingException

handleMapChangeEvent

public void handleMapChangeEvent(oracle.odi.domain.mapping.MapChangeEvent event)

Overrides:

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

getTechnicalDescription

public java.lang.String getTechnicalDescription()
                                         throws PropertyException

Description copied from interface: IMapComponent

If this is a Join/Filter/LookUp/Datastore Component return technical description of corresponding expression

Overrides:

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

Returns:

The technical description string.

Throws:

PropertyException

isInnerJoin

public boolean isInnerJoin()
                    throws PropertyException

Checks if this join is an inner join.

Returns:

true if this join is an inner join, false otherwise.

Throws:

PropertyException

isLeftOuterJoin

public boolean isLeftOuterJoin()
                        throws PropertyException

Checks if this join is a left outer join.

Returns:

true if this join is a left outer join, false otherwise.

Throws:

PropertyException

isRightOuterJoin

public boolean isRightOuterJoin()
                         throws PropertyException

Checks if this join is a right outer join.

Returns:

true if this join is a right outer join, false otherwise.

Throws:

PropertyException

isFullOuterJoin

public boolean isFullOuterJoin()
                        throws PropertyException

Checks if this join is a full outer join.

Returns:

true if this join is a full outer join, false otherwise.

Throws:

PropertyException

isLeftOrRightOuterJoin

public boolean isLeftOrRightOuterJoin()
                               throws PropertyException

Checks if this join is a left or right outer join.

Returns:

true if this join is a left or right outer join, false otherwise.

Throws:

PropertyException

isCrossJoin

public boolean isCrossJoin()
                    throws PropertyException

Checks if this join is a cross join.

Returns:

true if this join is a cross join, false otherwise.

Throws:

PropertyException

isNaturalJoin

public boolean isNaturalJoin()
                      throws PropertyException

Checks if this join is a natural join.

Returns:

true if this join is a natural join, false otherwise.

Throws:

PropertyException

isValidForTechnology

public boolean isValidForTechnology(ITechnology techno,
                                    java.util.List issues)
                             throws MappingException

Description copied from interface: IMapComponent

Check whether component is valid for a technology.

Overrides:

isValidForTechnology in class DefaultDelegate

Parameters:

techno - The technology to validate against

Returns:

true if valid, false if not

Throws:

MappingException