Skip to main content


deprecated class %iKnow.Filters.DictionaryTermMatchFilter extends %iKnow.Filters.Filter

%iKnow.Filters.Filter implementation selecting sources based on whether they contain a minimum and/or maximum number or total score of dictionary term matches.

NOTE: by default, this filter only uses existing match results and will only ensure all sources are fully matched when the ensureMatched parameter is enabled!

Filter parameters:

  1. pDomainId As %Integer
  2. pDictTermIds As %List - target dictionary terms (ORed together). Use negative IDs to refer to cross-domain dictionary terms.
  3. pMin As %Numeric (default 1) - minimum count or total score (-1 = no minimum)
  4. pMax As %Numeric (default -1) - maximum count or total score (-1 = no maximum)
  5. pMetric As %String (["COUNT"|"SCORE"], default "COUNT") - whether to take the number of matches (default) or their aggregated score.
  6. ensureMatched As %Integer - controls whether or not all sources in the domain are matched through an explicit call to MatchingAPI.MatchSources() as follows:
    • 0 - no explicit matching, use current matching results (default)
    • 1 - match before every invocation of the filter (warning: significant performance impact!)
    • 2 - match once when the filter is instantiated

Property Inventory

Method Inventory


property DictTermIds as %List;
Property methods: DictTermIdsGet(), DictTermIdsIsValid(), DictTermIdsLogicalToOdbc(), DictTermIdsOdbcToLogical()
property EnsureMatched as %Boolean;
Property methods: EnsureMatchedDisplayToLogical(), EnsureMatchedGet(), EnsureMatchedIsValid(), EnsureMatchedLogicalToDisplay(), EnsureMatchedNormalize()
property Max as %Numeric;
Property methods: MaxDisplayToLogical(), MaxGet(), MaxIsValid(), MaxLogicalToDisplay(), MaxNormalize()
property Metric as %String;
Property methods: MetricDisplayToLogical(), MetricGet(), MetricIsValid(), MetricLogicalToDisplay(), MetricLogicalToOdbc(), MetricNormalize()
property Min as %Numeric;
Property methods: MinDisplayToLogical(), MinGet(), MinIsValid(), MinLogicalToDisplay(), MinNormalize()


method Invalidate(type As %Integer = $$$IKFSOURCE) as %Status

If EnsureMatched=2, filter invalidation (for example as the result of new sources being added to the domain) implies matching all sources.

method ToString() as %String
Inherited description:

Subclasses should implement this method to build a string representation of the filter instance. It should start with the filter class name, followed by a pipe (|) character and then a string representation that can be interpreted by its RestoreFilterFromStringInternal() implementation.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab