Package org.nuxeo.elasticsearch.api

Class EsIterableQueryResultImpl

java.lang.Object

org.nuxeo.elasticsearch.api.EsIterableQueryResultImpl

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Map<String,Serializable>>, Iterator<Map<String,Serializable>>, IterableQueryResult

public class EsIterableQueryResultImpl
extends Object
implements IterableQueryResult, Iterator<Map<String,Serializable>>

Iterable query result of results of an ElasticSearch scroll query and next ones.

Queries ElasticSearch when there's no more result in current response and there's more in cluster.

For better performance use NxQueryBuilder.onlyElasticsearchResponse() for the first scroll requests.

Since:

8.4

Constructor Summary

Constructors

Constructor	Description
EsIterableQueryResultImpl(ElasticSearchService searchService, EsScrollResult scrollResult)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the query result and releases the underlying resources held by the cursor.
boolean	hasNext()
boolean	isLife()	Indicates if the query result has not been closed
Iterator<Map<String,Serializable>>	iterator()
boolean	mustBeClosed()	Indicates if the query result must be closed (because it holds resources).
Map<String,Serializable>	next()
long	pos()	Gets the current position in the iterator.
long	size()	Gets the total size of the query result.
void	skipTo(long pos)	Skips to a given position in the iterator.

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 java.util.Iterator

forEachRemaining, remove

Constructor Detail

EsIterableQueryResultImpl

public EsIterableQueryResultImpl(ElasticSearchService searchService,
                                 EsScrollResult scrollResult)

Method Detail

close

public void close()

Description copied from interface: IterableQueryResult

Closes the query result and releases the underlying resources held by the cursor.

This MUST be called when the query result is no more needed, otherwise underlying resources will be leaked. There is no auto-closing at the end of the iteration.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface IterableQueryResult

isLife

public boolean isLife()

Description copied from interface: IterableQueryResult

Indicates if the query result has not been closed

Specified by:

isLife in interface IterableQueryResult

mustBeClosed

public boolean mustBeClosed()

Description copied from interface: IterableQueryResult

Indicates if the query result must be closed (because it holds resources).

Specified by:

mustBeClosed in interface IterableQueryResult

Returns:

true if the query result must be closed, false otherwise

size

public long size()

Description copied from interface: IterableQueryResult

Gets the total size of the query result.

Note that this may be costly, and that some backends may not be able to do this operation, in which case -1 will be returned.

Specified by:

size in interface IterableQueryResult

Returns:

the size, or -1 for an unknown size

pos

public long pos()

Description copied from interface: IterableQueryResult

Gets the current position in the iterator.

Positions start at 0.

Specified by:

pos in interface IterableQueryResult

Returns:

the position

skipTo

public void skipTo(long pos)

Description copied from interface: IterableQueryResult

Skips to a given position in the iterator.

Positions start at 0.

Specified by:

skipTo in interface IterableQueryResult

iterator

public Iterator<Map<String,Serializable>> iterator()

Specified by:

iterator in interface Iterable<Map<String,Serializable>>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Map<String,Serializable>>

next

public Map<String,Serializable> next()

Specified by:

next in interface Iterator<Map<String,Serializable>>