This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class %iKnow.Filters.SentenceCountFilter extends %iKnow.Filters.Filter

Sample filter implementation restricting sources on their sentence count.

Filter parameters:

  1. domainId As %Integer
  2. minSentenceCount As %Integer - minimum sentence count (use -1 for no lower limit)
  3. maxSentenceCount As %Integer - maximum sentence count (use -1 for no upper limit)

Property Inventory (Including Private)

Method Inventory (Including Private)


property MaxSentenceCount as %Integer;
Property methods: MaxSentenceCountDisplayToLogical(), MaxSentenceCountGet(), MaxSentenceCountIsValid(), MaxSentenceCountLogicalToDisplay(), MaxSentenceCountNormalize(), MaxSentenceCountSet()
property MinSentenceCount as %Integer;
Property methods: MinSentenceCountDisplayToLogical(), MinSentenceCountGet(), MinSentenceCountIsValid(), MinSentenceCountLogicalToDisplay(), MinSentenceCountNormalize(), MinSentenceCountSet()


private method %OnNew(DomainId As %Integer, MinSentenceCount As %Integer = -1, MaxSentenceCount As %Integer = -1) as %Status
Inherited description: 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
Inherited description:

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.

method ToString() as %String
Inherited description:

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)