%iKnow.Filters.GroupFilter
class %iKnow.Filters.GroupFilter extends %iKnow.Filters.Filter
A generic filter to logically combine any number of %iKnow.Filters.Filter subfilter objects using a boolean AND or OR, optionally inverting the result (NOT) if negated is true.
After initially creating a GroupFilter instance, add subfilters to it using AddSubFilter() or AddSubFilterString().
Filter parameters:
- domainId As %Integer
- groupLogic As %Integer - either $$$GROUPFILTERAND or $$$GROUPFILTEROR.
- negated As %Boolean - indicates whether or not invert (NOT) the combined filter.
Property Inventory (Including Private)
Method Inventory (Including Private)
- %OnNew()
- AddSubFilter()
- AddSubFilterString()
- BuildSourceFilter()
- GetSubFilterAt()
- GetSubFilterCount()
- RestoreFilterFromStringInternal()
- ToString()
Properties (Including Private)
Methods (Including Private)
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.
Adds a %iKnow.Filters.Filter object to this instance as a subfilter, which will be ANDed or ORed according to this instances groupLogic property.
Adds a %iKnow.Filters.Filter object in its %String format (see ToString()) to this instance as a subfilter, which will be ANDed or ORed according to this instances groupLogic property.
This is the primary method that needs to be implemented by an actual %iKnow.Filters.Filter subclass to translate the abstract filter criteria the subclass addresses into a bitstring based on Source IDs. The subclass' implementation of this method should use SetSourceBits() for this purpose, setting the requested bitstrings for each offset up to maxOffset.
Default implementation, with the filterParams corresponding to all %New() arguments. See also RestoreFilterFromString().
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 (Including Private)
Inherited Methods (Including Private)
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %ConstructCloneInit()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToSaveSet()
- %OnClose()
- %OnConstructClone()
- %OnValidateObject()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- ChangeParams()
- 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()
- SetSourceBits()
- StoreResultCache()
- StoreResultCacheSingle()
- Validate()