Home > Class Reference > ENSLIB namespace > %DeepSee.ComputedDimension.Base

%DeepSee.ComputedDimension.Base

class %DeepSee.ComputedDimension.Base extends %Library.RegisteredObject

This is the base class for DeepSee computed dimension classes.
A computed dimension class defines the behavior for a level within a hierarchy within a DeepSee computed dimension.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter BEHAVIOR = BITSET;
Controls the run-time behavior of the dimension. Available values are "BITSET", and "MDX".
BITSET (default) indicates that this class will compute a set of bits that define membership within a given dimension member.
MDX indicates that this class will return a set of valid MDX expressions that will be used to resolve the members of the dimension.
parameter CACHECOMPUTEDBITSET = NEVER;
Controls whether results of %OnComputeBitset() can be reused Available values are "NEVER", "CHECK", with NEVER (default) meaning no values are cached and CHECK meaning the timestamp of previous %OnComputeBitset results is compared to the cube's latest update timestamp.
parameter DIMTYPE = text;
Type reported back to the UI. This determines what type of control to display for filters based on this class.

Properties (Including Private)

property %baseCube as %DeepSee.Datatype.string;
Name of the base cube the computed level belongs to, if ..%cube is a subject area. Otherwise, this property is set to the same value as ..%cube.
Property methods: %baseCubeDisplayToLogical(), %baseCubeGet(), %baseCubeIsValid(), %baseCubeLogicalToDisplay(), %baseCubeLogicalToOdbc(), %baseCubeNormalize(), %baseCubeSet()
property %cube as %DeepSee.Datatype.string;
Name of the cube the computed level belongs to.
Property methods: %cubeDisplayToLogical(), %cubeGet(), %cubeIsValid(), %cubeLogicalToDisplay(), %cubeLogicalToOdbc(), %cubeNormalize(), %cubeSet()
property %dimNumber as %Integer;
Dimension # of the computed level.
Property methods: %dimNumberDisplayToLogical(), %dimNumberGet(), %dimNumberIsValid(), %dimNumberLogicalToDisplay(), %dimNumberNormalize(), %dimNumberSet()
property %factName as %String;
Fact Name associated with the computed level. This is the name of the fact that contains the default search data.
Property methods: %factNameDisplayToLogical(), %factNameGet(), %factNameIsValid(), %factNameLogicalToDisplay(), %factNameLogicalToOdbc(), %factNameNormalize(), %factNameSet()
property %factNumber as %Integer;
Fact # of the computed level.
Property methods: %factNumberDisplayToLogical(), %factNumberGet(), %factNumberIsValid(), %factNumberLogicalToDisplay(), %factNumberNormalize(), %factNumberSet()
property %hierNumber as %Integer;
Hierarchy # of the computed level.
Property methods: %hierNumberDisplayToLogical(), %hierNumberGet(), %hierNumberIsValid(), %hierNumberLogicalToDisplay(), %hierNumberNormalize(), %hierNumberSet()
property %levelNumber as %Integer;
Level # of the computed level.
Property methods: %levelNumberDisplayToLogical(), %levelNumberGet(), %levelNumberIsValid(), %levelNumberLogicalToDisplay(), %levelNumberNormalize(), %levelNumberSet()

Methods (Including Private)

final method %ComputeBitset(pSpec As %String, Output pIndexKey As %String) as %Status
Build the bitset that corresponds to the given computed dimension "spec".
method %ComputeIndexKey(pMemberKey As %String) as %String
Compute a hash key for a given member member.
classmethod %Count(pCube As %String, pDimNo As %Integer, pHierNo As %Integer, pLevelNo As %Integer) as %Integer
Return number of members.
classmethod %Create(pCube As %String, pFactNo As %Integer, pDimNo As %Integer, pHierNo As %Integer, pLevelNo As %Integer) as %DeepSee.ComputedDimension.Base
Create a instance of this dimension class.
method %CreateIndexFromSQL(pSQL As %String, pIndexKey As %String, pRS As %SQL.StatementResult = "", pTranslateIds As %Boolean = 0) as %Status
Utility method. Prepare and execute the given SQL statement and build an index from it.
If optional pRS is supplied, use it to fetch ID values (result set must have an ID column).
If pTranslateIds is true, then translate source id value to fact ids.
method %CreateIndexFromSearchableMeasure(pSearchMeasureIndex As %String = "", pComparison As %String, pValue As %Numeric, pIndexKey As %String = "") as %Status
Utility method. Build an index directly from a comparison on a searchable measure. The comparison is supplied by the arguments
pSearchMeasureIndex - The name of the searchable index on the searchable measure
pComparison - The comparison operator; legal values are SQL numeric comparisons: <,<=,=,=>,>,<>
pValue - The target value of the comparison. This must be numeric
pIndexKey - The key of the new index being constructed out of the searchable measure
classmethod %Eval(pExpr As %String, Output pErrorMsg As %String) as %String
Evaluate the given ObjectScript expression.
method %GetAllMembers(ByRef pMemberList, pCube As %String, pDimNo As %Integer, pHierNo As %Integer, pLevelNo As %Integer) as %Status