Home > Class Reference > %SYS namespace > %iKnow.Filters.ContainsRelatedEntitiesFilter


class %iKnow.Filters.ContainsRelatedEntitiesFilter extends %iKnow.Filters.Filter

%iKnow.Filters.Filter implementation selecting sources based on whether they contain a particular set of entities in a single context. This means they appear in the same CRC (direct relationship) or path (any relationship) in the sources to be included. Optionally, any entities similar to the supplied ones are also accepted.

Filter parameters:

  1. pDomainId As %Integer
  2. pEntityList As %List - entities to check for, appearing in a relationship with one another.
  3. pDirectRelation As %Boolean (default 0) - if true, the entities in pEntityList should appear in a direct relationship (within the same CRC) with one another. Otherwise, having the entities appear in the same path is enough for a source to be included.
  4. pIncludeSimilar As %Boolean (default 0) - if true, entities similar to the strings in pEntityList are also considered.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 1


DirectRelation DomainId Entities FilteredSourceCount
IncludeSimilar IsCached Selectivity
%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


property DirectRelation as %Boolean;
property Entities as %List;
property IncludeSimilar as %Boolean;


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.