Interface NumericExpression<N extends Number & Comparable<N>>

Type Parameters:

N - the type of the expression

All Superinterfaces:

ComparableExpression<N>, Expression<N>, Selection<N>, TupleElement<N>

public interface NumericExpression<N extends Number & Comparable<N>>
extends ComparableExpression<N>

Type for number query expressions.

Since:

4.0

Method Summary

Modifier and Type	Method	Description
NumericExpression<N>	abs()	Create an expression that returns the absolute value of this expression.
NumericExpression<Double>	avg()	Create an aggregate expression applying the avg operation.
NumericExpression<N>	ceiling()	Create an expression that returns the ceiling of this expression, that is, the smallest integer greater than or equal to this expression.
NumericExpression<N>	coalesce(Expression<? extends N> y)	Create an expression that returns null if this and the argument evaluate to null, and the value of the first non-null expression otherwise.
NumericExpression<N>	coalesce(N y)	Create an expression that returns null if this and the argument evaluate to null, and the value of the first non-null expression otherwise.
NumericExpression<N>	dividedBy(Expression<? extends N> y)	Create an expression that returns the quotient of this expression divided by the argument.
NumericExpression<N>	dividedBy(N y)	Create an expression that returns the quotient of this expression divided by the argument.
NumericExpression<N>	dividedInto(N y)	Create an expression that returns the quotient of this expression dividing the argument.
NumericExpression<Double>	exp()	Create an expression that returns the exponential of this expression, that is, Euler's number e raised to the power of its argument.
NumericExpression<N>	floor()	Create an expression that returns the floor of this expression, that is, the largest integer smaller than or equal to this expression.
Predicate	ge(Expression<? extends Number> y)	Create a predicate for testing whether this expression is greater than or equal to the first argument.
Predicate	ge(Number y)	Create a predicate for testing whether this expression is greater than or equal to the first argument.
Predicate	gt(Expression<? extends Number> y)	Create a predicate for testing whether this expression is greater than the first argument.
Predicate	gt(Number y)	Create a predicate for testing whether this expression is greater than the first argument.
Predicate	le(Expression<? extends Number> y)	Create a predicate for testing whether this expression is less than or equal to the first argument.
Predicate	le(Number y)	Create a predicate for testing whether this expression is less than or equal to the first argument.
NumericExpression<Double>	ln()	Create an expression that returns the natural logarithm of this expression.
Predicate	lt(Expression<? extends Number> y)	Create a predicate for testing whether this expression is less than the first argument.
Predicate	lt(Number y)	Create a predicate for testing whether this expression is less than the first argument.
NumericExpression<N>	max()	Create an aggregate expression applying the numerical max operation.
NumericExpression<N>	min()	Create an aggregate expression applying the numerical min operation.
NumericExpression<N>	minus(Expression<? extends N> y)	Create an expression that returns the difference between this expression subtracted by the argument.
NumericExpression<N>	minus(N y)	Create an expression that returns the difference between this expression subtracted by the argument.
NumericExpression<N>	negated()	Create an expression that returns the arithmetic negation of this expression.
NumericExpression<N>	nullif(Expression<? extends N> y)	Create an expression that tests whether this expression is equal to the argument, returning null if they are and the value of the first expression if they are not.
NumericExpression<N>	nullif(N y)	Create an expression that tests whether this expression is equal to the argument, returning null if they are and the value of the first expression if they are not.
NumericExpression<N>	plus(Expression<? extends N> y)	Create an expression that returns the sum of this expression and its argument.
NumericExpression<N>	plus(N y)	Create an expression that returns the sum of this expression and its argument.
NumericExpression<Double>	power(Expression<? extends Number> y)	Create an expression that returns this expression raised to the power of its first argument.
NumericExpression<Double>	power(Number y)	Create an expression that returns this number expression raised to the power of its first argument.
NumericExpression<N>	round(Integer n)	Create an expression that returns this number expression rounded to the number of decimal places given by the first argument.
NumericExpression<Integer>	sign()	Create an expression that returns the sign of this expression, that is, 1 if this expression is positive, -1 if this expression is negative, or 0 if this expression is exactly zero.
NumericExpression<Double>	sqrt()	Create an expression that returns the square root of this expression.
NumericExpression<N>	subtractedFrom(N y)	Create an expression that returns the difference between this expression subtracted from the argument.
NumericExpression<N>	sum()	Create an aggregate expression applying the sum operation.
NumericExpression<Double>	sumAsDouble()	Create an aggregate expression applying the sum operation, returning a Double result.
NumericExpression<Long>	sumAsLong()	Create an aggregate expression applying the sum operation, returning a Long result.
NumericExpression<N>	times(Expression<? extends N> y)	Create an expression that returns the product of this expression multiplied by the argument.
NumericExpression<N>	times(N y)	Create an expression that returns the product of this expression multiplied by the argument.
NumericExpression<BigDecimal>	toBigDecimal()	Typecast.
NumericExpression<BigInteger>	toBigInteger()	Typecast.
NumericExpression<Double>	toDouble()	Typecast.
NumericExpression<Float>	toFloat()	Typecast.
NumericExpression<Integer>	toInteger()	Typecast.
NumericExpression<Long>	toLong()	Typecast.

Methods inherited from interface ComparableExpression

asc, asc, between, between, desc, desc, greaterThan, greaterThan, greaterThanOrEqualTo, greaterThanOrEqualTo, lessThan, lessThan, lessThanOrEqualTo, lessThanOrEqualTo

Methods inherited from interface Expression

as, cast, count, countDistinct, equalTo, equalTo, in, in, in, in, in, isMember, isNotMember, isNotNull, isNull, notEqualTo, notEqualTo, selectCase

Methods inherited from interface Selection

alias, getCompoundSelectionItems, isCompoundSelection

Methods inherited from interface TupleElement

getAlias, getJavaType

Method Details

gt

@Nonnull
Predicate gt(@Nonnull
 Expression<? extends Number> y)

Create a predicate for testing whether this expression is greater than the first argument.

Parameters:

y - expression

Returns:

greater-than predicate

See Also:

• CriteriaBuilder.gt(Expression, Expression)

gt

@Nonnull
Predicate gt(Number y)

Create a predicate for testing whether this expression is greater than the first argument.

Parameters:

y - value

Returns:

greater-than predicate

See Also:

• CriteriaBuilder.gt(Expression, Number)

ge

@Nonnull
Predicate ge(@Nonnull
 Expression<? extends Number> y)

Create a predicate for testing whether this expression is greater than or equal to the first argument.

Parameters:

y - expression

Returns:

greater-than-or-equal predicate

See Also:

• CriteriaBuilder.ge(Expression, Expression)

ge

@Nonnull
Predicate ge(Number y)

Create a predicate for testing whether this expression is greater than or equal to the first argument.

Parameters:

y - value

Returns:

greater-than-or-equal predicate

See Also:

• CriteriaBuilder.ge(Expression, Number)

lt

@Nonnull
Predicate lt(@Nonnull
 Expression<? extends Number> y)

Create a predicate for testing whether this expression is less than the first argument.

Parameters:

y - expression

Returns:

less-than predicate

See Also:

• CriteriaBuilder.lt(Expression, Expression)

lt

@Nonnull
Predicate lt(Number y)

Create a predicate for testing whether this expression is less than the first argument.

Parameters:

y - value

Returns:

less-than predicate

See Also:

• CriteriaBuilder.lt(Expression, Number)

le

@Nonnull
Predicate le(@Nonnull
 Expression<? extends Number> y)

Create a predicate for testing whether this expression is less than or equal to the first argument.

Parameters:

y - expression

Returns:

less-than-or-equal predicate

See Also:

• CriteriaBuilder.le(Expression, Expression)

le

@Nonnull
Predicate le(Number y)

Create a predicate for testing whether this expression is less than or equal to the first argument.

Parameters:

y - value

Returns:

less-than-or-equal predicate

See Also:

• CriteriaBuilder.le(Expression, Number)

sign

@Nonnull
NumericExpression<Integer> sign()

Create an expression that returns the sign of this expression, that is, 1 if this expression is positive, -1 if this expression is negative, or 0 if this expression is exactly zero.

Returns:

sign

See Also:

• CriteriaBuilder.sign(Expression)

negated

@Nonnull
NumericExpression<N> negated()

Create an expression that returns the arithmetic negation of this expression.

Returns:

arithmetic negation

See Also:

• CriteriaBuilder.neg(Expression)

abs

@Nonnull
NumericExpression<N> abs()

Create an expression that returns the absolute value of this expression.

Returns:

absolute value

See Also:

• CriteriaBuilder.abs(Expression)

ceiling

@Nonnull
NumericExpression<N> ceiling()

Create an expression that returns the ceiling of this expression, that is, the smallest integer greater than or equal to this expression.

Returns:

ceiling

See Also:

• CriteriaBuilder.ceiling(Expression)

floor

@Nonnull
NumericExpression<N> floor()

Create an expression that returns the floor of this expression, that is, the largest integer smaller than or equal to this expression.

Returns:

floor

See Also:

• CriteriaBuilder.floor(Expression)

plus

@Nonnull
NumericExpression<N> plus(@Nonnull
 Expression<? extends N> y)

Create an expression that returns the sum of this expression and its argument.

Parameters:

y - expression

Returns:

sum

See Also:

• CriteriaBuilder.sum(Expression, Expression)

plus

@Nonnull
NumericExpression<N> plus(N y)

Create an expression that returns the sum of this expression and its argument.

Parameters:

y - value

Returns:

sum

See Also:

• CriteriaBuilder.sum(Expression, Number)

times

@Nonnull
NumericExpression<N> times(@Nonnull
 Expression<? extends N> y)

Create an expression that returns the product of this expression multiplied by the argument.

Parameters:

y - expression

Returns:

product

See Also:

• CriteriaBuilder.prod(Expression, Expression)

times

@Nonnull
NumericExpression<N> times(N y)

Create an expression that returns the product of this expression multiplied by the argument.

Parameters:

y - value

Returns:

product

See Also:

• CriteriaBuilder.prod(Expression, Number)

minus

@Nonnull
NumericExpression<N> minus(@Nonnull
 Expression<? extends N> y)

Create an expression that returns the difference between this expression subtracted by the argument.

Parameters:

y - expression

Returns:

difference

See Also:

• CriteriaBuilder.diff(Expression, Expression)

minus

@Nonnull
NumericExpression<N> minus(N y)

Create an expression that returns the difference between this expression subtracted by the argument.

Parameters:

y - value

Returns:

difference

See Also:

• CriteriaBuilder.diff(Expression, Number)

dividedBy

@Nonnull
NumericExpression<N> dividedBy(@Nonnull
 Expression<? extends N> y)

Create an expression that returns the quotient of this expression divided by the argument.

Parameters:

y - expression

Returns:

quotient

See Also:

• CriteriaBuilder.quot(Expression, Expression)

dividedBy

@Nonnull
NumericExpression<N> dividedBy(N y)

Create an expression that returns the quotient of this expression divided by the argument.

Parameters:

y - value

Returns:

quotient

See Also:

• CriteriaBuilder.quot(Expression, Number)

subtractedFrom

@Nonnull
NumericExpression<N> subtractedFrom(N y)

Create an expression that returns the difference between this expression subtracted from the argument.

Parameters:

y - value

Returns:

difference

dividedInto

@Nonnull
NumericExpression<N> dividedInto(N y)

Create an expression that returns the quotient of this expression dividing the argument.

Parameters:

y - value

Returns:

quotient

sqrt

@Nonnull
NumericExpression<Double> sqrt()

Create an expression that returns the square root of this expression.

Returns:

square root

See Also:

• CriteriaBuilder.sqrt(Expression)

exp

@Nonnull
NumericExpression<Double> exp()

Create an expression that returns the exponential of this expression, that is, Euler's number e raised to the power of its argument.

Returns:

exponential

See Also:

• CriteriaBuilder.exp(Expression)

ln

@Nonnull
NumericExpression<Double> ln()

Create an expression that returns the natural logarithm of this expression.

Returns:

natural logarithm

See Also:

• CriteriaBuilder.ln(Expression)

power

@Nonnull
NumericExpression<Double> power(@Nonnull
 Expression<? extends Number> y)

Create an expression that returns this expression raised to the power of its first argument.

Parameters:

y - exponent

Returns:

the base raised to the power of the exponent

See Also:

• CriteriaBuilder.power(Expression, Expression)

power

@Nonnull
NumericExpression<Double> power(Number y)

Create an expression that returns this number expression raised to the power of its first argument.

Parameters:

y - exponent

Returns:

the base raised to the power of the exponent

See Also:

• CriteriaBuilder.power(Expression, Number)

round

@Nonnull
NumericExpression<N> round(@Nonnull
 Integer n)

Create an expression that returns this number expression rounded to the number of decimal places given by the first argument.

Parameters:

n - number of decimal places

Returns:

the rounded value

See Also:

• CriteriaBuilder.round(Expression, Integer)

avg

@Nonnull
NumericExpression<Double> avg()

Create an aggregate expression applying the avg operation.

Returns:

avg expression

See Also:

• CriteriaBuilder.avg(Expression)

sum

@Nonnull
NumericExpression<N> sum()

Create an aggregate expression applying the sum operation.

Returns:

sum expression

See Also:

• CriteriaBuilder.sum(Expression)

sumAsLong

@Nonnull
NumericExpression<Long> sumAsLong()

Create an aggregate expression applying the sum operation, returning a Long result.

Returns:

sum expression

See Also:

• CriteriaBuilder.sumAsLong(Expression)

sumAsDouble

@Nonnull
NumericExpression<Double> sumAsDouble()

Create an aggregate expression applying the sum operation, returning a Double result.

Returns:

sum expression

See Also:

• CriteriaBuilder.sumAsDouble(Expression)

max

@Nonnull
NumericExpression<N> max()

Create an aggregate expression applying the numerical max operation.

Specified by:

max in interface ComparableExpression<N extends Number & Comparable<N>>

Returns:

max expression

See Also:

• CriteriaBuilder.max(Expression)

min

@Nonnull
NumericExpression<N> min()

Create an aggregate expression applying the numerical min operation.

Specified by:

min in interface ComparableExpression<N extends Number & Comparable<N>>

Returns:

min expression

See Also:

• CriteriaBuilder.min(Expression)

toLong

@Nonnull
NumericExpression<Long> toLong()

Typecast.

Returns:

Expression<Long>

See Also:

• CriteriaBuilder.toLong(Expression)

toInteger

@Nonnull
NumericExpression<Integer> toInteger()

Typecast.

Returns:

Expression<Integer>

See Also:

• CriteriaBuilder.toInteger(Expression)

toFloat

@Nonnull
NumericExpression<Float> toFloat()

Typecast.

Returns:

Expression<Float>

See Also:

• CriteriaBuilder.toFloat(Expression)

toDouble

@Nonnull
NumericExpression<Double> toDouble()

Typecast.

Returns:

Expression<Double>

See Also:

• CriteriaBuilder.toDouble(Expression)

toBigDecimal

@Nonnull
NumericExpression<BigDecimal> toBigDecimal()

Typecast.

Returns:

Expression<BigDecimal>

See Also:

• CriteriaBuilder.toBigDecimal(Expression)

toBigInteger

@Nonnull
NumericExpression<BigInteger> toBigInteger()

Typecast.

Returns:

Expression<BigInteger>

See Also:

• CriteriaBuilder.toBigInteger(Expression)

coalesce

@Nonnull
NumericExpression<N> coalesce(N y)

Description copied from interface: Expression

Create an expression that returns null if this and the argument evaluate to null, and the value of the first non-null expression otherwise.

Specified by:

coalesce in interface ComparableExpression<N extends Number & Comparable<N>>

Specified by:

coalesce in interface Expression<N extends Number & Comparable<N>>

Parameters:

y - value

Returns:

coalesce expression

coalesce

@Nonnull
NumericExpression<N> coalesce(@Nonnull
 Expression<? extends N> y)

Description copied from interface: Expression

Create an expression that returns null if this and the argument evaluate to null, and the value of the first non-null expression otherwise.

Specified by:

coalesce in interface ComparableExpression<N extends Number & Comparable<N>>

Specified by:

coalesce in interface Expression<N extends Number & Comparable<N>>

Parameters:

y - expression

Returns:

coalesce expression

nullif

@Nonnull
NumericExpression<N> nullif(N y)

Description copied from interface: Expression

Create an expression that tests whether this expression is equal to the argument, returning null if they are and the value of the first expression if they are not.

Specified by:

nullif in interface ComparableExpression<N extends Number & Comparable<N>>

Specified by:

nullif in interface Expression<N extends Number & Comparable<N>>

Parameters:

y - value

Returns:

nullif expression

nullif

@Nonnull
NumericExpression<N> nullif(@Nonnull
 Expression<? extends N> y)

Description copied from interface: Expression

Create an expression that tests whether this expression is equal to the argument, returning null if they are and the value of the first expression if they are not.

Specified by:

nullif in interface ComparableExpression<N extends Number & Comparable<N>>

Specified by:

nullif in interface Expression<N extends Number & Comparable<N>>

Parameters:

y - expression

Returns:

nullif expression