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:
- discover: by means of the Paginator object in the paginator property
- expand/expandNext: by means of the Page object in the page 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:
- termFrequency (see also discover termFrequency option)
- refiner
The availability of the above optional properties, depends on the following result set features:
Result set content is totally or partially harvested | Result set content is totally distributed | Extended result set | Discover error or timeout | |
---|---|---|---|---|
TermFrequency | YES | - | - | - |
Refiner | YES | YES | - | - |
Item Index
Properties
extension
ResultSetExtension
This property is set only if the discover extension has produced more than one result set
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)
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