org.apache.openjpa.jdbc.sql
Class Join

java.lang.Object
  extended by org.apache.openjpa.jdbc.sql.Join
All Implemented Interfaces:
java.lang.Cloneable, JoinSyntaxes

public class Join
extends java.lang.Object
implements java.lang.Cloneable, JoinSyntaxes

Represents a SQL join.

Author:
Abe White

Field Summary
static int TYPE_CROSS
           
static int TYPE_INNER
           
static int TYPE_OUTER
           
 
Fields inherited from interface org.apache.openjpa.jdbc.sql.JoinSyntaxes
SYNTAX_DATABASE, SYNTAX_SQL92, SYNTAX_TRADITIONAL
 
Method Summary
 java.lang.Object clone()
           
 boolean equals(java.lang.Object other)
           
 java.lang.String getAlias1()
           
 java.lang.String getAlias2()
           
 ForeignKey getForeignKey()
           
 Joins getRelationJoins()
          If joining a relation, the joins leading to the relation.
 ClassMapping getRelationTarget()
          If joining a relation, the target type.
 int getSubclasses()
          If joining a relation, how to deal with subclasses.
 Table getTable1()
           
 Table getTable2()
           
 int getType()
           
 int hashCode()
           
 boolean isForeignKeyInversed()
           
 Join reverse()
          Return a join that is this join in reverse.
 void setRelation(ClassMapping target, int subs, Joins joins)
          When joining a relation, set target type and how to deal with subclasses.
 void setType(int type)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_INNER

public static final int TYPE_INNER
See Also:
Constant Field Values

TYPE_OUTER

public static final int TYPE_OUTER
See Also:
Constant Field Values

TYPE_CROSS

public static final int TYPE_CROSS
See Also:
Constant Field Values
Method Detail

getType

public int getType()

setType

public void setType(int type)

getAlias1

public java.lang.String getAlias1()

getAlias2

public java.lang.String getAlias2()

getTable1

public Table getTable1()

getTable2

public Table getTable2()

getForeignKey

public ForeignKey getForeignKey()

isForeignKeyInversed

public boolean isForeignKeyInversed()

getRelationTarget

public ClassMapping getRelationTarget()
If joining a relation, the target type.


getSubclasses

public int getSubclasses()
If joining a relation, how to deal with subclasses. See subclass constants in Select.


getRelationJoins

public Joins getRelationJoins()
If joining a relation, the joins leading to the relation.


setRelation

public void setRelation(ClassMapping target,
                        int subs,
                        Joins joins)
When joining a relation, set target type and how to deal with subclasses. See subclass constants in #Select.


reverse

public Join reverse()
Return a join that is this join in reverse.


hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object