Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%iKnow] >  [DeepSee] >  [MDXFilter]
Private  Storage   

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 4


Summary

Properties
CubeName DomainId FilteredSourceCount IsCached
MDXWhereClause MeasureName Selectivity

Methods
%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
ToString


Properties

• property CubeName as %String [ ReadOnly ];
• property MDXWhereClause as %String [ ReadOnly ];
• property MeasureName as %String [ ReadOnly ];

Methods

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



Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.