Package org.infinispan.query.dsl.impl

Class BaseQuery<T>

java.lang.Object

org.infinispan.query.dsl.impl.BaseQuery<T>

All Implemented Interfaces:

Iterable<T>, org.infinispan.commons.api.query.Query<T>, Query<T>

public abstract class BaseQuery<T>
extends Object
implements Query<T>

Since:

7.2

Author:

anistor@redhat.com

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	hitCountAccuracy
protected boolean	local
protected int	maxResults
protected Map<String,Object>	namedParameters
protected final String[]	projection
protected final QueryFactory	queryFactory
protected final String	queryString
protected boolean	scoreRequired
protected int	startOffset
protected long	timeout	Optional timeout in nanoseconds.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseQuery(QueryFactory queryFactory, String queryString)
protected	BaseQuery(QueryFactory queryFactory, String queryString, Map<String,Object> namedParameters, String[] projection, long startOffset, int maxResults, boolean local)

Method Summary

Modifier and Type	Method	Description
<K> org.infinispan.commons.api.query.ClosableIteratorWithCount<org.infinispan.commons.api.query.EntityEntry<K,T>>	entryIterator(boolean withMetadata)
int	executeStatement()
int	getMaxResults()
Map<String,Object>	getParameters()
String[]	getProjection()
String	getQueryString()	Returns the Ickle query string.
long	getStartOffset()
boolean	hasProjections()
Integer	hitCountAccuracy()
Query<T>	hitCountAccuracy(int hitCountAccuracy)
boolean	isLocal()
Query<T>	local(boolean local)
Query<T>	maxResults(int maxResults)
abstract void	resetQuery()	Reset internal state after pagination or query parameters are modified.
Query<T>	scoreRequired(boolean scoreRequired)
Query<T>	setParameter(String paramName, Object paramValue)
Query<T>	setParameters(Map<String,Object> paramValues)
Query<T>	startOffset(long startOffset)
Query<T>	timeout(long timeout, TimeUnit timeUnit)
void	validateNamedParameters()	Ensure all named parameters have non-null values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.infinispan.commons.api.query.Query

entryIterator, iterator, list

Methods inherited from interface org.infinispan.query.dsl.Query

execute, getResultSize

Field Details

queryFactory

protected final QueryFactory queryFactory

queryString

protected final String queryString

namedParameters

protected Map<String,Object> namedParameters

projection

protected final String[] projection

startOffset

protected int startOffset

maxResults

protected int maxResults

hitCountAccuracy

protected Integer hitCountAccuracy

local

protected boolean local

scoreRequired

protected boolean scoreRequired

timeout

protected long timeout

Optional timeout in nanoseconds.

Constructor Details

BaseQuery

protected BaseQuery(QueryFactory queryFactory,
 String queryString,
 Map<String,Object> namedParameters,
 String[] projection,
 long startOffset,
 int maxResults,
 boolean local)

BaseQuery

protected BaseQuery(QueryFactory queryFactory,
 String queryString)

Method Details

getQueryString

public String getQueryString()

Returns the Ickle query string.

Specified by:

getQueryString in interface org.infinispan.commons.api.query.Query<T>

Returns:

the Ickle query string

getParameters

public Map<String,Object> getParameters()

Specified by:

getParameters in interface org.infinispan.commons.api.query.Query<T>

setParameter

public Query<T> setParameter(String paramName,
 Object paramValue)

Specified by:

setParameter in interface org.infinispan.commons.api.query.Query<T>

Specified by:

setParameter in interface Query<T>

setParameters

public Query<T> setParameters(Map<String,Object> paramValues)

Specified by:

setParameters in interface org.infinispan.commons.api.query.Query<T>

Specified by:

setParameters in interface Query<T>

resetQuery

public abstract void resetQuery()

Reset internal state after pagination or query parameters are modified. This is needed to ensure the next execution of the query uses the new values.

validateNamedParameters

public void validateNamedParameters()

Ensure all named parameters have non-null values.

getProjection

public String[] getProjection()

Specified by:

getProjection in interface Query<T>

Returns:

the values for query projections or null if the query does not have projections.

hasProjections

public boolean hasProjections()

Specified by:

hasProjections in interface org.infinispan.commons.api.query.Query<T>

getStartOffset

public long getStartOffset()

Specified by:

getStartOffset in interface org.infinispan.commons.api.query.Query<T>

getMaxResults

public int getMaxResults()

Specified by:

getMaxResults in interface org.infinispan.commons.api.query.Query<T>

startOffset

public Query<T> startOffset(long startOffset)

Specified by:

startOffset in interface org.infinispan.commons.api.query.Query<T>

Specified by:

startOffset in interface Query<T>

maxResults

public Query<T> maxResults(int maxResults)

Specified by:

maxResults in interface org.infinispan.commons.api.query.Query<T>

Specified by:

maxResults in interface Query<T>

hitCountAccuracy

public Integer hitCountAccuracy()

Specified by:

hitCountAccuracy in interface org.infinispan.commons.api.query.Query<T>

hitCountAccuracy

public Query<T> hitCountAccuracy(int hitCountAccuracy)

Specified by:

hitCountAccuracy in interface org.infinispan.commons.api.query.Query<T>

Specified by:

hitCountAccuracy in interface Query<T>

local

public Query<T> local(boolean local)

Specified by:

local in interface org.infinispan.commons.api.query.Query<T>

isLocal

public boolean isLocal()

scoreRequired

public Query<T> scoreRequired(boolean scoreRequired)

Specified by:

scoreRequired in interface org.infinispan.commons.api.query.Query<T>

timeout

public Query<T> timeout(long timeout,
 TimeUnit timeUnit)

Specified by:

timeout in interface org.infinispan.commons.api.query.Query<T>

Specified by:

timeout in interface Query<T>

entryIterator

public <K>
org.infinispan.commons.api.query.ClosableIteratorWithCount<org.infinispan.commons.api.query.EntityEntry<K,T>> entryIterator(boolean withMetadata)

Specified by:

entryIterator in interface org.infinispan.commons.api.query.Query<T>

executeStatement

public int executeStatement()

Specified by:

executeStatement in interface org.infinispan.commons.api.query.Query<T>