org.modeshape.jcr.index.elasticsearch

Class SearchResults

java.lang.Object

org.modeshape.jcr.index.elasticsearch.SearchResults

All Implemented Interfaces:

AutoCloseable, Filter.Results

public class SearchResults
extends Object
implements Filter.Results

Constructor Summary

Constructors

Constructor and Description
SearchResults(EsClient client, String index, String type, EsRequest query) Creates new search result instance for the given search request.

Method Summary

Modifier and Type	Method and Description
void	close() Close any and all resources for the operation.
long	getCardinality() Gets cardinality for this search request.
boolean	getNextBatch(ResultWriter writer, int batchSize) Obtain the next batch of results for the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResults

public SearchResults(EsClient client,
                     String index,
                     String type,
                     EsRequest query)

Creates new search result instance for the given search request.

Parameters:

searchBuilder - search request as request builder.

Method Detail

getNextBatch

public boolean getNextBatch(ResultWriter writer,
                            int batchSize)

Description copied from interface: Filter.Results

Obtain the next batch of results for the query.

Specified by:

getNextBatch in interface Filter.Results

Parameters:

writer - the writer that this method should use to register results in the batch; never null

batchSize - the ideal number of node keys that are to be included in this batch; always positive

Returns:

true if there are additional results after this batch is completed, or false if this batch contains the final results of the query

close

public void close()

Description copied from interface: Filter.Results

Close any and all resources for the operation. This will always be called by ModeShape when the operation is no longer needed, even if Filter.Results.getNextBatch(ResultWriter, int) was never called.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Filter.Results

getCardinality

public long getCardinality()

Gets cardinality for this search request.

Returns:

total hits matching search request.