Refiner

Module: Refinement
Parent Module: ResultSet

This object is optionally provided as property of a result set.
A new instance is created every time a discover is performed, and it is maintained with its chronology, until a new discover is performed.

The Refiner is initialized as follows:

the cursor value is 0
the chronology.length is 1 and contains the constraints and the options of the origin discover

The Refiner provides the following main features:

allows to refine the related result set by merging the given constraints with the constraints of the origin discover (see point 2 above)
keeps track of the refinements (both constraints and options) in a chronology that can be scrolled back and ahead

Index
Methods

Item Index

Methods

`browse`

(

onResponse
who
[options]

)

async

Browses the content of the composed node having the given who identifier.
The correspondent result set is the same that could be retrieved by calling the expand method on the composed node having the given who identifier. However the Refiner allows to take advantage of the chronology.
If who corresponds to a non existent node or to a Report/simple:property node, the correspondent result set is empty.

Parameters:

onResponse Function

callback function for receiving asynchronous query response
who String

identifier of the composed node
[options] Object optional

all the options are allowed except start, termFrequency and extension

`chronology`

() Object[]

Returns the chronology of the constraints used to refine the related result set

Returns:

Object[]:

array of basic constraints

`cursor`

() Integer

Returns the chronology cursor, an integer value indicating the current constraints of the chronology.
The value satisfies the following statement: cursor >= 0 && cursor <= history.length

Returns:

Integer:

an integer value indicating the current constraint of the chronology

`forward`

(

[onResponse]

)

Boolean async

Scrolls ahead the chronology:

increases the cursor by one
restores the chronology to the current cursor value

The method is executed only if cursor is less than chronology.length and onResponse is provided

Parameters:

[onResponse] Function optional

callback function for receiving asynchronous query response; if omitted the method is only tested but not executed

Returns:

Boolean:

true if the cursor is less than chronology.length, false otherwise

`refine`

(

onResponse
constraints
[options]

)

async

Refines the related result set:

merges the given constraints with the original discover constraints

if cursor is at the end of the chronology (its value is chronology.length - 1), it appends the merged constraints to the chronology
if cursor is less than chronology.length - 1 (due to one or more calls to the rewind/forward methods), it overwrites the chronology at index cursor + 1 with the merged constraints and clears the remaining part of the chronology

increases the cursor by 1
refines the related result set with the merged constraints and the given options

Only basic constraints are supported. See also mergeConstraints

Parameters:

onResponse Function

Callback function for receiving asynchronous query response
constraints Object

the constraints to refine the discover. Only basic constraints are supported
[options] Object optional

all the options are allowed except start, termFrequency and extension

`reset`

()

Resets the Refiner to its initial state:

the cursor value is set to 0
the chronology.length is set to 1 and contains the constraints and the options of the origin discover

`restore`

(

[onResponse]
cursor

)

Boolean async

Refines the the related result set by restoring the constraints and the options in the chronology at the specified cursor.
The method is executed only if cursor >= 0 && cursor <= chronology.length and onResponse is provided

Parameters:

[onResponse] Function optional

callback function for receiving asynchronous query response; if omitted the method is only tested but not executed
cursor Integer

an integer value indicating the constraints in the chronology to restore

Returns:

Boolean:

true if cursor >= 0 && cursor <= chronology.length , false otherwise

`rewind`

(

[onResponse]

)

Boolean async

Scrolls back the chronology:

decreases the cursor by 1
restores the chronology to the current cursor value

The method is executed only if cursor is greater than 0 and onResponse is provided

Parameters:

[onResponse] Function optional

callback function for receiving asynchronous query response; if omitted the method is only tested but not executed

Returns:

Boolean:

true if the cursor is greater than 0, false otherwise