org.teiid.query.sql.lang

Class JoinPredicate

java.lang.Object

org.teiid.query.sql.lang.FromClause

org.teiid.query.sql.lang.JoinPredicate

All Implemented Interfaces:

Cloneable, LanguageObject

public class JoinPredicate
extends FromClause

Represents a subpart of the FROM clause specifying a join within the FROM. It may optionally specify criteria for the join, depending on the join type. For example, these are some representations of JoinPredicates:

1. GroupA CROSS JOIN GroupB
2. GroupA JOIN GroupB ON GroupA.E1=GroupB.E1 AND GroupA.E2=GroupB.E2
3. GroupA RIGHT OUTER JOIN (GroupB JOIN GroupC ON GroupB.E1=GroupC.E1) ON GroupA.E1=GroupB.E1

Nested Class Summary

Nested classes/interfaces inherited from interface org.teiid.query.sql.LanguageObject

LanguageObject.Util

Field Summary

Fields inherited from class org.teiid.query.sql.lang.FromClause

PRESERVE

Constructor Summary

Constructors

Constructor and Description
JoinPredicate() Construct a JoinPredicate
JoinPredicate(FromClause leftClause, FromClause rightClause, JoinType type) Construct a JoinPredicate between two clauses of the specified type.
JoinPredicate(FromClause leftClause, FromClause rightClause, JoinType type, Criteria criteria) Construct a JoinPredicate between two clauses of the specified type.
JoinPredicate(FromClause leftClause, FromClause rightClause, JoinType type, List criteria) Construct a JoinPredicate between two clauses of the specified type.

Method Summary

Modifier and Type	Method and Description
void	acceptVisitor(LanguageVisitor visitor) Method for accepting a visitor.
protected FromClause	cloneDirect() Return deep clone for object
void	collectGroups(Collection<GroupSymbol> groups) Collect all GroupSymbols for this from clause.
boolean	equals(Object obj) Compare this object to another
List	getJoinCriteria() Get join criteria for this predicate
JoinType	getJoinType() Get join type for this predicate
FromClause	getLeftClause() Get left clause
FromClause	getRightClause() Get right clause
int	hashCode() Get hash code for object
void	setJoinCriteria(List criteria) Set join criteria for this predicate
void	setJoinType(JoinType type) Set join type for this predicate
void	setLeftClause(FromClause predicate) Set left clause
void	setRightClause(FromClause predicate) Set right clause

Methods inherited from class org.teiid.query.sql.lang.FromClause

clone, getMakeDep, getMakeInd, hasHint, isMakeDep, isMakeNotDep, isNoUnnest, isOptional, isPreserve, setMakeDep, setMakeDep, setMakeInd, setMakeNotDep, setNoUnnest, setOptional, setPreserve, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JoinPredicate

public JoinPredicate()

Construct a JoinPredicate

JoinPredicate

public JoinPredicate(FromClause leftClause,
                     FromClause rightClause,
                     JoinType type)

Construct a JoinPredicate between two clauses of the specified type.

Parameters:

leftClause - Left from clause

rightClause - Right from clause

type - Type of join

JoinPredicate

public JoinPredicate(FromClause leftClause,
                     FromClause rightClause,
                     JoinType type,
                     List criteria)

Construct a JoinPredicate between two clauses of the specified type.

Parameters:

leftClause - Left from clause

rightClause - Right from clause

type - Type of join

criteria - List of Criteria for this join predicate

JoinPredicate

public JoinPredicate(FromClause leftClause,
                     FromClause rightClause,
                     JoinType type,
                     Criteria criteria)

Construct a JoinPredicate between two clauses of the specified type.

Parameters:

leftClause - Left from clause

rightClause - Right from clause

type - Type of join

criteria - List of Criteria for this join predicate

Method Detail

setLeftClause

public void setLeftClause(FromClause predicate)

Set left clause

Parameters:

predicate - Left clause to set

getLeftClause

public FromClause getLeftClause()

Get left clause

Returns:

Left clause

setRightClause

public void setRightClause(FromClause predicate)

Set right clause

Parameters:

predicate - Right clause to set

getRightClause

public FromClause getRightClause()

Get right clause

Returns:

Right clause

setJoinType

public void setJoinType(JoinType type)

Set join type for this predicate

Parameters:

type - Type of join

getJoinType

public JoinType getJoinType()

Get join type for this predicate

Returns:

Type of join

setJoinCriteria

public void setJoinCriteria(List criteria)

Set join criteria for this predicate

Parameters:

criteria - List of Criteria set on this predicate

getJoinCriteria

public List getJoinCriteria()

Get join criteria for this predicate

Returns:

List of Criteria

collectGroups

public void collectGroups(Collection<GroupSymbol> groups)

Collect all GroupSymbols for this from clause.

Specified by:

collectGroups in class FromClause

Parameters:

groups - Groups to add to

acceptVisitor

public void acceptVisitor(LanguageVisitor visitor)

Description copied from interface: LanguageObject

Method for accepting a visitor. It is the responsibility of the language object to call back on the visitor.

Specified by:

acceptVisitor in interface LanguageObject

Specified by:

acceptVisitor in class FromClause

Parameters:

visitor - Visitor being used

equals

public boolean equals(Object obj)

Compare this object to another

Overrides:

equals in class FromClause

Parameters:

obj - Other object

Returns:

True if equal

hashCode

public int hashCode()

Get hash code for object

Overrides:

hashCode in class Object

Returns:

Hash code

cloneDirect

protected FromClause cloneDirect()

Return deep clone for object

Specified by:

cloneDirect in class FromClause

Returns:

Deep clone