%iKnow.DeepSee.MDXFilter

class %iKnow.DeepSee.MDXFilter extends %iKnow.Filters.Filter

This %iKnow.Filters.Filter filters sources according to an MDX set expression. This should be a DeepSee-managed domain, created automatically through the use of an iKnow measure in a DeepSee cube. The MDX will be run against this cube and hence should be a valid MDX statement using dimensions and/or measures defined for this cube.

Filter parameters:

1. pDomainId As %Integer
2. pMDXWhereClause As %String - The MDX set expression to filter cube facts through. This should be a valid expression for the MDX WHERE clause.
3. pCubeName As %String - If this is an iKnow-managed domain, use this parameter to specify the DeepSee cube the MDX should be run against. (this parameter is ignored for DeepSee-managed domains)
4. pMeasureName As %String - If this is an iKnow-managed domain, use this parameter to specify the iKnow measure in pCubeName for which the values are represented by this iKnow domain. (this parameter is ignored for DeepSee-managed domains)

Example:

USER>zn "samples"

SAMPLES>set domId = ##class(%iKnow.DeepSee.CubeUtils).GetDomainId("AviationEvents","Report")

SAMPLES>set filter = ##class(%iKnow.DeepSee.MDXFilter).%New(domId, "{[AircraftDim].[H1].[AircraftCategory].&[Balloon],[AircraftDim].[H1].[AircraftCategory].&[Glider]}")

SAMPLES>write ##class(%iKnow.Queries.SourceAPI).GetCountByDomain(domId)
1005
SAMPLES>write ##class(%iKnow.Queries.SourceAPI).GetCountByDomain(domId,filter)
27

Property Inventory (Including Private)

• CubeName
• MDXWhereClause
• MeasureName

Method Inventory (Including Private)

• %OnNew()
• BuildSourceFilter()
• RestoreFilterFromStringInternal()
• ToString()

Properties (Including Private)Copy link to this section

property CubeName as %String [ ReadOnly ]; Copy link to this section

Property methods: CubeNameDisplayToLogical(), CubeNameGet(), CubeNameIsValid(), CubeNameLogicalToDisplay(), CubeNameLogicalToOdbc(), CubeNameNormalize()

property MDXWhereClause as %String [ ReadOnly ]; Copy link to this section

Property methods: MDXWhereClauseDisplayToLogical(), MDXWhereClauseGet(), MDXWhereClauseIsValid(), MDXWhereClauseLogicalToDisplay(), MDXWhereClauseLogicalToOdbc(), MDXWhereClauseNormalize()

property MeasureName as %String [ ReadOnly ]; Copy link to this section

Property methods: MeasureNameDisplayToLogical(), MeasureNameGet(), MeasureNameIsValid(), MeasureNameLogicalToDisplay(), MeasureNameLogicalToOdbc(), MeasureNameNormalize()

Methods (Including Private)Copy link to this section

private method %OnNew(pDomainId As %Integer, pMDXWhereClause As %String, pCubeName As %String = "", pMeasureName As %String = "") as %Status [ Language = objectscript ] Copy link to this section

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 [ Language = objectscript ] Copy link to this section

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.

private classmethod RestoreFilterFromStringInternal(filterParams As %String) as %iKnow.Filters.Filter [ Language = objectscript ] Copy link to this section

Inherited description:

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

method ToString() as %String [ Language = objectscript ] Copy link to this section

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.