Versions Compared

Key

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

Overview

...

There are a number of ways of retrieving queried data from an IWidgetContext or IResultSet

...

Different documents sets

First off, an explanation of the difference between:

  • Matching documents
  • Top documents
  • Filtered documents

When a query is issued, often a large number of documents will satisfy the query criteria (particularly for a common query like "obama"), these are called matching documents. These documents are not directly available to the widget (apart from "top documents", see below), except

...

.

The IWidgetContext API allows for

...

filtering

...

of 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

...

.

...

Obviously all the matching documents can contribute to the "knowledge" that a query can provide, and the documents themselves are not the only objects returned from a query. Instead, relevant information to the analysis is summed/averaged/etc ("aggregated") across all matching documents, and these are referred to as the "aggregations". Examples include:

It should be noted that aggregations are sometimes ranked by frequency, sometimes summed by significance. This distinction will become more consistent in future versions of the tool.

...

The IWidgetContext API lets you select which of the document sets to aggregate over

...

.

For more information, see section Overview of Documents and Aggregations.

Visual

...

Summary

The following diagram provides a visual breakdown of the matching/top/filtered documents

...

, and shows which IWidgetContext calls return data from which documents.

Gliffy

...

nameiResults

 

 

Panel

In this section:

 


 

Panel

Related Documentation:

Overview of Documents and Aggregations