Package org.dellroad.querystream.jpa

Interface LongStream

All Superinterfaces:

ExprStream<Long,Expression<Long>>, QueryConfigurer<AbstractQuery<?>,Long,Expression<Long>>, QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>, SearchStream<Long,Expression<Long>>

All Known Subinterfaces:

LongValue

public interface LongStream
extends ExprStream<Long,Expression<Long>>

SearchStream containing Long values.

Nested Class Summary

Nested classes/interfaces inherited from interface org.dellroad.querystream.jpa.QueryStream

QueryStream.Builder

Method Summary

Modifier and Type	Method	Description
<R> LongStream	addRoot(Ref<R,? super Root<R>> ref, Class<R> type)	Bind an unbound reference to a new query root that will be added to the query.
DoubleStream	asDoubleStream()
DoubleValue	average()
LongStream	bind(Ref<Long,? super Expression<Long>> ref)	Bind an unbound reference to the items in this stream.
<X2, S2 extends Selection<X2>> LongStream	bind(Ref<X2,? super S2> ref, Function<? super Expression<Long>,? extends S2> refFunction)	Bind an unbound reference to the result of applying the given function to the items in this stream.
LongStream	distinct()	Suppress duplicates.
LongStream	filter(Function<? super Expression<Long>,? extends Expression<Boolean>> predicateBuilder)	Filter results using the boolean expression produced by the given function.
LongValue	findAny()	Find any instance in the stream.
LongValue	findFirst()	Find the first instance in the stream.
LongValue	findSingle()	Find the only instance in the stream or null.
LongStream	groupBy(Function<? super Expression<Long>,? extends Expression<?>> groupFunction)	Apply grouping based on a single expression.
LongStream	groupBy(Ref<?,? extends Expression<?>> ref)	Apply grouping based on an expression reference.
LongStream	groupByMulti(Function<? super Expression<Long>,? extends List<Expression<?>>> groupFunction)	Apply grouping based on a list of expressions.
LongStream	having(Function<? super Expression<Long>,? extends Expression<Boolean>> havingFunction)	Add a "having" restriction.
LongStream	limit(int maxSize)	Return this stream truncated to the specified maximum length.
LongValue	max()
LongValue	min()
LongStream	orderBy(Order... orders)	Order results using the specified Orders.
LongStream	orderBy(Function<? super Expression<Long>,? extends Expression<?>> orderExprFunction, boolean asc)	Order results using the Expression produced by the given Function.
LongStream	orderBy(Ref<?,? extends Expression<?>> ref, boolean asc)	Order results using the specified expression reference.
LongStream	orderByMulti(Function<? super Expression<Long>,? extends List<? extends Order>> orderListFunction)	Order results using the Order list produced by the given Function.
LongStream	peek(Consumer<? super Expression<Long>> peeker)	Peek at the items in this stream.
LongStream	skip(int num)	Return this stream with the specified number of initial elements skipped.
LongValue	sum()
LongStream	thenOrderBy(Order... orders)	Order results using the specified Orders after existing sort.
LongStream	thenOrderBy(Function<? super Expression<Long>,? extends Expression<?>> orderExprFunction, boolean asc)	Order results using the Expression produced by the given Function after existing sort.
LongStream	thenOrderBy(Ref<?,? extends Expression<?>> ref, boolean asc)	Order results using the specified expression reference after existing sort.
LongStream	withFetchGraph(String name)	Configure a fetch graph for this query.
LongStream	withFlushMode(FlushModeType flushMode)	Set the FlushModeType associated with this query.
LongStream	withHint(String name, Object value)	Associate a hint with this query.
LongStream	withHints(Map<String,Object> hints)	Associate hints with this query.
LongStream	withLoadGraph(String name)	Configure a load graph for this query.
LongStream	withLockMode(LockModeType lockMode)	Set the LockModeType associated with this query.
LongStream	withParam(Parameter<Calendar> parameter, Calendar value, TemporalType temporalType)	Bind the value of a query parameter of type Calendar.
LongStream	withParam(Parameter<Date> parameter, Date value, TemporalType temporalType)	Bind the value of a query parameter of type Date.
<T> LongStream	withParam(Parameter<T> parameter, T value)	Bind the value of a query parameter.
LongStream	withParams(Iterable<? extends ParamBinding<?>> params)	Associate parameter bindings with this query.

Methods inherited from interface org.dellroad.querystream.jpa.ExprStream

asSubquery, count, countDistinct, exists, fetch, fetch, fetch, fetch, filter, groupBy, orderBy, orderBy, orderBy, thenOrderBy

Methods inherited from interface org.dellroad.querystream.jpa.QueryConfigurer

configure

Methods inherited from interface org.dellroad.querystream.jpa.QueryStream

getEntityManager, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParams, toCriteriaQuery, toQuery

Methods inherited from interface org.dellroad.querystream.jpa.SearchStream

allMatch, allMatch, anyMatch, anyMatch, flatMap, flatMap, flatMap, flatMapKeys, flatMapValues, getQueryType, getResultList, getResultStream, isEmpty, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, map, map, map, map, mapToDouble, mapToDouble, mapToExpr, mapToFrom, mapToInt, mapToInt, mapToLong, mapToLong, mapToPath, mapToRef, mapToRef, mapToRef, mapToRef, mapToRoot, mapToSelection, noneMatch, noneMatch

Method Details

average

DoubleValue average()

max

LongValue max()

min

LongValue min()

sum

LongValue sum()

asDoubleStream

DoubleStream asDoubleStream()

distinct

LongStream distinct()

Description copied from interface: SearchStream

Suppress duplicates.

Specified by:

distinct in interface ExprStream<Long,Expression<Long>>

Specified by:

distinct in interface SearchStream<Long,Expression<Long>>

Returns:

a new stream with duplicates removed

orderBy

LongStream orderBy(Ref<?,? extends Expression<?>> ref,
 boolean asc)

Description copied from interface: SearchStream

Order results using the specified expression reference.

Replaces any existing sort ordering.

Specified by:

orderBy in interface ExprStream<Long,Expression<Long>>

Specified by:

orderBy in interface SearchStream<Long,Expression<Long>>

Parameters:

ref - previously bound expression reference

asc - true for ascending, false for descending

Returns:

a new stream with specified ordering

orderBy

LongStream orderBy(Function<? super Expression<Long>,? extends Expression<?>> orderExprFunction,
 boolean asc)

Description copied from interface: SearchStream

Order results using the Expression produced by the given Function.

Replaces any existing sort ordering.

Specified by:

orderBy in interface ExprStream<Long,Expression<Long>>

Specified by:

orderBy in interface SearchStream<Long,Expression<Long>>

Parameters:

orderExprFunction - Function that produces an Expression to order on given an item expression

asc - true for ascending, false for descending

Returns:

a new stream with specified ordering

orderByMulti

LongStream orderByMulti(Function<? super Expression<Long>,? extends List<? extends Order>> orderListFunction)

Description copied from interface: SearchStream

Order results using the Order list produced by the given Function.

Replaces any existing sort ordering.

Specified by:

orderByMulti in interface ExprStream<Long,Expression<Long>>

Specified by:

orderByMulti in interface SearchStream<Long,Expression<Long>>

Parameters:

orderListFunction - Function that produces the sort ordering given an item expression

Returns:

a new stream with specified ordering

thenOrderBy

LongStream thenOrderBy(Ref<?,? extends Expression<?>> ref,
 boolean asc)

Description copied from interface: SearchStream

Order results using the specified expression reference after existing sort.

Adds to any existing sort ordering.

Specified by:

thenOrderBy in interface ExprStream<Long,Expression<Long>>

Specified by:

thenOrderBy in interface SearchStream<Long,Expression<Long>>

Parameters:

ref - previously bound expression reference

asc - true for ascending, false for descending

Returns:

a new stream with specified additional ordering

thenOrderBy

LongStream thenOrderBy(Order... orders)

Description copied from interface: SearchStream

Order results using the specified Orders after existing sort.

Adds to any existing sort ordering.

Specified by:

thenOrderBy in interface ExprStream<Long,Expression<Long>>

Specified by:

thenOrderBy in interface SearchStream<Long,Expression<Long>>

Parameters:

orders - ordering(s), with higher precedence orderings first

Returns:

a new stream with specified additional ordering(s)

thenOrderBy

LongStream thenOrderBy(Function<? super Expression<Long>,? extends Expression<?>> orderExprFunction,
 boolean asc)

Description copied from interface: SearchStream

Order results using the Expression produced by the given Function after existing sort.

Adds to any existing sort ordering.

Specified by:

thenOrderBy in interface ExprStream<Long,Expression<Long>>

Specified by:

thenOrderBy in interface SearchStream<Long,Expression<Long>>

Parameters:

orderExprFunction - Function that produces an Expression to order on given an item expression

asc - true for ascending, false for descending

Returns:

a new stream with specified additional ordering

groupBy

LongStream groupBy(Ref<?,? extends Expression<?>> ref)

Description copied from interface: SearchStream

Apply grouping based on an expression reference.

Adds to any previously specified groupings.

Specified by:

groupBy in interface ExprStream<Long,Expression<Long>>

Specified by:

groupBy in interface SearchStream<Long,Expression<Long>>

Parameters:

ref - previously bound expression reference

Returns:

a new stream with additional grouping

groupBy

LongStream groupBy(Function<? super Expression<Long>,? extends Expression<?>> groupFunction)

Description copied from interface: SearchStream

Apply grouping based on a single expression.

Adds to any previously specified groupings.

Specified by:

groupBy in interface ExprStream<Long,Expression<Long>>

Specified by:

groupBy in interface SearchStream<Long,Expression<Long>>

Parameters:

groupFunction - function returning an expression by which to group results

Returns:

a new stream with additional grouping

orderBy

LongStream orderBy(Order... orders)

Description copied from interface: SearchStream

Order results using the specified Orders.

Replaces any existing sort ordering.

Specified by:

orderBy in interface ExprStream<Long,Expression<Long>>

Specified by:

orderBy in interface SearchStream<Long,Expression<Long>>

Parameters:

orders - ordering(s), with higher precedence orderings first

Returns:

a new stream with specified ordering(s)

groupByMulti

LongStream groupByMulti(Function<? super Expression<Long>,? extends List<Expression<?>>> groupFunction)

Description copied from interface: SearchStream

Apply grouping based on a list of expressions.

Adds to any previously specified groupings.

Specified by:

groupByMulti in interface ExprStream<Long,Expression<Long>>

Specified by:

groupByMulti in interface SearchStream<Long,Expression<Long>>

Parameters:

groupFunction - function returning a list of expressions by which to group results

Returns:

a new instance

having

LongStream having(Function<? super Expression<Long>,? extends Expression<Boolean>> havingFunction)

Description copied from interface: SearchStream

Add a "having" restriction.

Adds to any previously specified "having" restrictions.

Specified by:

having in interface ExprStream<Long,Expression<Long>>

Specified by:

having in interface SearchStream<Long,Expression<Long>>

Parameters:

havingFunction - function returning a test to apply to grouped results

Returns:

a new instance

findAny

LongValue findAny()

Description copied from interface: SearchStream

Find any instance in the stream.

Specified by:

findAny in interface ExprStream<Long,Expression<Long>>

Specified by:

findAny in interface SearchStream<Long,Expression<Long>>

Returns:

single-valued stream containg any instance in this stream (or NULL if this stream is empty)

findFirst

LongValue findFirst()

Description copied from interface: SearchStream

Find the first instance in the stream.

Specified by:

findFirst in interface ExprStream<Long,Expression<Long>>

Specified by:

findFirst in interface SearchStream<Long,Expression<Long>>

Returns:

single-valued stream containg the first instance in this stream (or NULL if this stream is empty)

findSingle

LongValue findSingle()

Description copied from interface: SearchStream

Find the only instance in the stream or null.

Invoke this method only when you know that the result stream contains at most one value, e.g., when searching for an object by its value in a field with a unique constraint. If the stream actually contains multiple values, then invoking any of the "single value" SearchValue methods such as value() or toOptional() will generate a NonUniqueResultException.

Using this method is preferable to using SearchStream.findFirst() or SearchStream.findAny() for the same purpose, because it not only actually verifies the uniqueness assumption, but it also makes that assumption clearer in the code.

Example:

  final User user = qb.stream(User.class)
    .filter(u -> qb.equal(u.get(User_.username), username))
    .findSingle()
    .orElseThrow(NoSuchUserException::new);
 

Specified by:

findSingle in interface ExprStream<Long,Expression<Long>>

Specified by:

findSingle in interface SearchStream<Long,Expression<Long>>

Returns:

a single value, either the only instance in this stream or null if this stream is empty

bind

LongStream bind(Ref<Long,? super Expression<Long>> ref)

Description copied from interface: QueryStream

Bind an unbound reference to the items in this stream.

Specified by:

bind in interface ExprStream<Long,Expression<Long>>

Specified by:

bind in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

bind in interface SearchStream<Long,Expression<Long>>

Parameters:

ref - unbound reference

Returns:

new stream that binds ref

peek

LongStream peek(Consumer<? super Expression<Long>> peeker)

Description copied from interface: QueryStream

Peek at the items in this stream.

This is useful in cases where the selection can be modified, e.g., setting join ON conditions using Join.on().

Specified by:

peek in interface ExprStream<Long,Expression<Long>>

Specified by:

peek in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

peek in interface SearchStream<Long,Expression<Long>>

Parameters:

peeker - peeker into stream

Returns:

new stream that peeks into this stream

bind

<X2,
S2 extends Selection<X2>> LongStream bind(Ref<X2,? super S2> ref,
 Function<? super Expression<Long>,? extends S2> refFunction)

Description copied from interface: QueryStream

Bind an unbound reference to the result of applying the given function to the items in this stream.

Specified by:

bind in interface ExprStream<Long,Expression<Long>>

Specified by:

bind in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

bind in interface SearchStream<Long,Expression<Long>>

Type Parameters:

X2 - type of the bound value

S2 - criteria type of the bound value

Parameters:

ref - unbound reference

refFunction - function mapping this stream's Selection to the reference value

Returns:

new stream that binds ref

addRoot

<R> LongStream addRoot(Ref<R,? super Root<R>> ref,
 Class<R> type)

Description copied from interface: SearchStream

Bind an unbound reference to a new query root that will be added to the query.

To select the new root in a SearchStream, use SearchStream.map(), providing a Function that returns ref.

Note that this effectively creates an unconstrained (cross product) join with the new root. Typically there would be some additional restrictions imposed (e.g., via filter()) to relate the new root to the items in the stream.

Specified by:

addRoot in interface ExprStream<Long,Expression<Long>>

Specified by:

addRoot in interface SearchStream<Long,Expression<Long>>

Type Parameters:

R - type of the new query root

Parameters:

ref - unbound reference

type - type of the new query root

Returns:

new stream that binds ref to a new query root from type

filter

LongStream filter(Function<? super Expression<Long>,? extends Expression<Boolean>> predicateBuilder)

Description copied from interface: QueryStream

Filter results using the boolean expression produced by the given function.

Adds to any previously specified filters.

Specified by:

filter in interface ExprStream<Long,Expression<Long>>

Specified by:

filter in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

filter in interface SearchStream<Long,Expression<Long>>

Parameters:

predicateBuilder - function mapping this stream's item to a boolean Expression

Returns:

new filtered stream

limit

LongStream limit(int maxSize)

Description copied from interface: QueryStream

Return this stream truncated to the specified maximum length.

Due to limitations in the JPA Criteria API, this method is not supported on subquery streams and in general must be specified last (after any filtering, sorting, grouping, joins, etc.).

Specified by:

limit in interface ExprStream<Long,Expression<Long>>

Specified by:

limit in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

limit in interface SearchStream<Long,Expression<Long>>

Parameters:

maxSize - maximum number of elements to return

Returns:

new truncated stream

skip

LongStream skip(int num)

Description copied from interface: QueryStream

Return this stream with the specified number of initial elements skipped.

Due to limitations in the JPA Criteria API, this method is not supported on subquery streams and in general must be specified last (after any filtering, sorting, grouping, joins, etc.).

Specified by:

skip in interface ExprStream<Long,Expression<Long>>

Specified by:

skip in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

skip in interface SearchStream<Long,Expression<Long>>

Parameters:

num - number of elements to skip

Returns:

new elided stream

withFlushMode

LongStream withFlushMode(FlushModeType flushMode)

Description copied from interface: QueryStream

Set the FlushModeType associated with this query.

Specified by:

withFlushMode in interface ExprStream<Long,Expression<Long>>

Specified by:

withFlushMode in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

withFlushMode in interface SearchStream<Long,Expression<Long>>

Parameters:

flushMode - new flush mode

Returns:

new stream with the specified flush mode configured

See Also:

• Query.setFlushMode(jakarta.persistence.FlushModeType)

withLockMode

LongStream withLockMode(LockModeType lockMode)

Description copied from interface: QueryStream

Set the LockModeType associated with this query.

Specified by:

withLockMode in interface ExprStream<Long,Expression<Long>>

Specified by:

withLockMode in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

withLockMode in interface SearchStream<Long,Expression<Long>>

Parameters:

lockMode - new lock mode

Returns:

new stream with the specified lock mode configured

See Also:

• Query.setLockMode(jakarta.persistence.LockModeType)

withHint

LongStream withHint(String name,
 Object value)

Description copied from interface: QueryStream

Associate a hint with this query.

Specified by:

withHint in interface ExprStream<Long,Expression<Long>>

Specified by:

withHint in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

withHint in interface SearchStream<Long,Expression<Long>>

Parameters:

name - name of hint

value - value of hint

Returns:

new stream with the specified hint configured

See Also:

• Query.setHint(java.lang.String, java.lang.Object)

withHints

LongStream withHints(Map<String,Object> hints)

Description copied from interface: QueryStream

Associate hints with this query.

Specified by:

withHints in interface ExprStream<Long,Expression<Long>>

Specified by:

withHints in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

withHints in interface SearchStream<Long,Expression<Long>>

Parameters:

hints - hints to add

Returns:

new stream with the specified hints added

See Also:

• Query.setHint(java.lang.String, java.lang.Object)

withParam

<T> LongStream withParam(Parameter<T> parameter,
 T value)

Description copied from interface: QueryStream

Bind the value of a query parameter.

Replaces any previous binding of the same parameter.

Specified by:

withParam in interface ExprStream<Long,Expression<Long>>

Specified by:

withParam in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

withParam in interface SearchStream<Long,Expression<Long>>

Type Parameters:

T - parameter value type

Parameters:

parameter - the parameter to set

value - parameter value

Returns:

new stream with the specified parameter value set

See Also:

• Query.setParameter(Parameter, Object)

withParam

LongStream withParam(Parameter<Date> parameter,
 Date value,
 TemporalType temporalType)

Description copied from interface: QueryStream

Bind the value of a query parameter of type Date.

Replaces any previous binding of the same parameter.

Specified by:

withParam in interface ExprStream<Long,Expression<Long>>

Specified by:

withParam in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

withParam in interface SearchStream<Long,Expression<Long>>

Parameters:

parameter - the parameter to set

value - parameter value

temporalType - temporal type for value

Returns:

new stream with the specified parameter value set

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

withParam

LongStream withParam(Parameter<Calendar> parameter,
 Calendar value,
 TemporalType temporalType)

Description copied from interface: QueryStream

Bind the value of a query parameter of type Calendar.

Replaces any previous binding of the same parameter.

Specified by:

withParam in interface ExprStream<Long,Expression<Long>>

Specified by:

withParam in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

withParam in interface SearchStream<Long,Expression<Long>>

Parameters:

parameter - the parameter to set

value - parameter value

temporalType - temporal type for value

Returns:

new stream with the specified parameter value set

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

withParams

LongStream withParams(Iterable<? extends ParamBinding<?>> params)

Description copied from interface: QueryStream

Associate parameter bindings with this query.

Replaces any previous bindings of the same parameters.

Specified by:

withParams in interface ExprStream<Long,Expression<Long>>

Specified by:

withParams in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

withParams in interface SearchStream<Long,Expression<Long>>

Parameters:

params - bindings to add

Returns:

new stream with the specified parameter bindings added

See Also:

• Query.setParameter(Parameter, Object)

withLoadGraph

LongStream withLoadGraph(String name)

Description copied from interface: QueryStream

Configure a load graph for this query.

Equivalent to withHint("jakarta.persistence.loadgraph", name).

Specified by:

withLoadGraph in interface ExprStream<Long,Expression<Long>>

Specified by:

withLoadGraph in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

withLoadGraph in interface SearchStream<Long,Expression<Long>>

Parameters:

name - name of load graph

Returns:

new stream with the specified load graph configured

withFetchGraph

LongStream withFetchGraph(String name)

Description copied from interface: QueryStream

Configure a fetch graph for this query.

Equivalent to withHint("jakarta.persistence.fetchgraph", name).

Specified by:

withFetchGraph in interface ExprStream<Long,Expression<Long>>

Specified by:

withFetchGraph in interface QueryStream<Long,Expression<Long>,AbstractQuery<?>,CriteriaQuery<Long>,TypedQuery<Long>>

Specified by:

withFetchGraph in interface SearchStream<Long,Expression<Long>>

Parameters:

name - name of fetch graph

Returns:

new stream with the specified fetch graph configured