org.ibatis.persist.criteria.Join Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jbatis Show documentation

The jBATIS persistence framework will help you to significantly reduce the amount of Java code that you normally need to access a relational database. iBATIS simply maps JavaBeans to SQL statements using a very simple XML descriptor.

The newest version!

package org.ibatis.persist.criteria;

/**
 * A join to an entity or basic type.
 *
 * @param 
 *            the source type of the join
 * @param 
 *            the target type of the join
 *
 * @since iBatis Persistence 1.0
 */
public interface Join extends From {

    /**
     * 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.
     * 
     * @param restriction
     *            a simple or compound boolean expression
     * @return the modified join object
     */
    Join on(Expression 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.
     * 
     * @param restrictions
     *            zero or more restriction predicates
     * @return the modified join object
     */
    Join on(Predicate... restrictions);

    /**
     * Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been
     * specified.
     * 
     * @return the ON restriction predicate
     */
    Predicate getOn();

    /**
     * Return the join type.
     * 
     * @return join type
     */
    JoinType getJoinType();
}