oracle.odi.domain.project.interfaces
Class Join

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.project.interfaces.GenericClause
              oracle.odi.domain.project.interfaces.Join

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity, IInterfaceSubComponent

public class Join
extends GenericClause

This class represents a join in an interface.

Since:

11.1.1.3.0

See Also:

Serialized Form

Constructor Summary

Join(DataSet pDataSet, java.lang.String pSql, boolean pOrdered, OdiInterface.ExecutionLocation pExecutionLocation)
Internal use only Builds a join clause in the parent dataset using the specified SQL expression text, clause type (ordered, non-ordered or cross join) and the desired execution location.

Join(SourceDataStore pSourceDataStore1, SourceDataStore pSourceDataStore2, OdiInterface.ExecutionLocation pExecutionLocation)
Internal use only Builds a non-ordered cross join clause in the same dataset as the the two specified source data sources with the desired execution location.

Method Summary

SourceDataStore	getAttachedDataStore1() Returns the source data store attached to the left side of this join.
SourceDataStore	getAttachedDataStore2() Returns the source data store attached to the right side of this join.
java.lang.String	getSubComponentDescription() Returns the sub component's description in a human-readable way.
java.lang.String	getSubComponentDescription(java.util.Locale pLocale) Returns the sub component's description in a human-readable way for the given Locale.
boolean	isCross() Returns whether this join is a cross join or not.
boolean	isLookup() Returns whether this join clause represents a lookup operation or not.
boolean	isNatural() Returns whether this join is a natural join or not.
boolean	isOrdered() Returns whether this join clause to an ordered join or not.
boolean	isOuter1() Returns whether the source data store on the left side of this join is set to be preserving (outer join) or not.
boolean	isOuter2() Returns whether the source data store on the right side of this join is set to be preserving (outer join) or not.
void	setAttachedDataStore1(SourceDataStore pAttachedDataStore) Internal use only Sets the source data store attached to the left side of this join.
void	setAttachedDataStore2(SourceDataStore pAttachedDataStore) Internal use only Sets the right side of the source data store attached to this join.
void	setCross(boolean pCross) Internal use only Sets this join clause to be a cross join.
void	setLookup(boolean pLookup) Internal use only Sets whether this join clause represents a lookup operation or not.
void	setNatural(boolean pNatural) Internal use only Sets this join clause to be a natural join.
void	setOrdered(boolean pOrdered) Sets whether this join clause to be an ordered join.
void	setOuter1(boolean pOuter1) Internal use only Sets whether the source data store on the left side of this join is set to be preserving (outer join) or not.
void	setOuter2(boolean pOuter2) Internal use only Sets whether the source data store on the right side of this join is set to be preserving (outer join) or not.

Methods inherited from class oracle.odi.domain.project.interfaces.GenericClause

getBusinessRule, getClauseId, getClauseOrder, getDataSet, getExecutionLocation, getIndexType1, getIndexType2, getInternalId, getNonPersistedSql, getSecurityContainer, getSourceSet, getSql, getSqlExpression, getSqlExpressionId, getTechnicalDescription, isEnabled, setBusinessRule, setClauseOrder, setEnabled, setExecutionLocation, setIndexType1, setIndexType2, setSourceSet, setSqlExpression

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

clone

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Join

public Join(DataSet pDataSet,
            java.lang.String pSql,
            boolean pOrdered,
            OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Builds a join clause in the parent dataset using the specified SQL expression text, clause type (ordered, non-ordered or cross join) and the desired execution location.

Parameters:

pDataSet - the parent dataset for this join.

pSql - the SQL expression text for this join.

pOrdered - true if the join is an ordered join, false otherwise.

pExecutionLocation - the execution location of this join.

Join

public Join(SourceDataStore pSourceDataStore1,
            SourceDataStore pSourceDataStore2,
            OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Builds a non-ordered cross join clause in the same dataset as the the two specified source data sources with the desired execution location.

Parameters:

pSourceDataStore1 - the first source data store for cross join.

pSourceDataStore2 - the second source data store for cross join.

pExecutionLocation - the execution location of this join.

Method Detail

getAttachedDataStore1

public SourceDataStore getAttachedDataStore1()

Returns the source data store attached to the left side of this join.

Returns:

The source data store attached to the left side of this join.

See Also:

setAttachedDataStore1(SourceDataStore)

getAttachedDataStore2

public SourceDataStore getAttachedDataStore2()

Returns the source data store attached to the right side of this join.

Returns:

The source data store attached to the right side of this join.

See Also:

setAttachedDataStore2(SourceDataStore)

getSubComponentDescription

public java.lang.String getSubComponentDescription()

Description copied from interface: IInterfaceSubComponent

Returns the sub component's description in a human-readable way.

Returns:

a human-readable String giving all necessary information to identify this component

getSubComponentDescription

public java.lang.String getSubComponentDescription(java.util.Locale pLocale)

Description copied from interface: IInterfaceSubComponent

Returns the sub component's description in a human-readable way for the given Locale.

Parameters:

pLocale - the Locale for which the description should be returned

Returns:

a human-readable String giving all necessary information to identify this component in the given Locale

isCross

public boolean isCross()

Returns whether this join is a cross join or not.

Returns:

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

See Also:

setCross(boolean)

isLookup

public boolean isLookup()

Returns whether this join clause represents a lookup operation or not.

Returns:

true if this join clause represents a lookup operation, false otherwise.

isNatural

public boolean isNatural()

Returns whether this join is a natural join or not.

Returns:

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

See Also:

setNatural(boolean)

isOrdered

public boolean isOrdered()

Returns whether this join clause to an ordered join or not.

Returns:

true if this join is an ordered join, false if this join is a non-ordered join.

See Also:

setOrdered(boolean)

isOuter1

public boolean isOuter1()

Returns whether the source data store on the left side of this join is set to be preserving (outer join) or not.

Returns:

true if the source data store on the left side of this join is set to be preserving in the join.

See Also:

setOuter1(boolean)

isOuter2

public boolean isOuter2()

Returns whether the source data store on the right side of this join is set to be preserving (outer join) or not.

Returns:

true if the source data store on the right side of this join is set to be preserving in the join.

See Also:

setOuter2(boolean)

setAttachedDataStore1

public void setAttachedDataStore1(SourceDataStore pAttachedDataStore)

Internal use only Sets the source data store attached to the left side of this join.

Parameters:

pAttachedDataStore - The source data store attached to the left side of this join.

See Also:

getAttachedDataStore1()

setAttachedDataStore2

public void setAttachedDataStore2(SourceDataStore pAttachedDataStore)

Internal use only Sets the right side of the source data store attached to this join.

Parameters:

pAttachedDataStore - The source data store attached to the right side of this join.

See Also:

getAttachedDataStore2()

setCross

public void setCross(boolean pCross)

Internal use only Sets this join clause to be a cross join.

Parameters:

pCross - true to set this join to a cross join, false otherwise.

See Also:

isCross()

setLookup

public void setLookup(boolean pLookup)

Internal use only Sets whether this join clause represents a lookup operation or not.

Parameters:

pLookup - true if this join clause represents a lookup operation, false otherwise.

setNatural

public void setNatural(boolean pNatural)

Internal use only Sets this join clause to be a natural join.

Parameters:

pNatural - true to set this join to a natural join, false otherwise.

See Also:

isNatural()

setOrdered

public void setOrdered(boolean pOrdered)

Sets whether this join clause to be an ordered join.

Parameters:

pOrdered - true if this join is an ordered join, false otherwise.

See Also:

isOrdered()

setOuter1

public void setOuter1(boolean pOuter1)

Internal use only Sets whether the source data store on the left side of this join is set to be preserving (outer join) or not.

Parameters:

pOuter1 - true if the source data store on the left side of this join is set to be preserving in the join.

See Also:

isOuter1()

setOuter2

public void setOuter2(boolean pOuter2)

Internal use only Sets whether the source data store on the right side of this join is set to be preserving (outer join) or not.

Parameters:

pOuter2 - true if the source data store on the right side of this join is set to be preserving in the join.

See Also:

isOuter2()