JavaEE Web API 8.0.1 · javax.persistence.criteria.CriteriaBuilder

Modifier and Type	Class and Description
public static interface	CriteriaBuilder.Case<R> Interface used to build general case expressions.
public static interface	CriteriaBuilder.Coalesce<T> Interface used to build coalesce expressions.
public static interface	CriteriaBuilder.In<T> Interface used to build in predicates.
public static interface	CriteriaBuilder.SimpleCase<C, R> Interface used to build simple case expressions.
public static enum	CriteriaBuilder.Trimspec Used to specify how strings are trimmed.

Method Summary

Modifier and Type	Method and Description
public <N extends Number> Expression<N>	Returns: absolute value abs(Expression<N> expression x) Create an expression that returns the absolute value of its argument.
public <Y> Expression<Y>	Returns: all expression all(Subquery<Y> subquery subquery) Create an all expression over the subquery results.
public Predicate	Returns: and predicate and(Expression<Boolean> boolean expression x, Expression<Boolean> boolean expression y) Create a conjunction of the given boolean expressions.
public Predicate	Returns: and predicate and(Predicate... zero or more restriction predicates restrictions) Create a conjunction of the given restriction predicates.
public <Y> Expression<Y>	Returns: any expression any(Subquery<Y> subquery subquery) Create an any expression over the subquery results.
public CompoundSelection<Object[]>	Returns: array-valued compound selection array(Selection<?>... selection items selections) Create an array-valued selection item.
public Order	Returns: ascending ordering corresponding to the expression asc(Expression<?> expression used to define the ordering x) Create an ordering by the ascending value of the expression.
public <N extends Number> Expression<Double>	Returns: avg expression avg(Expression<N> expression representing input value to avg operation x) Create an aggregate expression applying the avg operation.
public <Y extends Comparable<? super Y>> Predicate	Returns: between predicate between(Expression<? extends Y> expression v, Expression<? extends Y> expression x, Expression<? extends Y> expression y) Create a predicate for testing whether the first argument is between the second and third arguments in value.
public <Y extends Comparable<? super Y>> Predicate	Returns: between predicate between(Expression<? extends Y> expression v, Y value x, Y value y) Create a predicate for testing whether the first argument is between the second and third arguments in value.
public <Y> Expression<Y>	Returns: coalesce expression coalesce(Expression<? extends Y> expression x, Expression<? extends Y> expression y) Create an expression that returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.
public <Y> Expression<Y>	Returns: coalesce expression coalesce(Expression<? extends Y> expression x, Y value y) Create an expression that returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.
public <T> CriteriaBuilder.Coalesce<T>	Returns: coalesce expression coalesce() Create a coalesce expression.
public Expression<String>	Returns: expression corresponding to concatenation concat(Expression<String> string expression x, Expression<String> string expression y) Create an expression for string concatenation.
public Expression<String>	Returns: expression corresponding to concatenation concat(Expression<String> string expression x, String string y) Create an expression for string concatenation.
public Expression<String>	Returns: expression corresponding to concatenation concat(String string x, Expression<String> string expression y) Create an expression for string concatenation.
public Predicate	Returns: and predicate conjunction() Create a conjunction (with zero conjuncts).
public <Y> CompoundSelection<Y>	Returns: compound selection item construct(Class<Y> class whose instance is to be constructed resultClass, Selection<?>... arguments to the constructor selections) Create a selection item corresponding to a constructor.
public Expression<Long>	Returns: count expression count(Expression<?> expression representing input value to count operation x) Create an aggregate expression applying the count operation.
public Expression<Long>	Returns: count distinct expression countDistinct(Expression<?> expression representing input value to count distinct operation x) Create an aggregate expression applying the count distinct operation.
public <T> CriteriaDelete<T>	Returns: the query object createCriteriaDelete(Class<T> target type for delete operation targetEntity) Create a `CriteriaDelete` query object to perform a bulk delete operation.
public <T> CriteriaUpdate<T>	Returns: the query object createCriteriaUpdate(Class<T> target type for update operation targetEntity) Create a `CriteriaUpdate` query object to perform a bulk update operation.
public CriteriaQuery<Object>	Returns: criteria query object createQuery() Create a `CriteriaQuery` object.
public <T> CriteriaQuery<T>	Returns: criteria query object createQuery(Class<T> type of the query result resultClass) Create a `CriteriaQuery` object with the specified result type.
public CriteriaQuery<Tuple>	Returns: criteria query object createTupleQuery() Create a `CriteriaQuery` object that returns a tuple of objects as its result.
public Expression<Date>	Returns: expression for current date currentDate() Create expression to return current date.
public Expression<Time>	Returns: expression for current time currentTime() Create expression to return current time.
public Expression<Timestamp>	Returns: expression for current timestamp currentTimestamp() Create expression to return current timestamp.
public Order	Returns: descending ordering corresponding to the expression desc(Expression<?> expression used to define the ordering x) Create an ordering by the descending value of the expression.
public <N extends Number> Expression<N>	Returns: difference diff(Expression<? extends N> expression x, Expression<? extends N> expression y) Create an expression that returns the difference between its arguments.
public <N extends Number> Expression<N>	Returns: difference diff(Expression<? extends N> expression x, N value y) Create an expression that returns the difference between its arguments.
public <N extends Number> Expression<N>	Returns: difference diff(N value x, Expression<? extends N> expression y) Create an expression that returns the difference between its arguments.
public Predicate	Returns: or predicate disjunction() Create a disjunction (with zero disjuncts).
public Predicate	Returns: equality predicate equal(Expression<?> expression x, Expression<?> expression y) Create a predicate for testing the arguments for equality.
public Predicate	Returns: equality predicate equal(Expression<?> expression x, Object object y) Create a predicate for testing the arguments for equality.
public Predicate	Returns: exists predicate exists(Subquery<?> subquery whose result is to be tested subquery) Create a predicate testing the existence of a subquery result.
public <T> Expression<T>	Returns: expression function(String function name name, Class<T> expected result type type, Expression<?>... function arguments args) Create an expression for the execution of a database function.
public Predicate	Returns: greater-than-or-equal predicate ge(Expression<? extends Number> expression x, Expression<? extends Number> expression y) Create a predicate for testing whether the first argument is greater than or equal to the second.
public Predicate	Returns: greater-than-or-equal predicate ge(Expression<? extends Number> expression x, Number value y) Create a predicate for testing whether the first argument is greater than or equal to the second.
public <Y extends Comparable<? super Y>> Predicate	Returns: greater-than predicate greaterThan(Expression<? extends Y> expression x, Expression<? extends Y> expression y) Create a predicate for testing whether the first argument is greater than the second.
public <Y extends Comparable<? super Y>> Predicate	Returns: greater-than predicate greaterThan(Expression<? extends Y> expression x, Y value y) Create a predicate for testing whether the first argument is greater than the second.
public <Y extends Comparable<? super Y>> Predicate	Returns: greater-than-or-equal predicate greaterThanOrEqualTo(Expression<? extends Y> expression x, Expression<? extends Y> expression y) Create a predicate for testing whether the first argument is greater than or equal to the second.
public <Y extends Comparable<? super Y>> Predicate	Returns: greater-than-or-equal predicate greaterThanOrEqualTo(Expression<? extends Y> expression x, Y value y) Create a predicate for testing whether the first argument is greater than or equal to the second.
public <X extends Comparable<? super X>> Expression<X>	Returns: greatest expression greatest(Expression<X> expression representing input value to greatest operation x) Create an aggregate expression for finding the greatest of the values (strings, dates, etc).
public Predicate	Returns: greater-than predicate gt(Expression<? extends Number> expression x, Expression<? extends Number> expression y) Create a predicate for testing whether the first argument is greater than the second.
public Predicate	Returns: greater-than predicate gt(Expression<? extends Number> expression x, Number value y) Create a predicate for testing whether the first argument is greater than the second.
public <T> CriteriaBuilder.In<T>	Returns: in predicate in(Expression<? extends T> to be tested against list of values expression) Create predicate to test whether given expression is contained in a list of values.
public <C extends Collection<?>> Predicate	Returns: is-empty predicate isEmpty(Expression<C> expression collection) Create a predicate that tests whether a collection is empty.
public Predicate	Returns: predicate isFalse(Expression<Boolean> expression to be tested x) Create a predicate testing for a false value.
public <E, C extends Collection<E>> Predicate	Returns: is-member predicate isMember(Expression<E> element expression elem, Expression<C> expression collection) Create a predicate that tests whether an element is a member of a collection.
public <E, C extends Collection<E>> Predicate	Returns: is-member predicate isMember(E element elem, Expression<C> expression collection) Create a predicate that tests whether an element is a member of a collection.
public <C extends Collection<?>> Predicate	Returns: is-not-empty predicate isNotEmpty(Expression<C> expression collection) Create a predicate that tests whether a collection is not empty.
public <E, C extends Collection<E>> Predicate	Returns: is-not-member predicate isNotMember(Expression<E> element expression elem, Expression<C> expression collection) Create a predicate that tests whether an element is not a member of a collection.
public <E, C extends Collection<E>> Predicate	Returns: is-not-member predicate isNotMember(E element elem, Expression<C> expression collection) Create a predicate that tests whether an element is not a member of a collection.
public Predicate	Returns: is-not-null predicate isNotNull(Expression<?> expression x) Create a predicate to test whether the expression is not null.
public Predicate	Returns: is-null predicate isNull(Expression<?> expression x) Create a predicate to test whether the expression is null.
public Predicate	Returns: predicate isTrue(Expression<Boolean> expression to be tested x) Create a predicate testing for a true value.
public <K, M extends Map<K, ?>> Expression<Set<K>>	Returns: set expression keys(M map map) Create an expression that returns the keys of a map.
public Predicate	Returns: less-than-or-equal predicate le(Expression<? extends Number> expression x, Expression<? extends Number> expression y) Create a predicate for testing whether the first argument is less than or equal to the second.
public Predicate	Returns: less-than-or-equal predicate le(Expression<? extends Number> expression x, Number value y) Create a predicate for testing whether the first argument is less than or equal to the second.
public <X extends Comparable<? super X>> Expression<X>	Returns: least expression least(Expression<X> expression representing input value to least operation x) Create an aggregate expression for finding the least of the values (strings, dates, etc).
public Expression<Integer>	Returns: length expression length(Expression<String> string expression x) Create expression to return length of a string.
public <Y extends Comparable<? super Y>> Predicate	Returns: less-than predicate lessThan(Expression<? extends Y> expression x, Expression<? extends Y> expression y) Create a predicate for testing whether the first argument is less than the second.
public <Y extends Comparable<? super Y>> Predicate	Returns: less-than predicate lessThan(Expression<? extends Y> expression x, Y value y) Create a predicate for testing whether the first argument is less than the second.
public <Y extends Comparable<? super Y>> Predicate	Returns: less-than-or-equal predicate lessThanOrEqualTo(Expression<? extends Y> expression x, Expression<? extends Y> expression y) Create a predicate for testing whether the first argument is less than or equal to the second.
public <Y extends Comparable<? super Y>> Predicate	Returns: less-than-or-equal predicate lessThanOrEqualTo(Expression<? extends Y> expression x, Y value y) Create a predicate for testing whether the first argument is less than or equal to the second.
public Predicate	Returns: like predicate like(Expression<String> string expression x, Expression<String> string expression pattern) Create a predicate for testing whether the expression satisfies the given pattern.
public Predicate	Returns: like predicate like(Expression<String> string expression x, String string pattern) Create a predicate for testing whether the expression satisfies the given pattern.
public Predicate	Returns: like predicate like(Expression<String> string expression x, Expression<String> string expression pattern, Expression<Character> escape character expression escapeChar) Create a predicate for testing whether the expression satisfies the given pattern.
public Predicate	Returns: like predicate like(Expression<String> string expression x, Expression<String> string expression pattern, char escape character escapeChar) Create a predicate for testing whether the expression satisfies the given pattern.
public Predicate	Returns: like predicate like(Expression<String> string expression x, String string pattern, Expression<Character> escape character expression escapeChar) Create a predicate for testing whether the expression satisfies the given pattern.
public Predicate	Returns: like predicate like(Expression<String> string expression x, String string pattern, char escape character escapeChar) Create a predicate for testing whether the expression satisfies the given pattern.
public <T> Expression<T>	Returns: expression literal literal(T value represented by the expression value) Create an expression for a literal.
public Expression<Integer>	Returns: expression corresponding to position locate(Expression<String> expression for string to be searched x, Expression<String> expression for string to be located pattern) Create expression to locate the position of one string within another, returning position of first character if found.
public Expression<Integer>	Returns: expression corresponding to position locate(Expression<String> expression for string to be searched x, String string to be located pattern) Create expression to locate the position of one string within another, returning position of first character if found.
public Expression<Integer>	Returns: expression corresponding to position locate(Expression<String> expression for string to be searched x, Expression<String> expression for string to be located pattern, Expression<Integer> expression for position at which to start search from) Create expression to locate the position of one string within another, returning position of first character if found.
public Expression<Integer>	Returns: expression corresponding to position locate(Expression<String> expression for string to be searched x, String string to be located pattern, int position at which to start search from) Create expression to locate the position of one string within another, returning position of first character if found.
public Expression<String>	Returns: expression to convert to lowercase lower(Expression<String> string expression x) Create expression for converting a string to lowercase.
public Predicate	Returns: less-than predicate lt(Expression<? extends Number> expression x, Expression<? extends Number> expression y) Create a predicate for testing whether the first argument is less than the second.
public Predicate	Returns: less-than predicate lt(Expression<? extends Number> expression x, Number value y) Create a predicate for testing whether the first argument is less than the second.
public <N extends Number> Expression<N>	Returns: max expression max(Expression<N> expression representing input value to max operation x) Create an aggregate expression applying the numerical max operation.
public <N extends Number> Expression<N>	Returns: min expression min(Expression<N> expression representing input value to min operation x) Create an aggregate expression applying the numerical min operation.
public Expression<Integer>	Returns: modulus mod(Expression<Integer> expression x, Expression<Integer> expression y) Create an expression that returns the modulus of its arguments.
public Expression<Integer>	Returns: modulus mod(Expression<Integer> expression x, Integer value y) Create an expression that returns the modulus of its arguments.
public Expression<Integer>	Returns: modulus mod(Integer value x, Expression<Integer> expression y) Create an expression that returns the modulus of its arguments.
public <N extends Number> Expression<N>	Returns: arithmetic negation neg(Expression<N> expression x) Create an expression that returns the arithmetic negation of its argument.
public Predicate	Returns: not predicate not(Expression<Boolean> restriction expression restriction) Create a negation of the given restriction.
public Predicate	Returns: inequality predicate notEqual(Expression<?> expression x, Expression<?> expression y) Create a predicate for testing the arguments for inequality.
public Predicate	Returns: inequality predicate notEqual(Expression<?> expression x, Object object y) Create a predicate for testing the arguments for inequality.
public Predicate	Returns: not-like predicate notLike(Expression<String> string expression x, Expression<String> string expression pattern) Create a predicate for testing whether the expression does not satisfy the given pattern.
public Predicate	Returns: not-like predicate notLike(Expression<String> string expression x, String string pattern) Create a predicate for testing whether the expression does not satisfy the given pattern.
public Predicate	Returns: not-like predicate notLike(Expression<String> string expression x, Expression<String> string expression pattern, Expression<Character> escape character expression escapeChar) Create a predicate for testing whether the expression does not satisfy the given pattern.
public Predicate	Returns: not-like predicate notLike(Expression<String> string expression x, Expression<String> string expression pattern, char escape character escapeChar) Create a predicate for testing whether the expression does not satisfy the given pattern.
public Predicate	Returns: not-like predicate notLike(Expression<String> string expression x, String string pattern, Expression<Character> escape character expression escapeChar) Create a predicate for testing whether the expression does not satisfy the given pattern.
public Predicate	Returns: not-like predicate notLike(Expression<String> string expression x, String string pattern, char escape character escapeChar) Create a predicate for testing whether the expression does not satisfy the given pattern.
public <Y> Expression<Y>	Returns: nullif expression nullif(Expression<Y> expression x, Expression<?> expression y) Create an expression that tests whether its argument are equal, returning null if they are and the value of the first expression if they are not.
public <Y> Expression<Y>	Returns: nullif expression nullif(Expression<Y> expression x, Y value y) Create an expression that tests whether its argument are equal, returning null if they are and the value of the first expression if they are not.
public <T> Expression<T>	Returns: null expression literal nullLiteral(Class<T> type of the null literal resultClass) Create an expression for a null literal with the given type.
public Predicate	Returns: or predicate or(Expression<Boolean> boolean expression x, Expression<Boolean> boolean expression y) Create a disjunction of the given boolean expressions.
public Predicate	Returns: or predicate or(Predicate... zero or more restriction predicates restrictions) Create a disjunction of the given restriction predicates.
public <T> ParameterExpression<T>	Returns: parameter expression parameter(Class<T> parameter class paramClass) Create a parameter expression.
public <T> ParameterExpression<T>	Returns: parameter expression parameter(Class<T> parameter class paramClass, String name that can be used to refer to the parameter name) Create a parameter expression with the given name.
public <N extends Number> Expression<N>	Returns: product prod(Expression<? extends N> expression x, Expression<? extends N> expression y) Create an expression that returns the product of its arguments.
public <N extends Number> Expression<N>	Returns: product prod(Expression<? extends N> expression x, N value y) Create an expression that returns the product of its arguments.
public <N extends Number> Expression<N>	Returns: product prod(N value x, Expression<? extends N> expression y) Create an expression that returns the product of its arguments.
public Expression<Number>	Returns: quotient quot(Expression<? extends Number> expression x, Expression<? extends Number> expression y) Create an expression that returns the quotient of its arguments.
public Expression<Number>	Returns: quotient quot(Expression<? extends Number> expression x, Number value y) Create an expression that returns the quotient of its arguments.
public Expression<Number>	Returns: quotient quot(Number value x, Expression<? extends Number> expression y) Create an expression that returns the quotient of its arguments.
public <C, R> CriteriaBuilder.SimpleCase<C, R>	Returns: simple case expression selectCase(Expression<? extends C> to be tested against the case conditions expression) Create a simple case expression.
public <R> CriteriaBuilder.Case<R>	Returns: general case expression selectCase() Create a general case expression.
public <C extends Collection<?>> Expression<Integer>	Returns: size expression size(Expression<C> expression collection) Create an expression that tests the size of a collection.
public <C extends Collection<?>> Expression<Integer>	Returns: size expression size(C collection collection) Create an expression that tests the size of a collection.
public <Y> Expression<Y>	Returns: some expression some(Subquery<Y> subquery subquery) Create a some expression over the subquery results.
public Expression<Double>	Returns: square root sqrt(Expression<? extends Number> expression x) Create an expression that returns the square root of its argument.
public Expression<String>	Returns: expression corresponding to substring extraction substring(Expression<String> string expression x, Expression<Integer> start position expression from) Create an expression for substring extraction.
public Expression<String>	Returns: expression corresponding to substring extraction substring(Expression<String> string expression x, int start position from) Create an expression for substring extraction.
public Expression<String>	Returns: expression corresponding to substring extraction substring(Expression<String> string expression x, Expression<Integer> start position expression from, Expression<Integer> length expression len) Create an expression for substring extraction.
public Expression<String>	Returns: expression corresponding to substring extraction substring(Expression<String> string expression x, int start position from, int length len) Create an expression for substring extraction.
public <N extends Number> Expression<N>	Returns: sum expression sum(Expression<N> expression representing input value to sum operation x) Create an aggregate expression applying the sum operation.
public <N extends Number> Expression<N>	Returns: sum sum(Expression<? extends N> expression x, Expression<? extends N> expression y) Create an expression that returns the sum of its arguments.
public <N extends Number> Expression<N>	Returns: sum sum(Expression<? extends N> expression x, N value y) Create an expression that returns the sum of its arguments.
public <N extends Number> Expression<N>	Returns: sum sum(N value x, Expression<? extends N> expression y) Create an expression that returns the sum of its arguments.
public Expression<Double>	Returns: sum expression sumAsDouble(Expression<Float> expression representing input value to sum operation x) Create an aggregate expression applying the sum operation to a Float-valued expression, returning a Double result.
public Expression<Long>	Returns: sum expression sumAsLong(Expression<Integer> expression representing input value to sum operation x) Create an aggregate expression applying the sum operation to an Integer-valued expression, returning a Long result.
public Expression<BigDecimal>	Returns: Expression<BigDecimal> toBigDecimal(Expression<? extends Number> numeric expression number) Typecast.
public Expression<BigInteger>	Returns: Expression<BigInteger> toBigInteger(Expression<? extends Number> numeric expression number) Typecast.
public Expression<Double>	Returns: Expression<Double> toDouble(Expression<? extends Number> numeric expression number) Typecast.
public Expression<Float>	Returns: Expression<Float> toFloat(Expression<? extends Number> numeric expression number) Typecast.
public Expression<Integer>	Returns: Expression<Integer> toInteger(Expression<? extends Number> numeric expression number) Typecast.
public Expression<Long>	Returns: Expression<Long> toLong(Expression<? extends Number> numeric expression number) Typecast.
public Expression<String>	Returns: Expression<String> toString(Expression<Character> expression character) Typecast.
public <X, T, V extends T> Join<X, V>	Returns: Join object of the specified type treat(Join<X, T> Join object join, Class<V> type to be downcast to type) Downcast Join object to the specified type.
public <X, T, E extends T> CollectionJoin<X, E>	Returns: CollectionJoin object of the specified type treat(CollectionJoin<X, T> CollectionJoin object join, Class<E> type to be downcast to type) Downcast CollectionJoin object to the specified type.
public <X, T, E extends T> SetJoin<X, E>	Returns: SetJoin object of the specified type treat(SetJoin<X, T> SetJoin object join, Class<E> type to be downcast to type) Downcast SetJoin object to the specified type.
public <X, T, E extends T> ListJoin<X, E>	Returns: ListJoin object of the specified type treat(ListJoin<X, T> ListJoin object join, Class<E> type to be downcast to type) Downcast ListJoin object to the specified type.
public <X, K, T, V extends T> MapJoin<X, K, V>	Returns: MapJoin object of the specified type treat(MapJoin<X, K, T> MapJoin object join, Class<V> type to be downcast to type) Downcast MapJoin object to the specified type.
public <X, T extends X> Path<T>	Returns: Path object of the specified type treat(Path<X> path path, Class<T> type to be downcast to type) Downcast Path object to the specified type.
public <X, T extends X> Root<T>	Returns: Root object of the specified type treat(Root<X> root root, Class<T> type to be downcast to type) Downcast Root object to the specified type.
public Expression<String>	Returns: trim expression trim(Expression<String> expression for string to trim x) Create expression to trim blanks from both ends of a string.
public Expression<String>	Returns: trim expression trim(CriteriaBuilder.Trimspec trim specification ts, Expression<String> expression for string to trim x) Create expression to trim blanks from a string.
public Expression<String>	Returns: trim expression trim(Expression<Character> expression for character to be trimmed t, Expression<String> expression for string to trim x) Create expression to trim character from both ends of a string.
public Expression<String>	Returns: trim expression trim(CriteriaBuilder.Trimspec trim specification ts, Expression<Character> expression for character to be trimmed t, Expression<String> expression for string to trim x) Create expression to trim character from a string.
public Expression<String>	Returns: trim expression trim(char character to be trimmed t, Expression<String> expression for string to trim x) Create expression to trim character from both ends of a string.
public Expression<String>	Returns: trim expression trim(CriteriaBuilder.Trimspec trim specification ts, char character to be trimmed t, Expression<String> expression for string to trim x) Create expression to trim character from a string.
public CompoundSelection<Tuple>	Returns: tuple-valued compound selection tuple(Selection<?>... selection items selections) Create a tuple-valued selection item.
public Expression<String>	Returns: expression to convert to uppercase upper(Expression<String> string expression x) Create expression for converting a string to uppercase.
public <V, M extends Map<?, V>> Expression<Collection<V>>	Returns: collection expression values(M map map) Create an expression that returns the values of a map.

public Interface CriteriaBuilder

Nested and Inner Type Summary

Method Summary