ddf.catalog.util.impl

Class ResultIterable

java.lang.Object

ddf.catalog.util.impl.ResultIterable

All Implemented Interfaces:

Iterable<Result>

public class ResultIterable
extends Object
implements Iterable<Result>

Class used to iterate over the Result objects contained in a QueryResponse returned when executing a QueryRequest. The class will fetch new results as needed until all results that match the query provided have been exhausted.

Since the class may use the page size provided in the Query to fetch the results, its value should be carefully set to avoid any memory or performance issues.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGE_SIZE

Method Summary

Modifier and Type	Method and Description
Iterator<Result>	iterator()
static ResultIterable	resultIterable(CatalogFramework catalogFramework, QueryRequest queryRequest) Creates an iterable that will call the CatalogFramework to retrieve the results that match the QueryRequest provided.
static ResultIterable	resultIterable(CatalogFramework catalogFramework, QueryRequest queryRequest, int maxResultCount) Creates an iterable that will call the CatalogFramework to retrieve the results that match the QueryRequest provided.
static ResultIterable	resultIterable(QueryFunction queryFunction, QueryRequest queryRequest) Creates an iterable that will call a QueryFunction to retrieve the results that match the QueryRequest provided.
static ResultIterable	resultIterable(QueryFunction queryFunction, QueryRequest queryRequest, int maxResultCount) Creates an iterable that will call a QueryFunction to retrieve the results that match the QueryRequest provided.
Stream<Result>	stream()

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

Field Detail

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

Method Detail

resultIterable

public static ResultIterable resultIterable(CatalogFramework catalogFramework,
                                            QueryRequest queryRequest)

Creates an iterable that will call the CatalogFramework to retrieve the results that match the QueryRequest provided. There will be no limit to the number of results returned.

Parameters:

catalogFramework - reference to the CatalogFramework to call to retrieve the results.

queryRequest - request used to retrieve the results.

resultIterable

public static ResultIterable resultIterable(QueryFunction queryFunction,
                                            QueryRequest queryRequest)

Creates an iterable that will call a QueryFunction to retrieve the results that match the QueryRequest provided. There will be no limit to the number of results returned.

Parameters:

queryFunction - reference to the QueryFunction to call to retrieve the results.

queryRequest - request used to retrieve the results.

resultIterable

public static ResultIterable resultIterable(CatalogFramework catalogFramework,
                                            QueryRequest queryRequest,
                                            int maxResultCount)

Creates an iterable that will call the CatalogFramework to retrieve the results that match the QueryRequest provided.

Parameters:

catalogFramework - reference to the CatalogFramework to call to retrieve the results.

queryRequest - request used to retrieve the results.

maxResultCount - a positive integer indicating the maximum number of results in total to query for

resultIterable

public static ResultIterable resultIterable(QueryFunction queryFunction,
                                            QueryRequest queryRequest,
                                            int maxResultCount)

Creates an iterable that will call a QueryFunction to retrieve the results that match the QueryRequest provided.

Parameters:

queryFunction - reference to the QueryFunction to call to retrieve the results.

queryRequest - request used to retrieve the results.

maxResultCount - a positive integer indicating the maximum number of results in total to query for

iterator

public Iterator<Result> iterator()

Specified by:

iterator in interface Iterable<Result>

stream

public Stream<Result> stream()