All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • javax.persistence.criteria.CriteriaQuery Maven / Gradle / Ivy

    Go to download

    Hibernate developmental JSR 317 (Java Persistence API 2.0) contracts. Used to allow incremental implementation of features on the way to full JPA 2.0 support.

    The newest version!
    // $Id: CriteriaQuery.java 17038 2009-07-08 10:58:24Z epbernard $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.criteria;

import java.util.List;
import java.util.Set;

/**
 * The CriteriaQuery interface defines functionality that is specific
 * to top-level queries.
 */
public interface CriteriaQuery extends AbstractQuery {

    /**
     * Specify the item that is to be returned in the query result.
     * Replaces the previously specified selection(s), if any.
     * @param selection  selection specifying the item that
     *        is to be returned in the query result
     * @return the modified query
     */
    CriteriaQuery select(Selection selection);

    /**
     * Specify the selection items that are to be returned in the
     * query result.
     * Replaces the previously specified selection(s), if any.
     *
     * The type of the result of the query execution depends on
     * the specification of the type of the criteria query object
     * created as well as the arguments to the multiselect method.
     * An argument to the multiselect method must not be a tuple-
     * or array-valued compound selection item.
     * The semantics of this method are as follows:
     *
     * If the type of the criteria query is CriteriaQuery
     * (i.e., a criteria query object created by either the
     * createTupleQuery method or by passing a Tuple class argument
     * to the createQuery method), a Tuple object corresponding to
     * the arguments of the multiselect method will be instantiated
     * and returned for each row that results from the query execution.
     *
     * If the type of the criteria query is CriteriaQuery for
     * some user-defined class X (i.e., a criteria query object
     * created by passing a X class argument to the createQuery
     * method), then the arguments to the multiselect method will be
     * passed to the X constructor and an instance of type X will be
     * returned for each row.
     *
     * If the type of the criteria query is CriteriaQuery for
     * some class X, an instance of type X[] will be returned for
     * each row.   The elements of the array will correspond to the
     * arguments of the multiselect method.
     *
     * If the type of the criteria query is CriteriaQuery
     * or if the criteria query was created without specifying a type,
     * and only a single argument is passed to the multiselect method,
     * an instance of type Object will be returned for each row.
     *
     * If the type of the criteria query is CriteriaQuery
     * or if the criteria query was created without specifying a type,
     * and more than one argument is passed to the multiselect method,
     * an instance of type Object[] will be instantiated and returned
     * for each row.  The elements of the array will correspond to the
     * arguments to the multiselect method.
     *
     * @param selections  selection items corresponding to the
     *        results to be returned by the query
     * @return the modified query
     */
    CriteriaQuery multiselect(Selection... selections);


    /**
     * Specify the selection items that are to be returned in the
     * query result.
     * Replaces the previously specified selection(s), if any.
     *
     * The type of the result of the query execution depends on
     * the specification of the type of the criteria query object
     * created as well as the argument to the multiselect method.
     * An element of the list passed to the multiselect method
     * must not be a tuple- or array-valued compound selection item.
     * The semantics of this method are as follows:
     *
     * If the type of the criteria query is CriteriaQuery
     * (i.e., a criteria query object created by either the
     * createTupleQuery method or by passing a Tuple class argument
     * to the createQuery method), a Tuple object corresponding to
     * the elements of the list passed to the multiselect method
     * will be instantiated and returned for each row that results
     * from the query execution.
     *
     * If the type of the criteria query is CriteriaQuery for
     * some user-defined class X (i.e., a criteria query object
     * created by passing a X class argument to the createQuery
     * method), then the elements of the list passed to the
     * multiselect method will be passed to the X constructor and
     * an instance of type X will be returned for each row.
     *
     * If the type of the criteria query is CriteriaQuery for
     * some class X, an instance of type X[] will be returned for
     * each row.   The elements of the array will correspond to the
     * elements of the list passed to the multiselect method.
     *
     * If the type of the criteria query is CriteriaQuery
     * or if the criteria query was created without specifying a type,
     * and the list passed to the multiselect method contains only
     * a single element, an instance of type Object will be returned
     * for each row.
     *
     * If the type of the criteria query is CriteriaQuery
     * or if the criteria query was created without specifying a type,
     * and the list passed to the multiselect method contains more
     * than one element, an instance of type Object[] will be
     * instantiated and returned for each row.  The elements of the
     * array will correspond to the elements of the list passed to
     * the multiselect method.
     *
     * @param selectionList  list of selection items corresponding
     *        to the results to be returned by the query
     * @return the modified query
     */
    CriteriaQuery multiselect(List> selectionList);


    /**
     * Modify the query to restrict the query result according
     * to the specified boolean expression.
     * Replaces the previously added restriction(s), if any.
     * This method only overrides the return type of the
     * corresponding AbstractQuery method.
     * @param restriction  a simple or compound boolean expression
     * @return the modified query
     */
    CriteriaQuery where(Expression restriction);

    /**
     * Modify the query to restrict the query result according
     * to the conjunction of the specified restriction predicates.
     * Replaces the previously added restriction(s), if any.
     * If no restrictions are specified, any previously added
     * restrictions are simply removed.
     * This method only overrides the return type of the
     * corresponding AbstractQuery method.
     * @param restrictions  zero or more restriction predicates
     * @return the modified query
     */
    CriteriaQuery where(Predicate... restrictions);

    /**
     * Specify the expressions that are used to form groups over
     * the query results.
     * Replaces the previous specified grouping expressions, if any.
     * If no grouping expressions are specified, any previously
     * added grouping expressions are simply removed.
     * This method only overrides the return type of the
     * corresponding AbstractQuery method.
     * @param grouping  zero or more grouping expressions
     * @return the modified query
     */
    CriteriaQuery groupBy(Expression... grouping);

    /**
     * Specify a restriction over the groups of the query.
     * Replaces the previous having restriction(s), if any.
     * This method only overrides the return type of the
     * corresponding AbstractQuery method.
     * @param restriction  a simple or compound boolean expression
     * @return the modified query
     */
    CriteriaQuery having(Expression restriction);

    /**
     * Specify restrictions over the groups of the query
     * according the conjunction of the specified restriction
     * predicates.
     * Replaces the previously added restriction(s), if any.
     * If no restrictions are specified, any previously added
     * restrictions are simply removed.
     * This method only overrides the return type of the
     * corresponding AbstractQuery method.
     * @param restrictions  zero or more restriction predicates
     * @return the modified query
     */
    CriteriaQuery having(Predicate... restrictions);

    /**
     * Specify the ordering expressions that are used to
     * order the query results.
     * Replaces the previous ordering expressions, if any.
     * If no ordering expressions are specified, the previous
     * ordering, if any, is simply removed, and results will
     * be returned in no particular order.
     * The left-to-right sequence of the ordering expressions
     * determines the precedence, whereby the leftmost has highest
     * precedence.
     * @param o  zero or more ordering expressions
     * @return the modified query.
     */
    CriteriaQuery orderBy(Order... o);

    /**
     * Specify whether duplicate query results will be eliminated.
     * A true value will cause duplicates to be eliminated.
     * A false value will cause duplicates to be retained.
     * If distinct has not been specified, duplicate results must
     * be retained.
     * This method only overrides the return type of the
     * corresponding AbstractQuery method.
     * @param distinct  boolean value specifying whether duplicate
     *        results must be eliminated from the query result or
     *        whether they must be retained
     * @return the modified query.
     */
    CriteriaQuery distinct(boolean distinct);

    /**
     * Return the result type of the query.
     * If a result type was specified as an argument to the
     * createQuery method, that type will be returned.
     * If the query was created using the createTupleQuery
     * method, the result type is Tuple.
     * Otherwise, the result type is Object.
     * @return result type
     */
    Class getResultType();

    /**
     * Return the ordering expressions in order of precedence.
     * @return the list of ordering expressions
     */
    List getOrderList();

    /**
     * Return the parameters of the query
     * @return the query parameters
     */
    Set> getParameters();
}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy