StageQueryImpl (Hibernate Reactive Core 1.0.0.Alpha10 API)

java.lang.Object
- org.hibernate.reactive.stage.impl.StageQueryImpl<R>

All Implemented Interfaces:: Stage.Query<R>

public class StageQueryImpl<R>
extends Object
implements Stage.Query<R>

Implementation of Stage.Query.

Constructor Summary
Constructors
Constructor and Description
StageQueryImpl(ReactiveQuery<R> delegate)

Constructors
Constructor and Description
`StageQueryImpl(ReactiveQuery<R> delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletionStage<Integer>`	`executeUpdate()` Asynchronously execute this delete, update, or insert query, returning the updated row count.
`CacheMode`	`getCacheMode()` Obtain the `CacheMode` in effect for this query.
`String`	`getCacheRegion()`
`int`	`getFirstResult()`
`FlushMode`	`getFlushMode()` Obtain the `FlushMode` in effect for this query.
`int`	`getMaxResults()`
`CompletionStage<List<R>>`	`getResultList()` Asynchronously execute this query, returning the query results as a `List`, via a `CompletionStage`.
`CompletionStage<R>`	`getSingleResult()` Asynchronously Execute this query, returning a single row that matches the query, or `null` if the query returns no results, throwing an exception if the query returns more than one matching row.
`boolean`	`isCacheable()`
`boolean`	`isReadOnly()`
`Stage.Query<R>`	`setCacheable(boolean cacheable)` Enable or disable caching of this query result set in the second-level query cache.
`Stage.Query<R>`	`setCacheMode(CacheMode cacheMode)` Set the current `CacheMode` in effect while this query is being executed.
`Stage.Query<R>`	`setCacheRegion(String cacheRegion)` Set the name of the cache region in which to store this query result set if `caching is enabled`.
`Stage.Query<R>`	`setComment(String comment)` Set the comment for this query.
`Stage.Query<R>`	`setFirstResult(int firstResult)` Set the position of the first result that may be returned by this query when executed, where the results are numbered from 0.
`Stage.Query<R>`	`setFlushMode(FlushMode flushMode)` Set the current `FlushMode` in effect while this query is being executed.
`Stage.Query<R>`	`setLockMode(LockMode lockMode)` Set the `LockMode` to use for the whole query.
`Stage.Query<R>`	`setLockMode(String alias, LockMode lockMode)` Set the `LockMode` to use for specified alias (as defined in the query's `from` clause).
`Stage.Query<R>`	`setLockOptions(LockOptions lockOptions)`
`Stage.Query<R>`	`setMaxResults(int maxResults)` Set the maximum number of results that may be returned by this query when executed.
`<T> Stage.Query<R>`	`setParameter(<any> parameter, T value)` Set the value of a typed parameter.
`Stage.Query<R>`	`setParameter(int position, Object value)` Set the value of a positional parameter.
`Stage.Query<R>`	`setParameter(String name, Object value)` Set the value of a named parameter.
`Stage.Query<R>`	`setReadOnly(boolean readOnly)` Set the read-only/modifiable mode for entities and proxies loaded by this Query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StageQueryImpl
```
public StageQueryImpl(ReactiveQuery<R> delegate)
```
- Method Detail
  - setParameter
```
public Stage.Query<R> setParameter(int position,
                                   Object value)
```
    Description copied from interface: Stage.Query
    Set the value of a positional parameter. Positional parameters are numbered from 1, and are specified in the query using placeholder tokens of form ?1, ?2, etc.
    Specified by:
    setParameter in interface Stage.Query<R>
  - setParameter
```
public Stage.Query<R> setParameter(String name,
                                   Object value)
```
    Description copied from interface: Stage.Query
    Set the value of a named parameter. Named parameters are specified in the query using placeholder tokens of form :name.
    Specified by:
    setParameter in interface Stage.Query<R>
  - setParameter
```
public <T> Stage.Query<R> setParameter(<any> parameter,
                                       T value)
```
    Description copied from interface: Stage.Query
    Set the value of a typed parameter. Typed parameters are obtained from the JPA CriteriaBuilder, which may itself be obtained by calling Stage.SessionFactory.getCriteriaBuilder().
    Specified by:
    setParameter in interface Stage.Query<R>
    See Also:
    CriteriaBuilder#parameter(Class)
  - setMaxResults
```
public Stage.Query<R> setMaxResults(int maxResults)
```
    Description copied from interface: Stage.Query
    Set the maximum number of results that may be returned by this query when executed.
    Specified by:
    setMaxResults in interface Stage.Query<R>
  - getMaxResults
```
public int getMaxResults()
```
    Specified by:
    getMaxResults in interface Stage.Query<R>
    Returns:
    the maximum number results, or Integer.MAX_VALUE if not set
  - setFirstResult
```
public Stage.Query<R> setFirstResult(int firstResult)
```
    Description copied from interface: Stage.Query
    Set the position of the first result that may be returned by this query when executed, where the results are numbered from 0.
    Specified by:
    setFirstResult in interface Stage.Query<R>
  - getFirstResult
```
public int getFirstResult()
```
    Specified by:
    getFirstResult in interface Stage.Query<R>
    Returns:
    the first result, or 0 if not set
  - setReadOnly
```
public Stage.Query<R> setReadOnly(boolean readOnly)
```
    Description copied from interface: Stage.Query
    Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context.
    Specified by:
    setReadOnly in interface Stage.Query<R>
    See Also:
    Stage.Session.setDefaultReadOnly(boolean)
  - isReadOnly
```
public boolean isReadOnly()
```
    Specified by:
    isReadOnly in interface Stage.Query<R>
    Returns:
    the read-only/modifiable mode
    See Also:
    Stage.Session.isDefaultReadOnly()
  - setComment
```
public Stage.Query<R> setComment(String comment)
```
    Description copied from interface: Stage.Query
    Set the comment for this query. This comment will be prepended to the SQL query sent to the database.
    Specified by:
    setComment in interface Stage.Query<R>
    Parameters:
    comment - The human-readable comment
  - setCacheable
```
public Stage.Query<R> setCacheable(boolean cacheable)
```
    Description copied from interface: Stage.Query
    Enable or disable caching of this query result set in the second-level query cache.
    Specified by:
    setCacheable in interface Stage.Query<R>
    Parameters:
    cacheable - true if this query is cacheable
  - isCacheable
```
public boolean isCacheable()
```
    Specified by:
    isCacheable in interface Stage.Query<R>
    Returns:
    true if this query is cacheable
    See Also:
    Stage.Query.setCacheable(boolean)
  - setCacheRegion
```
public Stage.Query<R> setCacheRegion(String cacheRegion)
```
    Description copied from interface: Stage.Query
    Set the name of the cache region in which to store this query result set if caching is enabled.
    Specified by:
    setCacheRegion in interface Stage.Query<R>
    Parameters:
    cacheRegion - the name of the cache region
  - getCacheRegion
```
public String getCacheRegion()
```
    Specified by:
    getCacheRegion in interface Stage.Query<R>
    Returns:
    the name of the cache region
    See Also:
    Stage.Query.setCacheRegion(String)
  - setLockMode
```
public Stage.Query<R> setLockMode(LockMode lockMode)
```
    Description copied from interface: Stage.Query
    Set the LockMode to use for the whole query.
    Specified by:
    setLockMode in interface Stage.Query<R>
  - setLockOptions
```
public Stage.Query<R> setLockOptions(LockOptions lockOptions)
```
  - setLockMode
```
public Stage.Query<R> setLockMode(String alias,
                                  LockMode lockMode)
```
    Description copied from interface: Stage.Query
    Set the LockMode to use for specified alias (as defined in the query's from clause).
    Specified by:
    setLockMode in interface Stage.Query<R>
    Parameters:
    alias - the from clause alias
    lockMode - the requested LockMode
    See Also:
    org.hibernate.query.Query#setLockMode(String,LockMode)
  - setCacheMode
```
public Stage.Query<R> setCacheMode(CacheMode cacheMode)
```
    Description copied from interface: Stage.Query
    Set the current CacheMode in effect while this query is being executed.
    Specified by:
    setCacheMode in interface Stage.Query<R>
  - getCacheMode
```
public CacheMode getCacheMode()
```
    Description copied from interface: Stage.Query
    Obtain the CacheMode in effect for this query. By default, the query inherits the CacheMode of the Stage.Session from which is originates.
    Specified by:
    getCacheMode in interface Stage.Query<R>
    See Also:
    Stage.Session.getCacheMode()
  - setFlushMode
```
public Stage.Query<R> setFlushMode(FlushMode flushMode)
```
    Description copied from interface: Stage.Query
    Set the current FlushMode in effect while this query is being executed.
    Specified by:
    setFlushMode in interface Stage.Query<R>
  - getFlushMode
```
public FlushMode getFlushMode()
```
    Description copied from interface: Stage.Query
    Obtain the FlushMode in effect for this query. By default, the query inherits the FlushMode of the Stage.Session from which is originates.
    Specified by:
    getFlushMode in interface Stage.Query<R>
    See Also:
    Stage.Session.getFlushMode()
  - executeUpdate
```
public CompletionStage<Integer> executeUpdate()
```
    Description copied from interface: Stage.Query
    Asynchronously execute this delete, update, or insert query, returning the updated row count.
    Specified by:
    executeUpdate in interface Stage.Query<R>
    Returns:
    the row count as an integer
    See Also:
    javax.persistence.Query#executeUpdate()
  - getSingleResult
```
public CompletionStage<R> getSingleResult()
```
    Description copied from interface: Stage.Query
    Asynchronously Execute this query, returning a single row that matches the query, or null if the query returns no results, throwing an exception if the query returns more than one matching row. If the query has multiple results per row, the results are returned in an instance of Object[].
    Specified by:
    getSingleResult in interface Stage.Query<R>
    Returns:
    the single resulting row or null
    See Also:
    javax.persistence.Query#getSingleResult()
  - getResultList
```
public CompletionStage<List<R>> getResultList()
```
    Description copied from interface: Stage.Query
    Asynchronously execute this query, returning the query results as a List, via a CompletionStage. If the query has multiple results per row, the results are returned in an instance of Object[].
    Specified by:
    getResultList in interface Stage.Query<R>
    Returns:
    the resulting rows as a List
    See Also:
    javax.persistence.Query#getResultList()

Class StageQueryImpl<R>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StageQueryImpl

Method Detail

setParameter

setParameter

setParameter

setMaxResults

getMaxResults

setFirstResult

getFirstResult

setReadOnly

isReadOnly

setComment

setCacheable

isCacheable

setCacheRegion

getCacheRegion

setLockMode

setLockOptions

setLockMode

setCacheMode

getCacheMode

setFlushMode

getFlushMode

executeUpdate

getSingleResult

getResultList