|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.torque.criteria.Join
public class Join
Data object to describe a join between two tables, for example
table_a LEFT JOIN table_b ON table_a.id = table_b.a_id
Constructor Summary | |
---|---|
Join(Column leftColumn,
Column rightColumn,
SqlEnum comparison,
JoinType joinType)
Constructor with the comparison operator. |
|
Join(PreparedStatementPart leftTable,
PreparedStatementPart rightTable,
Criterion joinCondition,
JoinType joinType)
Constructor. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
This method checks another Criteria.Join to see if they contain the same attributes. |
Criterion |
getJoinCondition()
|
JoinType |
getJoinType()
|
PreparedStatementPart |
getLeftTable()
|
PreparedStatementPart |
getRightTable()
|
int |
hashCode()
Returns the hash code value for this Join. |
String |
toString()
Returns a String representation of the class, mainly for debugging purposes. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Join(Column leftColumn, Column rightColumn, SqlEnum comparison, JoinType joinType)
leftColumn
- the left column of the join condition;
might contain an alias name, not null.rightColumn
- the right column of the join condition
might contain an alias name, not null.comparison
- the comparison, not null.
The operator CUSTOM is not supported.joinType
- the type of the join, or null
(adding the join condition to the where clause).
NullPointerException
- if leftColumn, comparison or rightColumn
are null.
IllegalArgumentException
- if comparison id SqlEnum.CUSTOMpublic Join(PreparedStatementPart leftTable, PreparedStatementPart rightTable, Criterion joinCondition, JoinType joinType)
leftTable
- the left table of the join, might contain an alias name,
or null to be determined from the join clause.rightTable
- the right table of the join, might contain an alias
name, or null to be determined from the join clause.joinCondition
- the join condition, not null.joinType
- the type of the join, or null
(adding the join condition to the where clause).Method Detail |
---|
public final Criterion getJoinCondition()
public final JoinType getJoinType()
public final PreparedStatementPart getLeftTable()
public final PreparedStatementPart getRightTable()
public String toString()
toString
in class Object
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |