com.dnanexus

Class DXSearch.FindDataObjectsResult<T extends DXDataObject>

java.lang.Object

com.dnanexus.DXSearch.FindDataObjectsResult<T>

Type Parameters:

T - data object class to be returned

All Implemented Interfaces:

DXSearch.ObjectProducer<T>, Iterable<T>

Enclosing class:

DXSearch

public static class DXSearch.FindDataObjectsResult<T extends DXDataObject>
extends Object

The set of data objects that matched a findDataObjects query.

This class paginates through the results as necessary to return the full result set.

Method Summary

Modifier and Type	Method and Description
DXSearch.FindResultPage<T>	getFirstPage(int pageSize) Returns a first page of the findDataObjects results.
DXSearch.FindResultPage<T>	getSubsequentPage(com.fasterxml.jackson.databind.JsonNode starting, int pageSize) Returns a subsequent page of the findDataObjects results starting from the specified item.
Iterator<T>	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

Method Detail

getFirstPage

public DXSearch.FindResultPage<T> getFirstPage(int pageSize)

Returns a first page of the findDataObjects results.

Parameters:

pageSize - number of elements to retrieve

Returns:

result set

getSubsequentPage

public DXSearch.FindResultPage<T> getSubsequentPage(com.fasterxml.jackson.databind.JsonNode starting,
                                                    int pageSize)

Returns a subsequent page of the findDataObjects results starting from the specified item.

Parameters:

starting - result of DXSearch.FindDataObjectsResult.FindDataObjectsResultPage.getNext() call on previous page

pageSize - number of elements to retrieve

Returns:

result set

iterator

public Iterator<T> iterator()