org.apache.openjpa.jdbc.sql
Interface Joins


public interface Joins

Tracks joins made when traversing relations in a select.

Author:
Abe White

Method Summary
 Joins crossJoin(Table localTable, Table foreignTable)
          Perform a cross join on the given tables.
 boolean isEmpty()
          Whether we have any joins.
 boolean isOuter()
          Whether this joins path results in outer joins.
 Joins join(ForeignKey fk, boolean inverse, boolean toMany)
          Join the columns of the given foreign key.
 Joins joinRelation(String name, ForeignKey fk, ClassMapping target, int subclasses, boolean inverse, boolean toMany)
          Join the columns of the given foreign key, which represents a relation via the given field name.
 Joins outerJoin(ForeignKey fk, boolean inverse, boolean toMany)
          Join the columns of the given foreign key.
 Joins outerJoinRelation(String name, ForeignKey fk, ClassMapping target, int subclasses, boolean inverse, boolean toMany)
          Join the columns of the given foreign key, which represents a relation via the given field name.
 Joins setSubselect(String alias)
          Set the subquery alias.
 Joins setVariable(String var)
          Set the variable name being traversed into with the next join.
 

Method Detail

isEmpty

boolean isEmpty()
Whether we have any joins.


isOuter

boolean isOuter()
Whether this joins path results in outer joins.


crossJoin

Joins crossJoin(Table localTable,
                Table foreignTable)
Perform a cross join on the given tables.


join

Joins join(ForeignKey fk,
           boolean inverse,
           boolean toMany)
Join the columns of the given foreign key.


outerJoin

Joins outerJoin(ForeignKey fk,
                boolean inverse,
                boolean toMany)
Join the columns of the given foreign key.


joinRelation

Joins joinRelation(String name,
                   ForeignKey fk,
                   ClassMapping target,
                   int subclasses,
                   boolean inverse,
                   boolean toMany)
Join the columns of the given foreign key, which represents a relation via the given field name.


outerJoinRelation

Joins outerJoinRelation(String name,
                        ForeignKey fk,
                        ClassMapping target,
                        int subclasses,
                        boolean inverse,
                        boolean toMany)
Join the columns of the given foreign key, which represents a relation via the given field name.


setVariable

Joins setVariable(String var)
Set the variable name being traversed into with the next join.


setSubselect

Joins setSubselect(String alias)
Set the subquery alias.



Copyright © 2006-2007 Apache Software Foundation. All Rights Reserved.