Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / %iKnow.Filters.SourceIdFilter
Private  Storage   

%iKnow.Filters.SourceIdFilter


class %iKnow.Filters.SourceIdFilter extends
%iKnow.Filters.Filter

Simple implementation of the %iKnow.Filters.Filter interface, building a simple equality condition on Source IDs.

Filter parameters:

  1. domainId As %Integer
  2. sourceIds As %List - List of the source IDs that should be included by this filter. Can also be supplied as an array, in which case the top node is ignored.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 5


Summary


Properties
DomainId FilterId FilteredSourceCount IsCached
Selectivity SourceIds

Methods
%%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
DomainIdSet 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
MergeBits RestoreFilterFromId RestoreFilterFromString
SaveFilteredFrequency SaveFilteredSpread SelectivityGet
SourceIdsSet StoreResultCache StoreResultCacheSingle
ToArray ToBitstring ToString


Properties


• property SourceIds  [ MultiDimensional ];

Methods


• private method %OnNew(domainId As %Integer, ByRef srcIds As %List) as %Status
This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

• private method BuildSourceFilter(maxOffset As %Integer) as %Status

See also BuildSourceFilter in %iKnow.Filters.Filter.

• private classmethod RestoreFilterFromStringInternal(filterParams As %String) as %iKnow.Filters.Filter

Default implementation, with the filterParams corresponding to all %New arguments. See also RestoreFilterFromString.

• method SourceIdsSet(ByRef srcIds As %List) as %Status
This is a Set accessor method for the SourceIds property.
• 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.