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

class %DeepSee.SubjectArea extends %RegisteredObject, %XML.Adaptor

This class is used to define DeepSee Subject Areas.
Each subclass of this class defines an active Subject Area. A Subject Area is analogous to an SQL view; it is based on an actual DeepSee Cube data model and can serve as the target of queries as if it were an actual cube model.
A Subject Area cannot define additional dimensions or measures but it can define:

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
24


Summary

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%CanDrillThrough %ClassIsLatestVersion %ClassName %Close
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %Generate %GetActionList %GetCountCaption
%GetCountName %GetCubeCaption %GetCubeName %GetDefaultListing
%GetFactClass %GetFactCount %GetFilterSpec %GetLevelMemberCaption
%GetListingCaption %GetListingDescription %GetListingFieldCaption %GetListingFieldDescription
%GetMemberCaption %GetMemberDescription %GetParameter %IncrementCount
%IsA %IsAbstract %IsCompound %IsModified
%New %NormalizeObject %ObjectModified %OnExecuteListing
%OnGetComputedMembers %OnGetDefaultListing %OnGetFilterSpec %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject %XMLGenerate XMLAfterExport XMLBeforeExport
XMLDTD XMLExport XMLExportInternal XMLExportToStream
XMLExportToString XMLGetSchemaImports XMLImport XMLImportInternal
XMLIsObjectEmpty XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Methods

• classmethod %CanDrillThrough() as %Boolean
Test if this cube supports drill through (listing) queries.
• final classmethod %Generate() as %Status
Process the model for this Subject Area and generate meta data.
• final classmethod %GetActionList(ByRef pActions As %List) as %Status
Return list of possible actions for this Subject Area. This simply dispatches to the base cube's method.
• final classmethod %GetCountCaption() as %String
Return the (localized) caption for the %COUNT measure used by this cube. Returns "" if this has not been overridden by the cube.
• final classmethod %GetCountName() as %String
Return the logical name for the %COUNT measure used by this cube.
• classmethod %GetCubeCaption() as %String
Return the caption of the subject area defined by this class. If not defined, the subject area name is returned.
• classmethod %GetCubeName() as %String
Return the logical name of the MDX cube defined by this subject area.
• final classmethod %GetDefaultListing() as %String
Return the name of the default listing for this SubjectArea, if any.
• classmethod %GetFactClass() as %String
Return name of the fact class used by the base cube.
• classmethod %GetFactCount() as %Integer
Return number of facts in the base cube's fact table.
• final classmethod %GetFilterSpec() as %String
Return the filter spec for this subject area.
• final classmethod %GetLevelMemberCaption(pDimNo As %Integer, pHierNo As %Integer, pLevelNo As %Integer, pName As %String) as %String
For a pre-defined member within a given level in this cube, return its (localized) caption (display name).
• final classmethod %GetListingCaption(pListing As %String) as %String
Return the (localized) caption for a given listing within this cube.
• final classmethod %GetListingDescription(pListing As %String) as %String
Return the (localized) description for a given listing within this cube.
• final classmethod %GetListingFieldCaption(pField As %String) as %String
Return the (localized) caption for a given listing field within this cube.
• final classmethod %GetListingFieldDescription(pField As %String) as %String
Return the (localized) description for a given listing field within this cube.
• final classmethod %GetMemberCaption(pDimName As %String, pHierName As %String = "", pLevelName As %String = "", pPropName As %String = "") as %String
For a given dimenions, hierarchy, and level return its localized caption.
• final classmethod %GetMemberDescription(pDimName As %String, pHierName As %String = "", pLevelName As %String = "", pPropName As %String = "") as %String
For a given dimenions, hierarchy, and level return its localized caption.
• classmethod %IsAbstract() as %Boolean
Test whether this subject area is abstract or not.
• classmethod %IsCompound(Output pJoinList As %String) as %Boolean
Test whether this subject area is compound or not.
• classmethod %OnExecuteListing(pSQL As %String) as %Status
Notification that a listing (drillthrough) query is about to be executed.
This is called immediately before a listing query is executed. This is useful for cases where additional setup work is required before a listing query can run.
pSQL is the listing query that will be executed.
• final classmethod %OnGetComputedMembers(pDimName As %String, pHierName As %String, pLevelName As %String, ByRef pMemberList, pRollupKey As %String = "", ByRef pRange As %String = "") as %Status
This callback gives a Cube a chance to programmatically provide a set of members for a computed dimension.
This simply dispatches to the base cube's method.
• classmethod %OnGetDefaultListing() as %String
This callback gives a SubjectArea a chance to programmatically return the name of the listing to use as its default listing. This must be the name of a defined listing within the SubjectArea. Return "" to use the pre-defined default listing.
• classmethod %OnGetFilterSpec(pFilterSpec As %String) as %String
This callback gives a SubjectArea a chance to programmatically define its filter spec.


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