Open Exchange
Global Masters
Home > Class Reference > %SYS namespace > %iKnow.Filters.SimpleMatchFilter
Private  Storage   


class %iKnow.Filters.SimpleMatchFilter extends

NOTE: This class is deprecated, use %iKnow.Filters.DictionaryMatchFilter instead

%iKnow.Filters.Filter implementation selecting sources based on whether they contain a minimum and/or maximum number or total score of dictionary 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. domainId As %Integer
  2. dictIds As %List - target dictionaries (ORed together)
  3. min As %Numeric (default 1) - minimum count or total score (-1 = no minimum)
  4. max As %Numeric (default -1) - maximum count or total score (-1 = no maximum)
  5. metric 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


Parameters Properties Methods Queries Indices ForeignKeys Triggers


DictIds DomainId EnsureMatched FilterId
FilteredSourceCount IsCached Max Metric
Min Selectivity

%%OIDGet %AddToSaveSet %BindExport
%BuildObjectGraph %ClassIsLatestVersion %ClassName
%Close %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IncrementCount
%IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject BuildOccurrenceFilter
BuildTypedEntOccFilter BuildUniqueFilter CheckResultCache
CheckResultCacheSingle ClearCachedFilter ClearCachedFilters
CreateAsString CreateFromBitstring CreateGroupAsString
DictIdsSet DomainIdSet EnsureMatchedSet
FilteredSourceCountGet FromString GetCRCOccurrenceFilter
GetCRCUniqueFilter GetCcUniqueFilter GetEntityOccurrenceFilter
GetEntityUniqueFilter GetFilteredCcFrequency GetFilteredCcSpread
GetFilteredCrcFrequency GetFilteredCrcSpread GetFilteredCrcUniqueCount
GetFilteredEntityFrequency GetFilteredEntitySpread GetFilteredEntityUniqueCount
GetFilteredStemFrequency GetFilteredStemSpread GetFirstFilteredSource
GetLabel GetNextCRCOccurrenceFilterOffset GetNextCRCUniqueFilterOffset
GetNextCcUniqueFilterOffset GetNextEntityOccurrenceFilterOffset GetNextEntityUniqueFilterOffset
GetNextFilterOffset GetNextPathFilterOffset GetNextSourceFilterOffset
GetNextSrcId GetPathFilter GetSecondaryFilter
GetSourceFilter Initialize Invalidate
IsFiltered IsValid MaxSet
MergeBits MetricSet MinSet
RestoreFilterFromId RestoreFilterFromString SaveFilteredFrequency
SaveFilteredSpread SelectivityGet StoreResultCache
StoreResultCacheSingle ToArray ToBitstring