This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

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

%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.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property FieldId as %Integer;
Property methods: FieldIdDisplayToLogical(), FieldIdGet(), FieldIdIsValid(), FieldIdLogicalToDisplay(), FieldIdNormalize(), FieldIdSet()
property FilterOperator as %String;
Property methods: FilterOperator(), FilterOperatorDisplayToLogical(), FilterOperatorGet(), FilterOperatorIsValid(), FilterOperatorLogicalToDisplay(), FilterOperatorLogicalToOdbc(), FilterOperatorNormalize(), FilterOperatorSet()
property FilterValue as %String;
Property methods: FilterValue(), FilterValueDisplayToLogical(), FilterValueGet(), FilterValueIsValid(), FilterValueLogicalToDisplay(), FilterValueLogicalToOdbc(), FilterValueNormalize(), FilterValueSet()

Methods (Including Private)

private method %OnNew(domainId As %Integer, fieldName As %String, filterOperator As %String, filterValue As %String = "") 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)

Feedback