au.com.cybersearch2.classyjpa.query

Class QueryBase

java.lang.Object

au.com.cybersearch2.classyjpa.query.QueryBase

All Implemented Interfaces:

javax.persistence.Query

Direct Known Subclasses:

EntityQuery, NativeQuery

public abstract class QueryBase
extends Object
implements javax.persistence.Query

QueryBase Abstract implementation of javax.persistence.Query for both OrmLite and native queries

Author:

Andrew Bowley 08/07/2014

Constructor Summary

Constructors

Constructor and Description
QueryBase()

Method Summary

Methods

Modifier and Type	Method and Description
int	getFirstResult() The position of the first result the query object was set to retrieve.
javax.persistence.FlushModeType	getFlushMode() Get the flush mode in effect for the query execution.
Map<String,Object>	getHints() Get the properties and hints and associated values that are in effect for the query instance not supported
javax.persistence.LockModeType	getLockMode() Get the current lock mode for the query not supported.
int	getMaxResults() The maximum number of results the query object was set to retrieve.
javax.persistence.Parameter<?>	getParameter(int position) Get the parameter object corresponding to the declared positional parameter with the given position not supported
<X> javax.persistence.Parameter<X>	getParameter(int position, Class<X> type) Get the parameter object corresponding to the declared positional parameter with the given position and type not supported
javax.persistence.Parameter<?>	getParameter(String name) Get the parameter object corresponding to the declared parameter of the given name not supported
<X> javax.persistence.Parameter<X>	getParameter(String name, Class<X> type) Get the parameter object corresponding to the declared parameter of the given name and type not supported
Set<javax.persistence.Parameter<?>>	getParameters() Get the parameter objects corresponding to the declared parameters of the query not supported
Object	getParameterValue(int position) Return the input value bound to the positional parameter not supported
<X> X	getParameterValue(javax.persistence.Parameter<X> param) Return the input value bound to the parameter not supported
Object	getParameterValue(String param) Return the input value bound to the named parameter not supported
boolean	isBound(javax.persistence.Parameter<?> param) Return a boolean indicating whether a value has been bound to the parameter not supported
javax.persistence.Query	setFirstResult(int startPosition) Set the position of the first result to retrieve.
javax.persistence.Query	setFlushMode(javax.persistence.FlushModeType type) Set the flush mode type to be used for the query execution not supported.
javax.persistence.Query	setHint(String hintName, Object value) Set an implementation-specific hint not supported
javax.persistence.Query	setLockMode(javax.persistence.LockModeType lockMode) Set the lock mode type to be used for the query execution not supported
javax.persistence.Query	setMaxResults(int maxResults) Set the maximum number of results to retrieve.
javax.persistence.Query	setParameter(javax.persistence.Parameter<Calendar> param, Calendar value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Calendar to a Parameter object not supported
javax.persistence.Query	setParameter(javax.persistence.Parameter<Date> param, Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a Parameter object not supported
<X> javax.persistence.Query	setParameter(javax.persistence.Parameter<X> param, X value) Bind the value of a Parameter object not supported
<X> X	unwrap(Class<X> cls) Return an object of the specified type to allow access to the provider-specific API.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.persistence.Query

executeUpdate, getResultList, getSingleResult, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter

Constructor Detail

QueryBase

public QueryBase()

Method Detail

setMaxResults

public javax.persistence.Query setMaxResults(int maxResults)

Set the maximum number of results to retrieve.

Specified by:

setMaxResults in interface javax.persistence.Query

Parameters:

maxResults - Maximum number of objects to return, 0 means unlimited

Returns:

The same query instance

Throws:

IllegalArgumentException - if argument is negative

setFirstResult

public javax.persistence.Query setFirstResult(int startPosition)

Set the position of the first result to retrieve.

Specified by:

setFirstResult in interface javax.persistence.Query

Parameters:

startPosition - The start position of the first result, numbered from 0

Returns:

The same query instance

Throws:

IllegalArgumentException - if argument is negative

setFlushMode

public javax.persistence.Query setFlushMode(javax.persistence.FlushModeType type)

Set the flush mode type to be used for the query execution not supported.

Specified by:

setFlushMode in interface javax.persistence.Query

Parameters:

type - Not used

Returns:

The same query instance

setHint

public javax.persistence.Query setHint(String hintName,
                              Object value)

Set an implementation-specific hint not supported

Specified by:

setHint in interface javax.persistence.Query

Parameters:

hintName -

value -

Returns:

The same query instance

getFirstResult

public int getFirstResult()

The position of the first result the query object was set to retrieve. Returns 0 if setFirstResult was not applied to the query object.

Specified by:

getFirstResult in interface javax.persistence.Query

Returns:

position of the first result

getFlushMode

public javax.persistence.FlushModeType getFlushMode()

Get the flush mode in effect for the query execution. Always returns the flush mode in effect for the entity manager.

Specified by:

getFlushMode in interface javax.persistence.Query

Returns:

flush mode

getHints

public Map<String,Object> getHints()

Get the properties and hints and associated values that are in effect for the query instance not supported

Specified by:

getHints in interface javax.persistence.Query

Returns:

empty map

getLockMode

public javax.persistence.LockModeType getLockMode()

Get the current lock mode for the query not supported.

Specified by:

getLockMode in interface javax.persistence.Query

getMaxResults

public int getMaxResults()

The maximum number of results the query object was set to retrieve. Returns Integer.MAX_VALUE if setMaxResults was not applied to the query object.

Specified by:

getMaxResults in interface javax.persistence.Query

Returns:

maximum number of results

getParameter

public javax.persistence.Parameter<?> getParameter(int position)

Get the parameter object corresponding to the declared positional parameter with the given position not supported

Specified by:

getParameter in interface javax.persistence.Query

Parameters:

position -

getParameter

public javax.persistence.Parameter<?> getParameter(String name)

Get the parameter object corresponding to the declared parameter of the given name not supported

Specified by:

getParameter in interface javax.persistence.Query

Parameters:

name -

getParameter

public <X> javax.persistence.Parameter<X> getParameter(int position,
                                              Class<X> type)

Get the parameter object corresponding to the declared positional parameter with the given position and type not supported

Specified by:

getParameter in interface javax.persistence.Query

Parameters:

position -

type -

getParameter

public <X> javax.persistence.Parameter<X> getParameter(String name,
                                              Class<X> type)

Get the parameter object corresponding to the declared parameter of the given name and type not supported

Specified by:

getParameter in interface javax.persistence.Query

Parameters:

name -

type -

getParameterValue

public Object getParameterValue(int position)

Return the input value bound to the positional parameter not supported

Specified by:

getParameterValue in interface javax.persistence.Query

Parameters:

position -

getParameterValue

public <X> X getParameterValue(javax.persistence.Parameter<X> param)

Return the input value bound to the parameter not supported

Specified by:

getParameterValue in interface javax.persistence.Query

Parameters:

param -

getParameterValue

public Object getParameterValue(String param)

Return the input value bound to the named parameter not supported

Specified by:

getParameterValue in interface javax.persistence.Query

Parameters:

param -

getParameters

public Set<javax.persistence.Parameter<?>> getParameters()

Get the parameter objects corresponding to the declared parameters of the query not supported

Specified by:

getParameters in interface javax.persistence.Query

isBound

public boolean isBound(javax.persistence.Parameter<?> param)

Return a boolean indicating whether a value has been bound to the parameter not supported

Specified by:

isBound in interface javax.persistence.Query

Parameters:

param -

setLockMode

public javax.persistence.Query setLockMode(javax.persistence.LockModeType lockMode)

Set the lock mode type to be used for the query execution not supported

Specified by:

setLockMode in interface javax.persistence.Query

Parameters:

lockMode -

setParameter

public <X> javax.persistence.Query setParameter(javax.persistence.Parameter<X> param,
                                       X value)

Bind the value of a Parameter object not supported

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

param -

value -

setParameter

public javax.persistence.Query setParameter(javax.persistence.Parameter<Calendar> param,
                                   Calendar value,
                                   javax.persistence.TemporalType temporalType)

Bind an instance of java.util.Calendar to a Parameter object not supported

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

param -

value -

temporalType -

setParameter

public javax.persistence.Query setParameter(javax.persistence.Parameter<Date> param,
                                   Date value,
                                   javax.persistence.TemporalType temporalType)

Bind an instance of java.util.Date to a Parameter object not supported

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

param -

value -

temporalType -

unwrap

public <X> X unwrap(Class<X> cls)

Return an object of the specified type to allow access to the provider-specific API. If the provider's query implementation does not support the specified class, the PersistenceException is thrown.

Specified by:

unwrap in interface javax.persistence.Query

Parameters:

cls - the class of the object to be returned. This is normally either the underlying query implementation class or an interface that it implements.

Returns:

an instance of the specified class

Throws:

javax.persistence.PersistenceException - if the provider does not support the call