Home > Class Reference > %SYS namespace > %iKnow.Filters.SimpleMetadataFilter
Private  

%iKnow.Filters.SimpleMetadataFilter

class %iKnow.Filters.SimpleMetadataFilter extends %iKnow.Filters.Filter

Filter implementation selecting sources based on their metadata values, as set through %iKnow.Queries.MetadataAPI.

Filter parameters:

  1. domainId As %Integer
  2. fieldName As %String - the name of the metadata field to filter by.
  3. filterOperator As %String - the operator to use for filtering (should be a supported one for this metadata field).
  4. filterValue - the value to compare the actual source metadata values against.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 1

Summary

Properties
DomainId FieldId FilterOperator FilterValue
FilteredSourceCount IsCached Selectivity
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 Invalidate
IsFiltered IsValid RestoreFilterFromId
RestoreFilterFromString StoreResultCache StoreResultCacheSingle
ToString

Properties

property FieldId as %Integer;
property FilterOperator as %String;
property FilterValue as %String;

Methods

method ToString() as %String

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.