Package org.infinispan.query.clustered

Class DistributedIndexedQueryImpl<E>

java.lang.Object

org.infinispan.query.impl.IndexedQueryImpl<E>

org.infinispan.query.clustered.DistributedIndexedQueryImpl<E>

All Implemented Interfaces:

IndexedQuery<E>

public final class DistributedIndexedQueryImpl<E>
extends IndexedQueryImpl<E>

An extension of IndexedQueryImpl used for distributed queries.

Since:

5.1

Author:

Israel Lacerra <israeldl@gmail.com>

Field Summary

Fields inherited from class org.infinispan.query.impl.IndexedQueryImpl

cache, partitionHandlingSupport, queryDefinition, queryStatistics

Constructor Summary

Constructors

Constructor	Description
DistributedIndexedQueryImpl(QueryDefinition queryDefinition, org.infinispan.AdvancedCache<?,?> cache, org.infinispan.query.core.stats.impl.LocalQueryStatistics queryStatistics, int defaultMaxResults, Integer knn)

Method Summary

Modifier and Type	Method	Description
<K> ClosableIteratorWithCount<EntityEntry<K,E>>	entryIterator(boolean withMetadata)	Returns the matching entries (both key and value).
QueryResult<?>	execute()	Executes an Ickle statement returning results (query aka.
int	executeStatement()	Executes an Ickle statement not returning any results (ie.
IndexedQuery<E>	firstResult(int firstResult)	Sets the result of the given integer value to the first result.
int	getResultSize()
CloseableIterator<E>	iterator()
IndexedQuery<E>	maxResults(int maxResults)	Sets the maximum number of results to return from the query.
IndexedQuery<E>	timeout(long timeout, TimeUnit timeUnit)	Set the timeout for this query.

Methods inherited from class org.infinispan.query.impl.IndexedQueryImpl

aggregation, hitCountAccuracy, scoreRequired

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.query.impl.IndexedQuery

list

Constructor Details

DistributedIndexedQueryImpl

public DistributedIndexedQueryImpl(QueryDefinition queryDefinition,
 org.infinispan.AdvancedCache<?,?> cache,
 org.infinispan.query.core.stats.impl.LocalQueryStatistics queryStatistics,
 int defaultMaxResults,
 Integer knn)

Method Details

maxResults

public IndexedQuery<E> maxResults(int maxResults)

Description copied from interface: IndexedQuery

Sets the maximum number of results to return from the query. Used for pagination.

Specified by:

maxResults in interface IndexedQuery<E>

Overrides:

maxResults in class IndexedQueryImpl<E>

Parameters:

maxResults - the maximum number of results to return.

firstResult

public IndexedQuery<E> firstResult(int firstResult)

Description copied from class: IndexedQueryImpl

Sets the result of the given integer value to the first result.

Specified by:

firstResult in interface IndexedQuery<E>

Overrides:

firstResult in class IndexedQueryImpl<E>

Parameters:

firstResult - index to be set.

getResultSize

public int getResultSize()

Specified by:

getResultSize in interface IndexedQuery<E>

Overrides:

getResultSize in class IndexedQueryImpl<E>

Returns:

The result size of the query.

iterator

public CloseableIterator<E> iterator()
                              throws SearchException

Specified by:

iterator in interface IndexedQuery<E>

Overrides:

iterator in class IndexedQueryImpl<E>

Throws:

SearchException

entryIterator

public <K>
ClosableIteratorWithCount<EntityEntry<K,E>> entryIterator(boolean withMetadata)

Description copied from interface: IndexedQuery

Returns the matching entries (both key and value).

NOTE: The query must not contain any projections or an exception will be thrown.

Specified by:

entryIterator in interface IndexedQuery<E>

Overrides:

entryIterator in class IndexedQueryImpl<E>

execute

public QueryResult<?> execute()

Description copied from interface: IndexedQuery

Executes an Ickle statement returning results (query aka. SELECT). If the statement happens to be a DELETE it redirects it to IndexedQuery.executeStatement().

NOTE: Paging params (firstResult/maxResults) are honoured for SELECT and dissalowed for DELETE.

Specified by:

execute in interface IndexedQuery<E>

Overrides:

execute in class IndexedQueryImpl<E>

executeStatement

public int executeStatement()

Description copied from interface: IndexedQuery

Executes an Ickle statement not returning any results (ie. DELETE).

NOTE: Paging params (firstResult/maxResults) are NOT allowed.

Specified by:

executeStatement in interface IndexedQuery<E>

Overrides:

executeStatement in class IndexedQueryImpl<E>

Returns:

the number of affected entries

timeout

public IndexedQuery<E> timeout(long timeout,
 TimeUnit timeUnit)

Description copied from interface: IndexedQuery

Set the timeout for this query. If the query hasn't finished processing before the timeout, an exception will be thrown.

Specified by:

timeout in interface IndexedQuery<E>

Overrides:

timeout in class IndexedQueryImpl<E>

Parameters:

timeout - the timeout duration

timeUnit - the time unit of the timeout parameter