Home » JPA » Queries » CriteriaBuilder
4492 words

javax.persistence.criteria.CriteriaBuilder - JPA interface

javax.persistence.criteria
Interface CriteriaBuilder

Used to construct criteria queries, compound selections, expressions, predicates, orderings.

Note that Predicate is used instead of Expression in this API in order to work around the fact that Java generics are not compatible with varags.

Since:
JPA 2.0
Learn how to define queries using the criteria API in Chapter 4 of the ObjectDB/JPA manual.
Expression<N> abs(Expression<N> x)
Create an expression that returns the absolute value of its argument.
Create an expression that returns the absolute value of its argument.
Parameters:
x - expression
Returns:
absolute value
Since:
JPA 2.0
Expression<Y> all(Subquery<Y> subquery)
Create an all expression over the subquery results.
Create an all expression over the subquery results.
Parameters:
subquery - subquery
Returns:
all expression
Since:
JPA 2.0
Predicate and(Predicate... restrictions)
Create a conjunction of the given restriction predicates.
Create a conjunction of the given restriction predicates. A conjunction of zero predicates is true.
Parameters:
restrictions - zero or more restriction predicates
Returns:
and predicate
Since:
JPA 2.0
Predicate and(Expression<Boolean> x, Expression<Boolean> y)
Create a conjunction of the given boolean expressions.
Create a conjunction of the given boolean expressions.
Parameters:
x - boolean expression
y - boolean expression
Returns:
and predicate
Since:
JPA 2.0
Expression<Y> any(Subquery<Y> subquery)
Create an any expression over the subquery results.
Create an any expression over the subquery results. This expression is equivalent to a some expression.
Parameters:
subquery - subquery
Returns:
any expression
Since:
JPA 2.0
CompoundSelection<Object[]> array(Selection... selections)
Create an array-valued selection item.
Create an array-valued selection item.
Parameters:
selections - selection items
Returns:
array-valued compound selection
Throws:
IllegalArgumentException - if an argument is a tuple- or array-valued selection item
Since:
JPA 2.0
Order asc(Expression<?> x)
Create an ordering by the ascending value of the expression.
Create an ordering by the ascending value of the expression.
Parameters:
x - expression used to define the ordering
Returns:
ascending ordering corresponding to the expression
Since:
JPA 2.0
Expression<Double> avg(Expression<N> x)
Create an aggregate expression applying the avg operation.
Create an aggregate expression applying the avg operation.
Parameters:
x - expression representing input value to avg operation
Returns:
avg expression
Since:
JPA 2.0
Predicate between(Expression<?> v, Y x, Y y)
Create a predicate for testing whether the first argument is between the second and third arguments in value.
Create a predicate for testing whether the first argument is between the second and third arguments in value.
Parameters:
v - expression
x - value
y - value
Returns:
between predicate
Since:
JPA 2.0
Predicate between(Expression<?> v, Expression<?> x, Expression<?> y)
Create a predicate for testing whether the first argument is between the second and third arguments in value.
Create a predicate for testing whether the first argument is between the second and third arguments in value.
Parameters:
v - expression
x - expression
y - expression
Returns:
between predicate
Since:
JPA 2.0
Coalesce<T> coalesce()
Create a coalesce expression.
Create a coalesce expression.
Returns:
coalesce expression
Since:
JPA 2.0
Expression<Y> coalesce(Expression<?> x, Y y)
Create an expression that returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.
Create an expression that returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.
Parameters:
x - expression
y - value
Returns:
coalesce expression
Since:
JPA 2.0
Expression<Y> coalesce(Expression<?> x, 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.
Create an expression that returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.
Parameters:
x - expression
y - expression
Returns:
coalesce expression
Since:
JPA 2.0
Expression<String> concat(Expression<String> x, String y)
Create an expression for string concatenation.
Create an expression for string concatenation.
Parameters:
x - string expression
y - string
Returns:
expression corresponding to concatenation
Since:
JPA 2.0
Expression<String> concat(String x, Expression<String> y)
Create an expression for string concatenation.
Create an expression for string concatenation.
Parameters:
x - string
y - string expression
Returns:
expression corresponding to concatenation
Since:
JPA 2.0
Expression<String> concat(Expression<String> x, Expression<String> y)
Create an expression for string concatenation.
Create an expression for string concatenation.
Parameters:
x - string expression
y - string expression
Returns:
expression corresponding to concatenation
Since:
JPA 2.0
Predicate conjunction()
Create a conjunction (with zero conjuncts).
Create a conjunction (with zero conjuncts). A conjunction with zero conjuncts is true.
Returns:
and predicate
Since:
JPA 2.0
CompoundSelection<Y> construct(Class<Y> resultClass, Selection... selections)
Create a selection item corresponding to a constructor.
Create a selection item corresponding to a constructor. This method is used to specify a constructor that will be applied to the results of the query execution. If the constructor is for an entity class, the resulting entities will be in the new state after the query is executed.
Parameters:
resultClass - class whose instance is to be constructed
selections - arguments to the constructor
Returns:
compound selection item
Throws:
IllegalArgumentException - if an argument is a tuple- or array-valued selection item
Since:
JPA 2.0
Expression<Long> count(Expression<?> x)
Create an aggregate expression applying the count operation.
Create an aggregate expression applying the count operation.
Parameters:
x - expression representing input value to count operation
Returns:
count expression
Since:
JPA 2.0
Expression<Long> countDistinct(Expression<?> x)
Create an aggregate expression applying the count distinct operation.
Create an aggregate expression applying the count distinct operation.
Parameters:
x - expression representing input value to count distinct operation
Returns:
count distinct expression
Since:
JPA 2.0
CriteriaQuery<Object> createQuery()
Create a CriteriaQuery object.
Create a CriteriaQuery object.
Returns:
criteria query object
Since:
JPA 2.0
CriteriaQuery<T> createQuery(Class<T> resultClass)
Create a CriteriaQuery object with the specified result type.
Create a CriteriaQuery object with the specified result type.
Parameters:
resultClass - type of the query result
Returns:
criteria query object
Since:
JPA 2.0
CriteriaQuery<Tuple> createTupleQuery()
Create a CriteriaQuery object that returns a tuple of objects as its result.
Create a CriteriaQuery object that returns a tuple of objects as its result.
Returns:
criteria query object
Since:
JPA 2.0
Expression<Date> currentDate()
Create expression to return current date.
Create expression to return current date.
Returns:
expression for current date
Since:
JPA 2.0
Expression<Time> currentTime()
Create expression to return current time.
Create expression to return current time.
Returns:
expression for current time
Since:
JPA 2.0
Expression<Timestamp> currentTimestamp()
Create expression to return current timestamp.
Create expression to return current timestamp.
Returns:
expression for current timestamp
Since:
JPA 2.0
Order desc(Expression<?> x)
Create an ordering by the descending value of the expression.
Create an ordering by the descending value of the expression.
Parameters:
x - expression used to define the ordering
Returns:
descending ordering corresponding to the expression
Since:
JPA 2.0
Expression<N> diff(Expression<?> x, N y)
Create an expression that returns the difference between its arguments.
Create an expression that returns the difference between its arguments.
Parameters:
x - expression
y - value
Returns:
difference
Since:
JPA 2.0
Expression<N> diff(N x, Expression<?> y)
Create an expression that returns the difference between its arguments.
Create an expression that returns the difference between its arguments.
Parameters:
x - value
y - expression
Returns:
difference
Since:
JPA 2.0
Expression<N> diff(Expression<?> x, Expression<?> y)
Create an expression that returns the difference between its arguments.
Create an expression that returns the difference between its arguments.
Parameters:
x - expression
y - expression
Returns:
difference
Since:
JPA 2.0
Predicate disjunction()
Create a disjunction (with zero disjuncts).
Create a disjunction (with zero disjuncts). A disjunction with zero disjuncts is false.
Returns:
or predicate
Since:
JPA 2.0
Predicate equal(Expression<?> x, Object y)
Create a predicate for testing the arguments for equality.
Create a predicate for testing the arguments for equality.
Parameters:
x - expression
y - object
Returns:
equality predicate
Since:
JPA 2.0
Predicate equal(Expression<?> x, Expression<?> y)
Create a predicate for testing the arguments for equality.
Create a predicate for testing the arguments for equality.
Parameters:
x - expression
y - expression
Returns:
equality predicate
Since:
JPA 2.0
Predicate exists(Subquery<?> subquery)
Create a predicate testing the existence of a subquery result.
Create a predicate testing the existence of a subquery result.
Parameters:
subquery - subquery whose result is to be tested
Returns:
exists predicate
Since:
JPA 2.0
Expression<T> function(String name, Class<T> type, Expression... args)
Create an expression for the execution of a database function.
Create an expression for the execution of a database function.
Parameters:
name - function name
type - expected result type
args - function arguments
Returns:
expression
Since:
JPA 2.0
Predicate ge(Expression<?> x, Number y)
Create a predicate for testing whether the first argument is greater than or equal to the second.
Create a predicate for testing whether the first argument is greater than or equal to the second.
Parameters:
x - expression
y - value
Returns:
greater-than-or-equal predicate
Since:
JPA 2.0
Predicate ge(Expression<?> x, Expression<?> y)
Create a predicate for testing whether the first argument is greater than or equal to the second.
Create a predicate for testing whether the first argument is greater than or equal to the second.
Parameters:
x - expression
y - expression
Returns:
greater-than-or-equal predicate
Since:
JPA 2.0
Predicate greaterThan(Expression<?> x, Y y)
Create a predicate for testing whether the first argument is greater than the second.
Create a predicate for testing whether the first argument is greater than the second.
Parameters:
x - expression
y - value
Returns:
greater-than predicate
Since:
JPA 2.0
Predicate greaterThan(Expression<?> x, Expression<?> y)
Create a predicate for testing whether the first argument is greater than the second.
Create a predicate for testing whether the first argument is greater than the second.
Parameters:
x - expression
y - expression
Returns:
greater-than predicate
Since:
JPA 2.0
Predicate greaterThanOrEqualTo(Expression<?> x, Y y)
Create a predicate for testing whether the first argument is greater than or equal to the second.
Create a predicate for testing whether the first argument is greater than or equal to the second.
Parameters:
x - expression
y - value
Returns:
greater-than-or-equal predicate
Since:
JPA 2.0
Predicate greaterThanOrEqualTo(Expression<?> x, Expression<?> y)
Create a predicate for testing whether the first argument is greater than or equal to the second.
Create a predicate for testing whether the first argument is greater than or equal to the second.
Parameters:
x - expression
y - expression
Returns:
greater-than-or-equal predicate
Since:
JPA 2.0
Expression<X> greatest(Expression<X> x)
Create an aggregate expression for finding the greatest of the values (strings, dates, etc).
Create an aggregate expression for finding the greatest of the values (strings, dates, etc).
Parameters:
x - expression representing input value to greatest operation
Returns:
greatest expression
Since:
JPA 2.0
Predicate gt(Expression<?> x, Number y)
Create a predicate for testing whether the first argument is greater than the second.
Create a predicate for testing whether the first argument is greater than the second.
Parameters:
x - expression
y - value
Returns:
greater-than predicate
Since:
JPA 2.0
Predicate gt(Expression<?> x, Expression<?> y)
Create a predicate for testing whether the first argument is greater than the second.
Create a predicate for testing whether the first argument is greater than the second.
Parameters:
x - expression
y - expression
Returns:
greater-than predicate
Since:
JPA 2.0
In<T> in(Expression<?> expression)
Create predicate to test whether given expression is contained in a list of values.
Create predicate to test whether given expression is contained in a list of values.
Parameters:
expression - to be tested against list of values
Returns:
in predicate
Since:
JPA 2.0
Predicate isEmpty(Expression<C> collection)
Create a predicate that tests whether a collection is empty.
Create a predicate that tests whether a collection is empty.
Parameters:
collection - expression
Returns:
is-empty predicate
Since:
JPA 2.0
Predicate isFalse(Expression<Boolean> x)
Create a predicate testing for a false value.
Create a predicate testing for a false value.
Parameters:
x - expression to be tested
Returns:
predicate
Since:
JPA 2.0
Predicate isMember(E elem, Expression<C> collection)
Create a predicate that tests whether an element is a member of a collection.
Create a predicate that tests whether an element is a member of a collection. If the collection is empty, the predicate will be false.
Parameters:
elem - element
collection - expression
Returns:
is-member predicate
Since:
JPA 2.0
Predicate isMember(Expression<E> elem, Expression<C> collection)
Create a predicate that tests whether an element is a member of a collection.
Create a predicate that tests whether an element is a member of a collection. If the collection is empty, the predicate will be false.
Parameters:
elem - element expression
collection - expression
Returns:
is-member predicate
Since:
JPA 2.0
Predicate isNotEmpty(Expression<C> collection)
Create a predicate that tests whether a collection is not empty.
Create a predicate that tests whether a collection is not empty.
Parameters:
collection - expression
Returns:
is-not-empty predicate
Since:
JPA 2.0
Predicate isNotMember(E elem, Expression<C> collection)
Create a predicate that tests whether an element is not a member of a collection.
Create a predicate that tests whether an element is not a member of a collection. If the collection is empty, the predicate will be true.
Parameters:
elem - element
collection - expression
Returns:
is-not-member predicate
Since:
JPA 2.0
Predicate isNotMember(Expression<E> elem, Expression<C> collection)
Create a predicate that tests whether an element is not a member of a collection.
Create a predicate that tests whether an element is not a member of a collection. If the collection is empty, the predicate will be true.
Parameters:
elem - element expression
collection - expression
Returns:
is-not-member predicate
Since:
JPA 2.0
Predicate isNotNull(Expression<?> x)
Create a predicate to test whether the expression is not null.
Create a predicate to test whether the expression is not null.
Parameters:
x - expression
Returns:
is-not-null predicate
Since:
JPA 2.0
Predicate isNull(Expression<?> x)
Create a predicate to test whether the expression is null.
Create a predicate to test whether the expression is null.
Parameters:
x - expression
Returns:
is-null predicate
Since:
JPA 2.0
Predicate isTrue(Expression<Boolean> x)
Create a predicate testing for a true value.
Create a predicate testing for a true value.
Parameters:
x - expression to be tested
Returns:
predicate
Since:
JPA 2.0
Expression<Set<K>> keys(M map)
Create an expression that returns the keys of a map.
Create an expression that returns the keys of a map.
Parameters:
map - map
Returns:
set expression
Since:
JPA 2.0
Predicate le(Expression<?> x, Number y)
Create a predicate for testing whether the first argument is less than or equal to the second.
Create a predicate for testing whether the first argument is less than or equal to the second.
Parameters:
x - expression
y - value
Returns:
less-than-or-equal predicate
Since:
JPA 2.0
Predicate le(Expression<?> x, Expression<?> y)
Create a predicate for testing whether the first argument is less than or equal to the second.
Create a predicate for testing whether the first argument is less than or equal to the second.
Parameters:
x - expression
y - expression
Returns:
less-than-or-equal predicate
Since:
JPA 2.0
Expression<X> least(Expression<X> x)
Create an aggregate expression for finding the least of the values (strings, dates, etc).
Create an aggregate expression for finding the least of the values (strings, dates, etc).
Parameters:
x - expression representing input value to least operation
Returns:
least expression
Since:
JPA 2.0
Expression<Integer> length(Expression<String> x)
Create expression to return length of a string.
Create expression to return length of a string.
Parameters:
x - string expression
Returns:
length expression
Since:
JPA 2.0
Predicate lessThan(Expression<?> x, Y y)
Create a predicate for testing whether the first argument is less than the second.
Create a predicate for testing whether the first argument is less than the second.
Parameters:
x - expression
y - value
Returns:
less-than predicate
Since:
JPA 2.0
Predicate lessThan(Expression<?> x, Expression<?> y)
Create a predicate for testing whether the first argument is less than the second.
Create a predicate for testing whether the first argument is less than the second.
Parameters:
x - expression
y - expression
Returns:
less-than predicate
Since:
JPA 2.0
Predicate lessThanOrEqualTo(Expression<?> x, Y y)
Create a predicate for testing whether the first argument is less than or equal to the second.
Create a predicate for testing whether the first argument is less than or equal to the second.
Parameters:
x - expression
y - value
Returns:
less-than-or-equal predicate
Since:
JPA 2.0
Predicate lessThanOrEqualTo(Expression<?> x, Expression<?> y)
Create a predicate for testing whether the first argument is less than or equal to the second.
Create a predicate for testing whether the first argument is less than or equal to the second.
Parameters:
x - expression
y - expression
Returns:
less-than-or-equal predicate
Since:
JPA 2.0
Predicate like(Expression<String> x, String pattern)
Create a predicate for testing whether the expression satisfies the given pattern.
Create a predicate for testing whether the expression satisfies the given pattern.
Parameters:
x - string expression
pattern - string
Returns:
like predicate
Since:
JPA 2.0
Predicate like(Expression<String> x, Expression<String> pattern)
Create a predicate for testing whether the expression satisfies the given pattern.
Create a predicate for testing whether the expression satisfies the given pattern.
Parameters:
x - string expression
pattern - string expression
Returns:
like predicate
Since:
JPA 2.0
Predicate like(Expression<String> x, String pattern, char escapeChar)
Create a predicate for testing whether the expression satisfies the given pattern.
Create a predicate for testing whether the expression satisfies the given pattern.
Parameters:
x - string expression
pattern - string
escapeChar - escape character
Returns:
like predicate
Since:
JPA 2.0
Predicate like(Expression<String> x, Expression<String> pattern, char escapeChar)
Create a predicate for testing whether the expression satisfies the given pattern.
Create a predicate for testing whether the expression satisfies the given pattern.
Parameters:
x - string expression
pattern - string expression
escapeChar - escape character
Returns:
like predicate
Since:
JPA 2.0
Predicate like(Expression<String> x, String pattern, Expression<Character> escapeChar)
Create a predicate for testing whether the expression satisfies the given pattern.
Create a predicate for testing whether the expression satisfies the given pattern.
Parameters:
x - string expression
pattern - string
escapeChar - escape character expression
Returns:
like predicate
Since:
JPA 2.0
Predicate like(Expression<String> x, Expression<String> pattern, Expression<Character> escapeChar)
Create a predicate for testing whether the expression satisfies the given pattern.
Create a predicate for testing whether the expression satisfies the given pattern.
Parameters:
x - string expression
pattern - string expression
escapeChar - escape character expression
Returns:
like predicate
Since:
JPA 2.0
Expression<T> literal(T value)
Create an expression for a literal.
Create an expression for a literal.
Parameters:
value - value represented by the expression
Returns:
expression literal
Throws:
IllegalArgumentException - if value is null
Since:
JPA 2.0
Expression<Integer> locate(Expression<String> x, String pattern)
Create expression to locate the position of one string within another, returning position of first character if found.
Create expression to locate the position of one string within another, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.
Parameters:
x - expression for string to be searched
pattern - string to be located
Returns:
expression corresponding to position
Since:
JPA 2.0
Expression<Integer> locate(Expression<String> x, String pattern, int from)
Create expression to locate the position of one string within another, returning position of first character if found.
Create expression to locate the position of one string within another, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.
Parameters:
x - expression for string to be searched
pattern - string to be located
from - position at which to start search
Returns:
expression corresponding to position
Since:
JPA 2.0
Expression<Integer> locate(Expression<String> x, Expression<String> pattern)
Create expression to locate the position of one string within another, returning position of first character if found.
Create expression to locate the position of one string within another, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.
Parameters:
x - expression for string to be searched
pattern - expression for string to be located
Returns:
expression corresponding to position
Since:
JPA 2.0
Expression<Integer> locate(Expression<String> x, Expression<String> pattern, Expression<Integer> from)
Create expression to locate the position of one string within another, returning position of first character if found.
Create expression to locate the position of one string within another, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.
Parameters:
x - expression for string to be searched
pattern - expression for string to be located
from - expression for position at which to start search
Returns:
expression corresponding to position
Since:
JPA 2.0
Expression<String> lower(Expression<String> x)
Create expression for converting a string to lowercase.
Create expression for converting a string to lowercase.
Parameters:
x - string expression
Returns:
expression to convert to lowercase
Since:
JPA 2.0
Predicate lt(Expression<?> x, Number y)
Create a predicate for testing whether the first argument is less than the second.
Create a predicate for testing whether the first argument is less than the second.
Parameters:
x - expression
y - value
Returns:
less-than predicate
Since:
JPA 2.0
Predicate lt(Expression<?> x, Expression<?> y)
Create a predicate for testing whether the first argument is less than the second.
Create a predicate for testing whether the first argument is less than the second.
Parameters:
x - expression
y - expression
Returns:
less-than predicate
Since:
JPA 2.0
Expression<N> max(Expression<N> x)
Create an aggregate expression applying the numerical max operation.
Create an aggregate expression applying the numerical max operation.
Parameters:
x - expression representing input value to max operation
Returns:
max expression
Since:
JPA 2.0
Expression<N> min(Expression<N> x)
Create an aggregate expression applying the numerical min operation.
Create an aggregate expression applying the numerical min operation.
Parameters:
x - expression representing input value to min operation
Returns:
min expression
Since:
JPA 2.0
Expression<Integer> mod(Expression<Integer> x, Integer y)
Create an expression that returns the modulus of its arguments.
Create an expression that returns the modulus of its arguments.
Parameters:
x - expression
y - value
Returns:
modulus
Since:
JPA 2.0
Expression<Integer> mod(Integer x, Expression<Integer> y)
Create an expression that returns the modulus of its arguments.
Create an expression that returns the modulus of its arguments.
Parameters:
x - value
y - expression
Returns:
modulus
Since:
JPA 2.0
Expression<Integer> mod(Expression<Integer> x, Expression<Integer> y)
Create an expression that returns the modulus of its arguments.
Create an expression that returns the modulus of its arguments.
Parameters:
x - expression
y - expression
Returns:
modulus
Since:
JPA 2.0
Expression<N> neg(Expression<N> x)
Create an expression that returns the arithmetic negation of its argument.
Create an expression that returns the arithmetic negation of its argument.
Parameters:
x - expression
Returns:
arithmetic negation
Since:
JPA 2.0
Predicate not(Expression<Boolean> restriction)
Create a negation of the given restriction.
Create a negation of the given restriction.
Parameters:
restriction - restriction expression
Returns:
not predicate
Since:
JPA 2.0
Predicate notEqual(Expression<?> x, Object y)
Create a predicate for testing the arguments for inequality.
Create a predicate for testing the arguments for inequality.
Parameters:
x - expression
y - object
Returns:
inequality predicate
Since:
JPA 2.0
Predicate notEqual(Expression<?> x, Expression<?> y)
Create a predicate for testing the arguments for inequality.
Create a predicate for testing the arguments for inequality.
Parameters:
x - expression
y - expression
Returns:
inequality predicate
Since:
JPA 2.0
Predicate notLike(Expression<String> x, String pattern)
Create a predicate for testing whether the expression does not satisfy the given pattern.
Create a predicate for testing whether the expression does not satisfy the given pattern.
Parameters:
x - string expression
pattern - string
Returns:
not-like predicate
Since:
JPA 2.0
Predicate notLike(Expression<String> x, Expression<String> pattern)
Create a predicate for testing whether the expression does not satisfy the given pattern.
Create a predicate for testing whether the expression does not satisfy the given pattern.
Parameters:
x - string expression
pattern - string expression
Returns:
not-like predicate
Since:
JPA 2.0
Predicate notLike(Expression<String> x, String pattern, char escapeChar)
Create a predicate for testing whether the expression does not satisfy the given pattern.
Create a predicate for testing whether the expression does not satisfy the given pattern.
Parameters:
x - string expression
pattern - string
escapeChar - escape character
Returns:
not-like predicate
Since:
JPA 2.0
Predicate notLike(Expression<String> x, Expression<String> pattern, char escapeChar)
Create a predicate for testing whether the expression does not satisfy the given pattern.
Create a predicate for testing whether the expression does not satisfy the given pattern.
Parameters:
x - string expression
pattern - string expression
escapeChar - escape character
Returns:
not-like predicate
Since:
JPA 2.0
Predicate notLike(Expression<String> x, String pattern, Expression<Character> escapeChar)
Create a predicate for testing whether the expression does not satisfy the given pattern.
Create a predicate for testing whether the expression does not satisfy the given pattern.
Parameters:
x - string expression
pattern - string
escapeChar - escape character expression
Returns:
not-like predicate
Since:
JPA 2.0
Predicate notLike(Expression<String> x, Expression<String> pattern, Expression<Character> escapeChar)
Create a predicate for testing whether the expression does not satisfy the given pattern.
Create a predicate for testing whether the expression does not satisfy the given pattern.
Parameters:
x - string expression
pattern - string expression
escapeChar - escape character expression
Returns:
not-like predicate
Since:
JPA 2.0
Expression<T> nullLiteral(Class<T> resultClass)
Create an expression for a null literal with the given type.
Create an expression for a null literal with the given type.
Parameters:
resultClass - type of the null literal
Returns:
null expression literal
Since:
JPA 2.0
Expression<Y> nullif(Expression<Y> x, Y 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.
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.
Parameters:
x - expression
y - value
Returns:
nullif expression
Since:
JPA 2.0
Expression<Y> nullif(Expression<Y> x, 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.
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.
Parameters:
x - expression
y - expression
Returns:
nullif expression
Since:
JPA 2.0
Predicate or(Predicate... restrictions)
Create a disjunction of the given restriction predicates.
Create a disjunction of the given restriction predicates. A disjunction of zero predicates is false.
Parameters:
restrictions - zero or more restriction predicates
Returns:
or predicate
Since:
JPA 2.0
Predicate or(Expression<Boolean> x, Expression<Boolean> y)
Create a disjunction of the given boolean expressions.
Create a disjunction of the given boolean expressions.
Parameters:
x - boolean expression
y - boolean expression
Returns:
or predicate
Since:
JPA 2.0
ParameterExpression<T> parameter(Class<T> paramClass)
Create a parameter expression.
Create a parameter expression.
Parameters:
paramClass - parameter class
Returns:
parameter expression
Since:
JPA 2.0
ParameterExpression<T> parameter(Class<T> paramClass, String name)
Create a parameter expression with the given name.
Create a parameter expression with the given name.
Parameters:
paramClass - parameter class
name - name that can be used to refer to the parameter
Returns:
parameter expression
Since:
JPA 2.0
Expression<N> prod(Expression<?> x, N y)
Create an expression that returns the product of its arguments.
Create an expression that returns the product of its arguments.
Parameters:
x - expression
y - value
Returns:
product
Since:
JPA 2.0
Expression<N> prod(N x, Expression<?> y)
Create an expression that returns the product of its arguments.
Create an expression that returns the product of its arguments.
Parameters:
x - value
y - expression
Returns:
product
Since:
JPA 2.0
Expression<N> prod(Expression<?> x, Expression<?> y)
Create an expression that returns the product of its arguments.
Create an expression that returns the product of its arguments.
Parameters:
x - expression
y - expression
Returns:
product
Since:
JPA 2.0
Expression<Number> quot(Expression<?> x, Number y)
Create an expression that returns the quotient of its arguments.
Create an expression that returns the quotient of its arguments.
Parameters:
x - expression
y - value
Returns:
quotient
Since:
JPA 2.0
Expression<Number> quot(Number x, Expression<?> y)
Create an expression that returns the quotient of its arguments.
Create an expression that returns the quotient of its arguments.
Parameters:
x - value
y - expression
Returns:
quotient
Since:
JPA 2.0
Expression<Number> quot(Expression<?> x, Expression<?> y)
Create an expression that returns the quotient of its arguments.
Create an expression that returns the quotient of its arguments.
Parameters:
x - expression
y - expression
Returns:
quotient
Since:
JPA 2.0
Case<R> selectCase()
Create a general case expression.
Create a general case expression.
Returns:
general case expression
Since:
JPA 2.0
SimpleCase<C,R> selectCase(Expression<?> expression)
Create a simple case expression.
Create a simple case expression.
Parameters:
expression - to be tested against the case conditions
Returns:
simple case expression
Since:
JPA 2.0
Expression<Integer> size(C collection)
Create an expression that tests the size of a collection.
Create an expression that tests the size of a collection.
Parameters:
collection - collection
Returns:
size expression
Since:
JPA 2.0
Expression<Integer> size(Expression<C> collection)
Create an expression that tests the size of a collection.
Create an expression that tests the size of a collection.
Parameters:
collection - expression
Returns:
size expression
Since:
JPA 2.0
Expression<Y> some(Subquery<Y> subquery)
Create a some expression over the subquery results.
Create a some expression over the subquery results. This expression is equivalent to an any expression.
Parameters:
subquery - subquery
Returns:
some expression
Since:
JPA 2.0
Expression<Double> sqrt(Expression<?> x)
Create an expression that returns the square root of its argument.
Create an expression that returns the square root of its argument.
Parameters:
x - expression
Returns:
square root
Since:
JPA 2.0
Expression<String> substring(Expression<String> x, int from)
Create an expression for substring extraction.
Create an expression for substring extraction. Extracts a substring starting at the specified position through to end of the string. First position is 1.
Parameters:
x - string expression
from - start position
Returns:
expression corresponding to substring extraction
Since:
JPA 2.0
Expression<String> substring(Expression<String> x, int from, int len)
Create an expression for substring extraction.
Create an expression for substring extraction. Extracts a substring of given length starting at the specified position. First position is 1.
Parameters:
x - string expression
from - start position
len - length
Returns:
expression corresponding to substring extraction
Since:
JPA 2.0
Expression<String> substring(Expression<String> x, Expression<Integer> from)
Create an expression for substring extraction.
Create an expression for substring extraction. Extracts a substring starting at the specified position through to end of the string. First position is 1.
Parameters:
x - string expression
from - start position expression
Returns:
expression corresponding to substring extraction
Since:
JPA 2.0
Expression<String> substring(Expression<String> x, Expression<Integer> from, Expression<Integer> len)
Create an expression for substring extraction.
Create an expression for substring extraction. Extracts a substring of given length starting at the specified position. First position is 1.
Parameters:
x - string expression
from - start position expression
len - length expression
Returns:
expression corresponding to substring extraction
Since:
JPA 2.0
Expression<N> sum(Expression<N> x)
Create an aggregate expression applying the sum operation.
Create an aggregate expression applying the sum operation.
Parameters:
x - expression representing input value to sum operation
Returns:
sum expression
Since:
JPA 2.0
Expression<N> sum(Expression<?> x, N y)
Create an expression that returns the sum of its arguments.
Create an expression that returns the sum of its arguments.
Parameters:
x - expression
y - value
Returns:
sum
Since:
JPA 2.0
Expression<N> sum(N x, Expression<?> y)
Create an expression that returns the sum of its arguments.
Create an expression that returns the sum of its arguments.
Parameters:
x - value
y - expression
Returns:
sum
Since:
JPA 2.0
Expression<N> sum(Expression<?> x, Expression<?> y)
Create an expression that returns the sum of its arguments.
Create an expression that returns the sum of its arguments.
Parameters:
x - expression
y - expression
Returns:
sum
Since:
JPA 2.0
Expression<Double> sumAsDouble(Expression<Float> x)
Create an aggregate expression applying the sum operation to a Float-valued expression, returning a Double result.
Create an aggregate expression applying the sum operation to a Float-valued expression, returning a Double result.
Parameters:
x - expression representing input value to sum operation
Returns:
sum expression
Since:
JPA 2.0
Expression<Long> sumAsLong(Expression<Integer> x)
Create an aggregate expression applying the sum operation to an Integer-valued expression, returning a Long result.
Create an aggregate expression applying the sum operation to an Integer-valued expression, returning a Long result.
Parameters:
x - expression representing input value to sum operation
Returns:
sum expression
Since:
JPA 2.0
Expression<BigDecimal> toBigDecimal(Expression<?> number)
Typecast.
Typecast. Returns same expression object.
Parameters:
number - numeric expression
Returns:
Expression<BigDecimal>
Since:
JPA 2.0
Expression<BigInteger> toBigInteger(Expression<?> number)
Typecast.
Typecast. Returns same expression object.
Parameters:
number - numeric expression
Returns:
Expression<BigInteger>
Since:
JPA 2.0
Expression<Double> toDouble(Expression<?> number)
Typecast.
Typecast. Returns same expression object.
Parameters:
number - numeric expression
Returns:
Expression<Double>
Since:
JPA 2.0
Expression<Float> toFloat(Expression<?> number)
Typecast.
Typecast. Returns same expression object.
Parameters:
number - numeric expression
Returns:
Expression<Float>
Since:
JPA 2.0
Expression<Integer> toInteger(Expression<?> number)
Typecast.
Typecast. Returns same expression object.
Parameters:
number - numeric expression
Returns:
Expression<Integer>
Since:
JPA 2.0
Expression<Long> toLong(Expression<?> number)
Typecast.
Typecast. Returns same expression object.
Parameters:
number - numeric expression
Returns:
Expression<Long>
Since:
JPA 2.0
Expression<String> toString(Expression<Character> character)
Typecast.
Typecast. Returns same expression object.
Parameters:
character - expression
Returns:
Expression<String>
Since:
JPA 2.0
Expression<String> trim(Expression<String> x)
Create expression to trim blanks from both ends of a string.
Create expression to trim blanks from both ends of a string.
Parameters:
x - expression for string to trim
Returns:
trim expression
Since:
JPA 2.0
Expression<String> trim(char t, Expression<String> x)
Create expression to trim character from both ends of a string.
Create expression to trim character from both ends of a string.
Parameters:
t - character to be trimmed
x - expression for string to trim
Returns:
trim expression
Since:
JPA 2.0
Expression<String> trim(Expression<Character> t, Expression<String> x)
Create expression to trim character from both ends of a string.
Create expression to trim character from both ends of a string.
Parameters:
t - expression for character to be trimmed
x - expression for string to trim
Returns:
trim expression
Since:
JPA 2.0
Expression<String> trim(Trimspec ts, Expression<String> x)
Create expression to trim blanks from a string.
Create expression to trim blanks from a string.
Parameters:
ts - trim specification
x - expression for string to trim
Returns:
trim expression
Since:
JPA 2.0
Expression<String> trim(Trimspec ts, char t, Expression<String> x)
Create expression to trim character from a string.
Create expression to trim character from a string.
Parameters:
ts - trim specification
t - character to be trimmed
x - expression for string to trim
Returns:
trim expression
Since:
JPA 2.0
Expression<String> trim(Trimspec ts, Expression<Character> t, Expression<String> x)
Create expression to trim character from a string.
Create expression to trim character from a string.
Parameters:
ts - trim specification
t - expression for character to be trimmed
x - expression for string to trim
Returns:
trim expression
Since:
JPA 2.0
CompoundSelection<Tuple> tuple(Selection... selections)
Create a tuple-valued selection item.
Create a tuple-valued selection item.
Parameters:
selections - selection items
Returns:
tuple-valued compound selection
Throws:
IllegalArgumentException - if an argument is a tuple- or array-valued selection item
Since:
JPA 2.0
Expression<String> upper(Expression<String> x)
Create expression for converting a string to uppercase.
Create expression for converting a string to uppercase.
Parameters:
x - string expression
Returns:
expression to convert to uppercase
Since:
JPA 2.0
Expression<Collection<V>> values(M map)
Create an expression that returns the values of a map.
Create an expression that returns the values of a map.
Parameters:
map - map
Returns:
collection expression
Since:
JPA 2.0
This documentation page is derived (with some adjustments) from the open source JPA 2 RI (EclipseLink)
and is available under the terms of the Eclipse Public License, v. 1.0 and Eclipse Distribution License, v. 1.0.
Object Relational Mapping (ORM) JPA 2 providers include Hibernate, EclipseLink, TopLink, OpenJPA and DataNucleus.
Object DB is not an ORM JPA implementation but an Object Database for Java with built in JPA 2 support.