org.ibatis.persist.criteria

Interface Join

Type Parameters:

Z - the source type of the join

X - the target type of the join

All Superinterfaces:

From

public interface Join
extends From

A join to an entity or basic type.

Since:

iBatis Persistence 1.0

Method Summary

Modifier and Type	Method and Description
JoinType	getJoinType() Return the join type.
Predicate	getOn() Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been specified.
Join	on(Expression<Boolean> restriction) Modify the join to restrict the result according to the specified ON condition and return the join object.
Join	on(Predicate... restrictions) Modify the join to restrict the result according to the specified ON condition and return the join object.

Methods inherited from interface org.ibatis.persist.criteria.From

join, join

Method Detail

on

Join on(Expression<Boolean> restriction)

Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified join object

on

Join on(Predicate... restrictions)

Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified join object

getOn

Predicate getOn()

Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been specified.

Returns:

the ON restriction predicate

getJoinType

JoinType getJoinType()

Return the join type.

Returns:

join type