Package org.dellroad.querystream.jpa

Interface RootValue<X>

All Superinterfaces:

ExprStream<X,Root<X>>, ExprValue<X,Root<X>>, FromStream<X,Root<X>>, FromValue<X,Root<X>>, PathStream<X,Root<X>>, PathValue<X,Root<X>>, QueryConfigurer<AbstractQuery<?>,X,Root<X>>, QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>, RootStream<X>, SearchStream<X,Root<X>>, SearchValue<X,Root<X>>

public interface RootValue<X>
extends FromValue<X,Root<X>>, RootStream<X>

A RootStream that is guaranteed to return at most a single result.

Nested Class Summary

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

QueryStream.Builder

Method Summary

Modifier and Type	Method	Description
RootValue<X>	bind(Ref<X,? super Root<X>> ref)	Bind an unbound reference to the items in this stream.
<X2, S2 extends Selection<X2>> RootValue<X>	bind(Ref<X2,? super S2> ref, Function<? super Root<X>,? extends S2> refFunction)	Bind an unbound reference to the result of applying the given function to the items in this stream.
RootValue<X>	filter(SingularAttribute<? super X,Boolean> attribute)	Filter results using the specified boolean property.
RootValue<X>	filter(Function<? super Root<X>,? extends Expression<Boolean>> predicateBuilder)	Filter results using the boolean expression produced by the given function.
RootValue<X>	peek(Consumer<? super Root<X>> peeker)	Peek at the items in this stream.
RootValue<X>	withFetchGraph(String name)	Configure a fetch graph for this query.
RootValue<X>	withFlushMode(FlushModeType flushMode)	Set the FlushModeType associated with this query.
RootValue<X>	withHint(String name, Object value)	Associate a hint with this query.
RootValue<X>	withHints(Map<String,Object> hints)	Associate hints with this query.
RootValue<X>	withLoadGraph(String name)	Configure a load graph for this query.
RootValue<X>	withLockMode(LockModeType lockMode)	Set the LockModeType associated with this query.
RootValue<X>	withParam(Parameter<Calendar> parameter, Calendar value, TemporalType temporalType)	Bind the value of a query parameter of type Calendar.
RootValue<X>	withParam(Parameter<Date> parameter, Date value, TemporalType temporalType)	Bind the value of a query parameter of type Date.
<T> RootValue<X>	withParam(Parameter<T> parameter, T value)	Bind the value of a query parameter.
RootValue<X>	withParams(Iterable<? extends ParamBinding<?>> params)	Associate parameter bindings with this query.

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

asSubquery, count, countDistinct, exists

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

map, map, map, map, mapToDouble, mapToDouble, mapToExpr, mapToFrom, mapToInt, mapToInt, mapToLong, mapToLong, mapToPath

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

join, join, join

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.RootStream

addRoot, cast, distinct, fetch, fetch, fetch, fetch, findAny, findFirst, findSingle, groupBy, groupBy, groupBy, groupByMulti, having, limit, orderBy, orderBy, orderBy, orderBy, orderBy, orderBy, orderByMulti, skip, thenOrderBy, thenOrderBy, thenOrderBy, thenOrderBy

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, mapToRef, mapToRef, mapToRef, mapToRef, mapToRoot, noneMatch, noneMatch

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

ifPresent, isPresent, mapToSelection, orElse, orElseGet, orElseThrow, toOptional, value

Method Details

bind

RootValue<X> bind(Ref<X,? super Root<X>> ref)

Description copied from interface: QueryStream

Bind an unbound reference to the items in this stream.

Specified by:

bind in interface ExprStream<X,Root<X>>

Specified by:

bind in interface ExprValue<X,Root<X>>

Specified by:

bind in interface FromStream<X,Root<X>>

Specified by:

bind in interface FromValue<X,Root<X>>

Specified by:

bind in interface PathStream<X,Root<X>>

Specified by:

bind in interface PathValue<X,Root<X>>

Specified by:

bind in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

bind in interface RootStream<X>

Specified by:

bind in interface SearchStream<X,Root<X>>

Specified by:

bind in interface SearchValue<X,Root<X>>

Parameters:

ref - unbound reference

Returns:

new stream that binds ref

peek

RootValue<X> peek(Consumer<? super Root<X>> 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<X,Root<X>>

Specified by:

peek in interface ExprValue<X,Root<X>>

Specified by:

peek in interface FromStream<X,Root<X>>

Specified by:

peek in interface FromValue<X,Root<X>>

Specified by:

peek in interface PathStream<X,Root<X>>

Specified by:

peek in interface PathValue<X,Root<X>>

Specified by:

peek in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

peek in interface RootStream<X>

Specified by:

peek in interface SearchStream<X,Root<X>>

Specified by:

peek in interface SearchValue<X,Root<X>>

Parameters:

peeker - peeker into stream

Returns:

new stream that peeks into this stream

bind

<X2,
S2 extends Selection<X2>> RootValue<X> bind(Ref<X2,? super S2> ref,
 Function<? super Root<X>,? 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<X,Root<X>>

Specified by:

bind in interface ExprValue<X,Root<X>>

Specified by:

bind in interface FromStream<X,Root<X>>

Specified by:

bind in interface FromValue<X,Root<X>>

Specified by:

bind in interface PathStream<X,Root<X>>

Specified by:

bind in interface PathValue<X,Root<X>>

Specified by:

bind in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

bind in interface RootStream<X>

Specified by:

bind in interface SearchStream<X,Root<X>>

Specified by:

bind in interface SearchValue<X,Root<X>>

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

filter

RootValue<X> filter(SingularAttribute<? super X,Boolean> attribute)

Description copied from interface: QueryStream

Filter results using the specified boolean property.

Adds to any previously specified filters.

Specified by:

filter in interface ExprStream<X,Root<X>>

Specified by:

filter in interface ExprValue<X,Root<X>>

Specified by:

filter in interface FromStream<X,Root<X>>

Specified by:

filter in interface FromValue<X,Root<X>>

Specified by:

filter in interface PathStream<X,Root<X>>

Specified by:

filter in interface PathValue<X,Root<X>>

Specified by:

filter in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

filter in interface RootStream<X>

Specified by:

filter in interface SearchStream<X,Root<X>>

Specified by:

filter in interface SearchValue<X,Root<X>>

Parameters:

attribute - boolean property

Returns:

new filtered stream

filter

RootValue<X> filter(Function<? super Root<X>,? 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<X,Root<X>>

Specified by:

filter in interface ExprValue<X,Root<X>>

Specified by:

filter in interface FromStream<X,Root<X>>

Specified by:

filter in interface FromValue<X,Root<X>>

Specified by:

filter in interface PathStream<X,Root<X>>

Specified by:

filter in interface PathValue<X,Root<X>>

Specified by:

filter in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

filter in interface RootStream<X>

Specified by:

filter in interface SearchStream<X,Root<X>>

Specified by:

filter in interface SearchValue<X,Root<X>>

Parameters:

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

Returns:

new filtered stream

withFlushMode

RootValue<X> withFlushMode(FlushModeType flushMode)

Description copied from interface: QueryStream

Set the FlushModeType associated with this query.

Specified by:

withFlushMode in interface ExprStream<X,Root<X>>

Specified by:

withFlushMode in interface ExprValue<X,Root<X>>

Specified by:

withFlushMode in interface FromStream<X,Root<X>>

Specified by:

withFlushMode in interface FromValue<X,Root<X>>

Specified by:

withFlushMode in interface PathStream<X,Root<X>>

Specified by:

withFlushMode in interface PathValue<X,Root<X>>

Specified by:

withFlushMode in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

withFlushMode in interface RootStream<X>

Specified by:

withFlushMode in interface SearchStream<X,Root<X>>

Specified by:

withFlushMode in interface SearchValue<X,Root<X>>

Parameters:

flushMode - new flush mode

Returns:

new stream with the specified flush mode configured

See Also:

• Query.setFlushMode(jakarta.persistence.FlushModeType)

withLockMode

RootValue<X> withLockMode(LockModeType lockMode)

Description copied from interface: QueryStream

Set the LockModeType associated with this query.

Specified by:

withLockMode in interface ExprStream<X,Root<X>>

Specified by:

withLockMode in interface ExprValue<X,Root<X>>

Specified by:

withLockMode in interface FromStream<X,Root<X>>

Specified by:

withLockMode in interface FromValue<X,Root<X>>

Specified by:

withLockMode in interface PathStream<X,Root<X>>

Specified by:

withLockMode in interface PathValue<X,Root<X>>

Specified by:

withLockMode in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

withLockMode in interface RootStream<X>

Specified by:

withLockMode in interface SearchStream<X,Root<X>>

Specified by:

withLockMode in interface SearchValue<X,Root<X>>

Parameters:

lockMode - new lock mode

Returns:

new stream with the specified lock mode configured

See Also:

• Query.setLockMode(jakarta.persistence.LockModeType)

withHint

RootValue<X> withHint(String name,
 Object value)

Description copied from interface: QueryStream

Associate a hint with this query.

Specified by:

withHint in interface ExprStream<X,Root<X>>

Specified by:

withHint in interface ExprValue<X,Root<X>>

Specified by:

withHint in interface FromStream<X,Root<X>>

Specified by:

withHint in interface FromValue<X,Root<X>>

Specified by:

withHint in interface PathStream<X,Root<X>>

Specified by:

withHint in interface PathValue<X,Root<X>>

Specified by:

withHint in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

withHint in interface RootStream<X>

Specified by:

withHint in interface SearchStream<X,Root<X>>

Specified by:

withHint in interface SearchValue<X,Root<X>>

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

RootValue<X> withHints(Map<String,Object> hints)

Description copied from interface: QueryStream

Associate hints with this query.

Specified by:

withHints in interface ExprStream<X,Root<X>>

Specified by:

withHints in interface ExprValue<X,Root<X>>

Specified by:

withHints in interface FromStream<X,Root<X>>

Specified by:

withHints in interface FromValue<X,Root<X>>

Specified by:

withHints in interface PathStream<X,Root<X>>

Specified by:

withHints in interface PathValue<X,Root<X>>

Specified by:

withHints in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

withHints in interface RootStream<X>

Specified by:

withHints in interface SearchStream<X,Root<X>>

Specified by:

withHints in interface SearchValue<X,Root<X>>

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> RootValue<X> 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<X,Root<X>>

Specified by:

withParam in interface ExprValue<X,Root<X>>

Specified by:

withParam in interface FromStream<X,Root<X>>

Specified by:

withParam in interface FromValue<X,Root<X>>

Specified by:

withParam in interface PathStream<X,Root<X>>

Specified by:

withParam in interface PathValue<X,Root<X>>

Specified by:

withParam in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

withParam in interface RootStream<X>

Specified by:

withParam in interface SearchStream<X,Root<X>>

Specified by:

withParam in interface SearchValue<X,Root<X>>

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

RootValue<X> 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<X,Root<X>>

Specified by:

withParam in interface ExprValue<X,Root<X>>

Specified by:

withParam in interface FromStream<X,Root<X>>

Specified by:

withParam in interface FromValue<X,Root<X>>

Specified by:

withParam in interface PathStream<X,Root<X>>

Specified by:

withParam in interface PathValue<X,Root<X>>

Specified by:

withParam in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

withParam in interface RootStream<X>

Specified by:

withParam in interface SearchStream<X,Root<X>>

Specified by:

withParam in interface SearchValue<X,Root<X>>

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

RootValue<X> 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<X,Root<X>>

Specified by:

withParam in interface ExprValue<X,Root<X>>

Specified by:

withParam in interface FromStream<X,Root<X>>

Specified by:

withParam in interface FromValue<X,Root<X>>

Specified by:

withParam in interface PathStream<X,Root<X>>

Specified by:

withParam in interface PathValue<X,Root<X>>

Specified by:

withParam in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

withParam in interface RootStream<X>

Specified by:

withParam in interface SearchStream<X,Root<X>>

Specified by:

withParam in interface SearchValue<X,Root<X>>

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

RootValue<X> 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<X,Root<X>>

Specified by:

withParams in interface ExprValue<X,Root<X>>

Specified by:

withParams in interface FromStream<X,Root<X>>

Specified by:

withParams in interface FromValue<X,Root<X>>

Specified by:

withParams in interface PathStream<X,Root<X>>

Specified by:

withParams in interface PathValue<X,Root<X>>

Specified by:

withParams in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

withParams in interface RootStream<X>

Specified by:

withParams in interface SearchStream<X,Root<X>>

Specified by:

withParams in interface SearchValue<X,Root<X>>

Parameters:

params - bindings to add

Returns:

new stream with the specified parameter bindings added

See Also:

• Query.setParameter(Parameter, Object)

withLoadGraph

RootValue<X> 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<X,Root<X>>

Specified by:

withLoadGraph in interface ExprValue<X,Root<X>>

Specified by:

withLoadGraph in interface FromStream<X,Root<X>>

Specified by:

withLoadGraph in interface FromValue<X,Root<X>>

Specified by:

withLoadGraph in interface PathStream<X,Root<X>>

Specified by:

withLoadGraph in interface PathValue<X,Root<X>>

Specified by:

withLoadGraph in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

withLoadGraph in interface RootStream<X>

Specified by:

withLoadGraph in interface SearchStream<X,Root<X>>

Specified by:

withLoadGraph in interface SearchValue<X,Root<X>>

Parameters:

name - name of load graph

Returns:

new stream with the specified load graph configured

withFetchGraph

RootValue<X> 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<X,Root<X>>

Specified by:

withFetchGraph in interface ExprValue<X,Root<X>>

Specified by:

withFetchGraph in interface FromStream<X,Root<X>>

Specified by:

withFetchGraph in interface FromValue<X,Root<X>>

Specified by:

withFetchGraph in interface PathStream<X,Root<X>>

Specified by:

withFetchGraph in interface PathValue<X,Root<X>>

Specified by:

withFetchGraph in interface QueryStream<X,Root<X>,AbstractQuery<?>,CriteriaQuery<X>,TypedQuery<X>>

Specified by:

withFetchGraph in interface RootStream<X>

Specified by:

withFetchGraph in interface SearchStream<X,Root<X>>

Specified by:

withFetchGraph in interface SearchValue<X,Root<X>>

Parameters:

name - name of fetch graph

Returns:

new stream with the specified fetch graph configured