org.ibatis.persist.criteria.Expression 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;

import java.util.Collection;

/**
 * Type for query expressions.
 *
 * @param 
 *            the type of the expression
 *
 * @since iBatis Persistence 1.0
 */
public interface Expression extends Selection {

    /**
     * Create a predicate to test whether the expression is null.
     * 
     * @return predicate testing whether the expression is null
     */
    Predicate isNull();

    /**
     * Create a predicate to test whether the expression is not null.
     * 
     * @return predicate testing whether the expression is not null
     */
    Predicate isNotNull();

    /**
     * Create a predicate to test whether the expression is a member of the argument list.
     * 
     * @param values
     *            values to be tested against
     * @return predicate testing for membership
     */
    Predicate in(Object... values);

    /**
     * Create a predicate to test whether the expression is a member of the argument list.
     * 
     * @param values
     *            expressions to be tested against
     * @return predicate testing for membership
     */
    Predicate in(Expression... values);

    /**
     * Create a predicate to test whether the expression is a member of the collection.
     * 
     * @param values
     *            collection of values to be tested against
     * @return predicate testing for membership
     */
    Predicate in(Collection values);

    /**
     * Create a predicate to test whether the expression is a member of the collection.
     * 
     * @param values
     *            expression corresponding to collection to be tested against
     * @return predicate testing for membership
     */
    Predicate in(Expression> values);

    /**
     * Perform a typecast upon the expression, returning a new expression object. This method does not cause type
     * conversion: the runtime type is not changed. Warning: may result in a runtime failure.
     * 
     * @param type
     *            intended type of the expression
     * @return new expression of the given type
     */
     Expression as(Class type);
}