%iKnow.Filters.DictionaryTermMatchFilter
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:
- pDomainId As %Integer
- pDictTermIds As %List - target dictionary terms (ORed together). Use negative IDs to refer to cross-domain dictionary terms.
- pMin As %Numeric (default 1) - minimum count or total score (-1 = no minimum)
- pMax As %Numeric (default -1) - maximum count or total score (-1 = no maximum)
- pMetric As %String (["COUNT"|"SCORE"], default "COUNT") - whether to take the number of matches (default) or their aggregated score.
- 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
Properties
Methods
If EnsureMatched=2, filter invalidation (for example as the result of new sources being added to the domain) implies matching all sources.
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
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- CheckResultCache()
- CheckResultCacheSingle()
- ClearCachedFilter()
- ClearCachedFilters()
- CreateAsString()
- CreateFromBitstring()
- CreateGroupAsString()
- FromString()
- GetCRCOccurrenceFilter()
- GetCRCUniqueFilter()
- GetCcUniqueFilter()
- GetEntityOccurrenceFilter()
- GetEntityUniqueFilter()
- GetFilteredCcFrequency()
- GetFilteredCcSpread()
- GetFilteredCrcFrequency()
- GetFilteredCrcSpread()
- GetFilteredEntityFrequency()
- GetFilteredEntitySpread()
- GetFilteredEntityUniqueCount()
- GetFilteredStemFrequency()
- GetFilteredStemSpread()
- GetFirstFilteredSource()
- GetLabel()
- GetNextCRCOccurrenceFilterOffset()
- GetNextCRCUniqueFilterOffset()
- GetNextCcUniqueFilterOffset()
- GetNextEntityOccurrenceFilterOffset()
- GetNextEntityUniqueFilterOffset()
- GetNextPathFilterOffset()
- GetNextSourceFilterOffset()
- GetNextSrcId()
- GetPathFilter()
- GetSourceFilter()
- Initialize()
- IsFiltered()
- IsValid()
- RestoreFilterFromId()
- RestoreFilterFromString()
- StoreResultCache()
- StoreResultCacheSingle()