org.infinispan.query.dsl.embedded

Interface LuceneQuery

All Superinterfaces:

Iterable, Query

public interface LuceneQuery
extends Query, Iterable

A Query kind that offers iteration and lazy/eager loading options. This is currently only available in embedded mode.

Since:

6.0

Author:

anistor@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
ResultIterator	iterator() Returns the results of a search as a ResultIterator.
ResultIterator	iterator(FetchOptions fetchOptions) Returns the results of a search as a ResultIterator.

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

getResultSize, list

Method Detail

iterator

ResultIterator iterator(FetchOptions fetchOptions)

Returns the results of a search as a ResultIterator.

Warning: the return type is an extension of Iterator which introduces a ResultIterator.close() method. This close method needs to be invoked when the iteration is complete to avoid resource leakage.

Parameters:

fetchOptions - how to fetch results (see @link FetchOptions)

Returns:

a QueryResultIterator which can be used to iterate through the results that were found.

iterator

ResultIterator iterator()

Returns the results of a search as a ResultIterator. This calls Query#iterator(FetchOptions fetchOptions) with default FetchOptions; this implies eager loading of all results.

Specified by:

iterator in interface Iterable

Returns:

a ResultIterator which can be used to iterate through the results that were found.