Subclasses of this class are used to define "cubes" that can be queried by the DeepSee engine. More...

Inheritance diagram for CubeDefinition:

[legend]

Collaboration diagram for CubeDefinition:

[legend]

Static Public Attributes
	TRANSFORMERCLASS = None
	Subclasses of this class are used to define "cubes" that can be queried by the DeepSee engine. More...

	TRANSFORMXSL = None
	This parameter is used to transform original cube definition. More...

	USECUBEVERSIONS = None
	This parameter controls whether the compile of this class will utilize the cube versioning mechanism. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Private Member Functions
_.Library.Boolean	CanDrillThrough ()
	Test if this cube supports drill through (listing) queries.

_.Library.Boolean	CheckSourceId (_.Library.String pSourceId, _.Library.Boolean pVerbose, _.Library.Status pStatus)
	Check to make sure a given ID exists in the source table. More...

_.Library.Status	DeleteFact (_.Library.String pSourceId)
	Delete facts from this cube that correspond to rows in the source table with source id pSourceId . More...

_.Library.String	GetCubeCaption ()
	Return the caption of the cube defined by this class. More...

_.Library.String	GetCubeName ()
	Return the logical name of the cube defined by this class (in its original case).

_.Library.String	GetDefaultListing ()
	Return the name of the default listing for this cube, if any.

_.Library.String	GetFactClass ()
	Return name of the fact class used by this cube.

_.Library.Integer	GetFactCount ()
	Return number of facts in this cube's fact table.

_.Library.Status	GetFactIdRange (_.Library.Integer pStartId, _.Library.Integer pEndId)
	Return the approximate starting and ending id values for this cubes fact table.

_.Library.String	GetFilterSpec ()
	Return the filter spec for this cube, if any.

_.Library.Integer	GetPrecomputeLevel ()
	Return the precompute level of the cube defined by this class.

_.Library.Status	GetRelationshipId (_.Library.String pRelationName, _.Library.String pKey, _.Library.Integer pID)
	Take cube relationship with name pRelationName More...

_.Library.Status	InjectFact (_.Library.String pFactId, _.Library.String pValues, _.Library.Boolean pDimensionsOnly, _.Library.String pFactList)
	Inject a fact into the fact table for this cube that is not associated with the source data table. More...

_.Library.Boolean	IsAbstract ()
	Test whether this cube is abstract or not.

_.Library.Boolean	IsCompound (_.Library.String pJoinList)
	Test whether this cube is compound or not.

_.Library.Status	KillCache ()
	Delete all cached values for this cube.

_.Library.Status	KillCellCache ()
	Delete the cell cache for this cube.

_.Library.Status	KillFacts ()
	Delete all Facts as well as cached results from the cube.

_.Library.Status	KillResultsCache ()
	Delete the results cache for this cube.

_.Library.String	Lookup (_.Library.String pTermList, _.Library.String pKey, _.Library.String pDefault, _.Library.String pField)
	Lookup a single value with the given key and DeepSee term list name. More...

_.Library.Status	OnAfterBuildCube (_.Library.Status pBuildStatus, _.Library.Boolean pBuildErrors)
	Notification that this cube has completed its build. More...

_.Library.Status	OnAfterProcessFact (_.Library.String pID, _.Library.String pFactArray, _.Library.Status pUpdateStatus)
	Notification that a fact within the cube has been processed (inserted. More...

_.Library.Status	OnApplyOverrides ()
	If implemented, this is called before the cube model is processed. More...

_.Library.Status	OnBuildCube (_.Library.List pFactList)
	Notification that this cube is about to be built. More...

_.Library.Status	OnExecuteListing (_.Library.String pSQL)
	Notification that a listing (drillthrough) query is about to be executed. More...

_.Library.Status	OnGetComputedMembers (_.Library.String pDimName, _.Library.String pHierName, _.Library.String pLevelName, pMemberList, _.Library.String pRollupKey, _.Library.String pRange)
	This callback gives a Cube a chance to programmatically provide a set of. More...

_.Library.String	OnGetDefaultListing ()
	This callback gives a cube a chance to programmatically return the name. More...

_.Library.String	OnGetFilterSpec (_.Library.String pFilterSpec)
	This callback gives a Cube a chance to programmatically define a filter spec.

_.Library.Status	OnGetSourceIds (_.Library.String pStartId, _.Library.String pEndId)
	If implemented, this method is called when a cube is being completely rebuilt and More...

_.Library.Status	OnKillFacts ()
	Notification that all facts have been deleted. More...

_.Library.Status	OnProcessFact (_.Library.String pID, _.Library.String pFacts, _.Library.Boolean pSkip, _.Library.Boolean pInsert)
	Notification that a fact within the cube is to be processed (inserted. More...

_.Library.String	Rule (_.Library.String pRuleName)
	Invoke a Business Rule on the current record within the source class. More...

_.Library.Status	UpdateFacts (_.Library.String pStartId, _.Library.String pEndId, _.Library.Boolean pBatchMode, _.Library.Boolean pVerbose, _.Library.String pTaskGroup, _.Library.Integer pUpdates, _.Library.String pRefProp, _.Library.String pRefID, pDimTables)
	Update Fact indices with data from the source table. More...

_.Library.Status	UpdateFactsList (_.Library.String pFactList, _.Library.String pStartId, _.Library.String pEndId, _.Library.Boolean pBatchMode, _.Library.Boolean pVerbose, _.Library.String pTaskGroup, _.Library.Integer pUpdates, _.Library.String pRefProp, _.Library.String pRefID, pDimTables)
	Update Fact indices with data from selected columns in the source table. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Detailed Description

Subclasses of this class are used to define "cubes" that can be queried by the DeepSee engine.

The Cube XDATA block defines the contents of a DeepSee cube (dimensions and measures) as an XML document. When a subclass of this class is compiled, it generates the indexed fact table that holds the data for this cube.
This class also provides the APIs needs to explore a cube's metadata that are used by the DeepSee utilities.

Member Function Documentation

◆ CheckSourceId()

_.Library.Boolean CheckSourceId	(	_.Library.String	pSourceId,
		_.Library.Boolean	pVerbose,
		_.Library.Status	pStatus
	)

staticprivate

Check to make sure a given ID exists in the source table.

◆ DeleteFact()

_.Library.Status DeleteFact ( _.Library.String pSourceId )

staticprivate

Delete facts from this cube that correspond to rows in the source table with source id pSourceId
.

If pVerbose is true, then write status information to the console.

◆ GetCubeCaption()

_.Library.String GetCubeCaption ( )

staticprivate

Return the caption of the cube defined by this class.

If not defined, the cube name is returned.

◆ GetRelationshipId()

_.Library.Status GetRelationshipId	(	_.Library.String	pRelationName,
		_.Library.String	pKey,
		_.Library.Integer	pID
	)

staticprivate

Take cube relationship with name pRelationName

and transform the original key value pKey into the id of the corresponding fact in the fact table and return it via pID.

◆ InjectFact()

_.Library.Status InjectFact	(	_.Library.String	pFactId,
		_.Library.String	pValues,
		_.Library.Boolean	pDimensionsOnly,
		_.Library.String	pFactList
	)

staticprivate

Inject a fact into the fact table for this cube that is not associated with the source data table.

pFactId is the id of the fact in the fact table. Set this to "" for an insert. On return it will contain the id used for the fact.
pValues is an array of fact values subscripted by sourceProperty name (case must match exactly. If pDimensionsOnly is true, then only the dimension tables for the cube are affected; no facts are inserted.

◆ Lookup()

_.Library.String Lookup	(	_.Library.String	pTermList,
		_.Library.String	pKey,
		_.Library.String	pDefault,
		_.Library.String	pField
	)

staticprivate

Lookup a single value with the given key and DeepSee term list name.

This can be invoked by source expressions within this cube.
pTermList is the name (with no extension) of the termlist.
pKey is the key to lookup within the termlist.
pDefault is an optional default value to return if the key is not found within the termlist.
pField is an optional field to lookup within the termlist. By default, this is the "value" field.

◆ OnAfterBuildCube()

_.Library.Status OnAfterBuildCube	(	_.Library.Status	pBuildStatus,
		_.Library.Boolean	pBuildErrors
	)

staticprivate

Notification that this cube has completed its build.

The status of the overall build is contained in pBuildStatus. If the build is otherwise successful, the value of pBuildStatus can be changed within the callback to become the new status returned by BuildCube. If there were any build errors in the individual facts the count of these errors is reported in pBuildErrors

◆ OnAfterProcessFact()

_.Library.Status OnAfterProcessFact	(	_.Library.String	pID,
		_.Library.String	pFactArray,
		_.Library.Status	pUpdateStatus
	)

staticprivate

Notification that a fact within the cube has been processed (inserted.

or updated). This method does not allow for any intervention of the processing of the fact, but rather provides an opportunity to react to success or failure in processing. The return status is ignored by the caller.
pID is the id of the row in the source data being processed.
pFacts is an array containing the values that will be used for the row, subscripted by fact name.
pUpdateStatus is the status about to be returned by ProcessFact. If an error is passed in, this error will already be logged in the DeepSee logs and the ^DeepSee.BuildErrors global.

◆ OnApplyOverrides()

_.Library.Status OnApplyOverrides ( )

staticprivate

If implemented, this is called before the cube model is processed.

It gives the class a change to modify the ^DeepSee.Overrides global.

◆ OnBuildCube()

_.Library.Status OnBuildCube ( _.Library.List pFactList )

staticprivate

Notification that this cube is about to be built.

If the build is invoked using a selected pFactList, this list will be passed to the callback in a $LB format.

◆ OnExecuteListing()

_.Library.Status OnExecuteListing ( _.Library.String pSQL )

staticprivate

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.

◆ OnGetComputedMembers()

_.Library.Status OnGetComputedMembers	(	_.Library.String	pDimName,
		_.Library.String	pHierName,
		_.Library.String	pLevelName,
			pMemberList,
		_.Library.String	pRollupKey,
		_.Library.String	pRange
	)

staticprivate

This callback gives a Cube a chance to programmatically provide a set of.

members for a computed dimension.
Find the set of members for this computed dimension object satisfying pRollupKey and pRange (if applicable for this implementation).
This is passed and returns:
pMemberList($I(pMemberList)) = $LB(id (expression for MDX computed dimension),caption,key,[format])

◆ OnGetDefaultListing()

_.Library.String OnGetDefaultListing ( )

staticprivate

This callback gives a cube 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 cube. Return "" to use the pre-defined default listing.

◆ OnGetSourceIds()

_.Library.Status OnGetSourceIds	(	_.Library.String	pStartId,
		_.Library.String	pEndId
	)

staticprivate

If implemented, this method is called when a cube is being completely rebuilt and

the rebuild is not using parallel processing.
On return pStartId and pEndId must contain the first and last row id values for this cube's source data table, such that a query of the form:
SELECT ... FROM SOURCE WHERE ID BETWEEN pStartId AND pEndId
will return all the rows of the source table.
This gives the developer the opportunity to bypass the built-in query that fetchs these values.

◆ OnKillFacts()

_.Library.Status OnKillFacts ( )

staticprivate

Notification that all facts have been deleted.

If implemented, this is called when the <method>KillFacts</method> is called.

◆ OnProcessFact()

_.Library.Status OnProcessFact	(	_.Library.String	pID,
		_.Library.String	pFacts,
		_.Library.Boolean	pSkip,
		_.Library.Boolean	pInsert
	)

staticprivate

Notification that a fact within the cube is to be processed (inserted.

or updated).
pID is the id of the row in the source data being processed.
pFacts is an array containing the values that will be used for the row, subscripted by fact name.
pSkip is a boolean value returned by reference; If true then the record is not processed.
pInsert is true if the current fact will be inserted into the cube's fact table.

◆ Rule()

_.Library.String Rule ( _.Library.String pRuleName )

staticprivate

Invoke a Business Rule on the current record within the source class.

pID should contain the object id of the record within the source class. This can be invoked by source expressions within this cube.

◆ UpdateFacts()

_.Library.Status UpdateFacts	(	_.Library.String	pStartId,
		_.Library.String	pEndId,
		_.Library.Boolean	pBatchMode,
		_.Library.Boolean	pVerbose,
		_.Library.String	pTaskGroup,
		_.Library.Integer	pUpdates,
		_.Library.String	pRefProp,
		_.Library.String	pRefID,
			pDimTables
	)

staticprivate

Update Fact indices with data from the source table.

Read all rows from the source table between pStartId and pEndId.
If pEndId is missing (""), then update one fact with source id pStartId
. If pVerbose is true, then write status information to the console.
pTaskGroup is used when this method is called by the DeepSee TaskMaster.
If pBatchMode is true, then perform the update in batch mode.

◆ UpdateFactsList()

_.Library.Status UpdateFactsList	(	_.Library.String	pFactList,
		_.Library.String	pStartId,
		_.Library.String	pEndId,
		_.Library.Boolean	pBatchMode,
		_.Library.Boolean	pVerbose,
		_.Library.String	pTaskGroup,
		_.Library.Integer	pUpdates,
		_.Library.String	pRefProp,
		_.Library.String	pRefID,
			pDimTables
	)

staticprivate

Update Fact indices with data from selected columns in the source table.

The fact list is limited using the pFactList parameter, which can be either a comma-delimited list or a $LB. Read all rows from the source table between pStartId and pEndId.
If pEndId is missing (""), then update one fact with source id pStartId
. If pVerbose is true, then write status information to the console.
pTaskGroup is used when this method is called by the DeepSee TaskMaster.
If pBatchMode is true, then perform the update in batch mode.

Member Data Documentation

◆ TRANSFORMERCLASS

TRANSFORMERCLASS = None

static

Subclasses of this class are used to define "cubes" that can be queried by the DeepSee engine.

The Cube XDATA block defines the contents of a DeepSee cube (dimensions and measures) as an XML document. When a subclass of this class is compiled, it generates the indexed fact table that holds the data for this cube.
This class also provides the APIs needs to explore a cube's metadata that are used by the DeepSee utilities.

This parameter is used to transform original cube definition.

If it is defined in a subclass then the cube definition is piped through the transformation defined in the class named by this parameter.

◆ TRANSFORMXSL

TRANSFORMXSL = None

static

This parameter is used to transform original cube definition.

If it is defined in subclass then the cube definition is piped through XSLT transformation. XSL is taken from XData block named in this parameter.

◆ USECUBEVERSIONS

USECUBEVERSIONS = None

static

This parameter controls whether the compile of this class will utilize the cube versioning mechanism.

If

set to 1, the current class definition will act as a generator for a distinct version of the cube.
The version attribute of the <cube&gt tag must be set if this is set to 1.

Static Public Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CheckSourceId()

◆ DeleteFact()

◆ GetCubeCaption()

◆ GetRelationshipId()

◆ InjectFact()

◆ Lookup()

◆ OnAfterBuildCube()

◆ OnAfterProcessFact()

◆ OnApplyOverrides()

◆ OnBuildCube()

◆ OnExecuteListing()

◆ OnGetComputedMembers()

◆ OnGetDefaultListing()

◆ OnGetSourceIds()

◆ OnKillFacts()

◆ OnProcessFact()

◆ Rule()

◆ UpdateFacts()

◆ UpdateFactsList()

Member Data Documentation

◆ TRANSFORMERCLASS

◆ TRANSFORMXSL

◆ USECUBEVERSIONS