Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Since there are a number of ways of retrieving queried data from an IWidgetContext or IResultSet, this page provides a brief overview of the concepts involved and then explains what data each of the calls will retrieve.

...

However there are normally too many documents for a person to analyze directly (see below, under aggregations). As a result, a ranked subset of these matching documents (according to a configurable scoring method) is retrieved and only these are returned directly to the GUI. The default number of these top documents returned is 100.

The IWidgetContext API allows for further filtering of these top documents within the GUI framework, eg containing a specific set of entities (eg click on one of the bars in the graph in the "Significance" widget). This sub-set is called the filtered documents.

...

Finally, note that the idea of an aggregation is valid across all three of the documents sets described above (matching, top, filtered). The IWidgetContext API lets you select which of the document sets to aggregate over, as show shown in the diagram below.

Visual summary

The following diagram provides a visual breakdown of the matching/top/filtered documents described above, and shows which IWidgetContext calls return data from which documents.

...