The GEOSS Discovery And Access Broker APIs
Authors: Fabrizio Papeschi, Mattia Santoro, Stefano Nativi
API version: 1.4.3-beta

ResultSet

Module: ResultSet

This object is provided as result of a discover or expand/expandNext operation and has several information such as the number of the returned nodes (the size of the result set) and the number of pages with which the result set is split.

Retrieving result set content

The result set nodes can be retrieved depending on the executed operation by means of one of the following properties:

In case of error or timeout, none of the above properties is provided (see also response.error property)

Refining the result set content of a discover operation

The refinement allows to decrease the size of the result set adding constraints to the last performed discover in a simplified way. A result set of a discover can be refined by means of one of the following properties:

The availability of the above optional properties, depends on the following result set features:

Result set content is totally or partially harvestedResult set content is totally distributedExtended result setDiscover error or timeout
TermFrequencyYES---
RefinerYESYES--

Properties

extension

ResultSetExtension

This property is set only if the discover extension has produced more than one result set

pageCount

Integer

Number of pages of this result set

pageIndex

Integer

Index of the current page between 1 and pageCount

pageSize

Integer

Size of this result set pages. This value depends on the discover pageSize option

paginator

Paginator

optional

The Paginator resulting from a discover operation.
In case of error or timeout this property is omitted (see also response.error property)

refiner

Refiner

optional

The Refiner object. See this section for more info

size

Integer

Number of nodes of this result set

start

Integer

The start index of the current node between 1 and size.
After a DAB discover query, this index depends from the discover start option. After a call of Paginator methods next or prev this index increments or decrements of a value equals to pageSize

termFrequency

TermFrequency

optional

The TermFrequency object. See this section for more info