IRISLIB database
cube Class Reference

Meta-data object for a DeepSee cube. More...

Inheritance diagram for cube:
Collaboration diagram for cube:

Public Member Functions

def __init__ (self)
 Deprecated. More...
 
- 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...
 
- Public Member Functions inherited from Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 

Public Attributes

 abstract
 Optional. More...
 
 actionClass
 Optional. More...
 
 bitmapChunkInMemory
 Defines how to build indices for this cube. More...
 
 bucketSize
 Specifies the size of the caching buckets used for this cube. More...
 
 buildRestriction
 Optional. More...
 
 calculatedMembers
 Calculated members defined for this cube. More...
 
 caption
 This is used as the caption text when utilities display this cube. More...
 
 countMeasureCaption
 Optional. More...
 
 countMeasureName
 Optional. More...
 
 defaultListing
 Optional. More...
 
 defaultMeasure
 
 defaultMember
 
 dimensions
 Dimensions defined for this cube. More...
 
 disableListingGroups
 This setting controls whether the cube will accept the use of Listing Groups. More...
 
 enableSqlRestrict
 Enable use of the special MDX SQLRESTRICT clause with this cube. More...
 
 expressions
 Additional expressions defined for this cube. More...
 
 indices
 Additional indices defined for this cube. More...
 
 inheritsFrom
 Optional. More...
 
 initialBuildOrder
 Optional. More...
 
 listingFields
 Listing fields defined for this cube. More...
 
 listings
 Listings defined for this cube. More...
 
 maxFacts
 If defined, this specifies the maximum number of facts that are initially loaded into this cube. More...
 
 measures
 Measures defined for this cube. More...
 
 namedFactNums
 This flag controls how fact numbers are assigned. More...
 
 namedSets
 Named sets defined for this cube. More...
 
 nullReplacement
 Optional. More...
 
 owner
 This is the user name of the owner of this cube. More...
 
 precompute
 Specify if certain aggregates and counts should be pre-computed when this cube is built. More...
 
 relationships
 Relationships defined for this cube. More...
 
 resource
 Optional. More...
 
 sourceClass
 Name of class that provides the original data. More...
 
 version
 If a version number is present, on compile this class will generate a new class represetning this version of the cube. More...
 
- Public Attributes inherited from node
 additionalDescription
   More...
 
 description
 Optional description for this node. More...
 
 disabled
 Disabled flag. More...
 
 displayName
 Localized name of this element. More...
 
 isModified
 Client marker to track whether or not changes have been made too this item in the current session. More...
 
 name
 Logical name of this element. More...
 
- Public Attributes inherited from AbstractPortalModel
 ReadOnly
 Flag to indicate whether the current object should be handled in ReadOnly mode. More...
 
 Timestamp
 The most recent time that the underlying class definition was changed. More...
 

Private Member Functions

 ApplyOverridesForDocumatic ()
 JSL4414 – new method. More...
 
_.Library.Status AtScaleAddColumnsToCalendarDataset (pDataset, pAuxiliary)
 This Takes the information gathered into the pAuxiliary reference index during. More...
 
_.Library.Status AtScaleAddCustomSQLToDataset (pDataset, pAuxiliary)
 This Takes the information gathered into the pAuxiliary reference index during. More...
 
_.Library.DynamicAbstractObject AtScaleExport (_.Library.Status pStatus, _.Library.DynamicAbstractObject pRefIndex)
 Produce the structures needed to emit the appropriate JSON and export this item to AtScale.
 
_.Library.Status ProcessFunctions ()
 Build the list of available time functions.
 
_.Library.Status ResolveInheritance ()
 Resolve inheritance for this cube; combine its model with that of its base cube, if present. More...
 
_.Library.Status Validate ()
 Validate this cube model for logical errors.
 

Additional Inherited Members

- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 
- Static Public Attributes inherited from abstractNode
 XMLINCLUDEINGROUP = None
 Do not include this class in the XML groupings.
 
- 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 Public Attributes inherited from Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 

Detailed Description

Meta-data object for a DeepSee cube.


Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self)

Deprecated.

 

Deprecated.

 

Reimplemented from AbstractPortalModel.

Member Function Documentation

◆ ApplyOverridesForDocumatic()

ApplyOverridesForDocumatic ( )
private

JSL4414 – new method.

Not supported for direct use by customers.

◆ AtScaleAddColumnsToCalendarDataset()

_.Library.Status AtScaleAddColumnsToCalendarDataset (   pDataset,
  pAuxiliary 
)
private

This Takes the information gathered into the pAuxiliary reference index during.

the model search and adds the custom SQL and column information to the target dataset.

◆ AtScaleAddCustomSQLToDataset()

_.Library.Status AtScaleAddCustomSQLToDataset (   pDataset,
  pAuxiliary 
)
private

This Takes the information gathered into the pAuxiliary reference index during.

the model search and adds the custom SQL and column information to the target dataset.

◆ ResolveInheritance()

_.Library.Status ResolveInheritance ( )
private

Resolve inheritance for this cube; combine its model with that of its base cube, if present.

JSL4414 : Make this method not internal

Member Data Documentation

◆ abstract

abstract

Optional.

If true, then this cube definition is an "abstract" cube. It can be used as

a base cube for other cubes, but it cannot be built (loaded with data) or queried against.  

◆ actionClass

actionClass

Optional.

Name of a DeepSee KPI class that provides Dashboard Actions for this cube.

If provided, then a dashboard based on this cube will be able to invoke the actions defined within the given KPI class.  

◆ bitmapChunkInMemory

bitmapChunkInMemory

Defines how to build indices for this cube.


If true, DeepSee builds its indices using local memory which is a faster means of doing this. For cubes with many indices (dimensions and measures) or dimensions with a large number of members, the set of index values might not fit in local memory, leading to a <STORE> error when the cube is built. If this occurs, set this property to false to use a slower, non-local-memory algorithm (the default).  

◆ bucketSize

bucketSize

Specifies the size of the caching buckets used for this cube.


The bucket size is a number of data blocks, each containing 64000 facts. These are used to cache intermediate results by queries executed against this cube. For example, setting this to 10 would creates caching buckets that each contain 640000 facts.
In some cases, you may want to increase this value if you expect to have a large number of facts and do not expect many updates to older values within the cube.
If you change this value, you must be sure to delete all cached results for this cube. You can do this using the KillCache method of the cube definition class.
The default value is 8.  

◆ buildRestriction

buildRestriction

Optional.

If specified, this is placed in the WHERE clause applied to the SQL statement

used when this cube is initially built (by BuildCube). It must contain a valid SQL expression, e.g., "State='WY'"
This makes it possible to apply a restriction to the facts loaded into a cube, which may be useful in some cases.
This property is also used in the SQL queries used to update cubes. This property is ignored by cubes that use data connectors.
 

◆ calculatedMembers

calculatedMembers

Calculated members defined for this cube.


 

◆ caption

caption

This is used as the caption text when utilities display this cube.

This overrides the displayName property, if it is used.  

◆ countMeasureCaption

countMeasureCaption

Optional.

If defined, this is used as the (localized) display value for

the built-in Count measure.  

◆ countMeasureName

countMeasureName

Optional.

If defined, this is used as the logical name for

the built-in Count measure.  

◆ defaultListing

defaultListing

Optional.

If specified, this is the name of the listing

(in the <property>listing</property> list) that is used as the default RETURN clause for DRILLTHROUGH queries against this cube.  

◆ defaultMeasure

defaultMeasure

◆ defaultMember

defaultMember

◆ dimensions

dimensions

Dimensions defined for this cube.

 

◆ disableListingGroups

disableListingGroups

This setting controls whether the cube will accept the use of Listing Groups.

to define auxiliary listings.  

◆ enableSqlRestrict

enableSqlRestrict

Enable use of the special MDX SQLRESTRICT clause with this cube.

 

◆ expressions

expressions

Additional expressions defined for this cube.


This provides a way to compute a value that can be used in one or more source expressions when building this cube.  

◆ indices

indices

Additional indices defined for this cube.


This provides a way to add extra indices to the fact table for the cube.  

◆ inheritsFrom

inheritsFrom

Optional.

If true, this is the name of another, pre-existing, cube that this cube inherits from.

A cube can only inherit from one base cube; there is no possibility of multiple-inheritance.  

◆ initialBuildOrder

initialBuildOrder

Optional.

If specified, this is the ORDER BY clause applied to the SQL statement

used when this cube is initially built (by BuildCube). It must contain a valid ORDER BY clause, e.g., "DateOfBirth"
This makes it possible to apply an ordering to the initial facts loaded into a cube, which may be useful in some cases.
This property is ignored by cubes that use data connectors.
If this property is defined, then BuildCube will not use parallel processing. This ordering is not applied to incremental updates to the cube.  

◆ listingFields

listingFields

Listing fields defined for this cube.


 

◆ listings

listings

Listings defined for this cube.


If no listings are defined, then the Show Listing feature of the Analyzer will be disabled.  

◆ maxFacts

maxFacts

If defined, this specifies the maximum number of facts that are initially loaded into this cube.

by the BuildCube method.
Note that this does exactly what it says; there may be less than this number loaded. For example, the OnProcessFact method may be used to skip some records.
This is intended as a diagnostic aid when a cube is initially developed.  

◆ measures

measures

Measures defined for this cube.


 

◆ namedFactNums

namedFactNums

This flag controls how fact numbers are assigned.

If true, the compiler will expect

that the factNumber is set for measures, levels, and relationships.  

◆ namedSets

namedSets

Named sets defined for this cube.


 

◆ nullReplacement

nullReplacement

Optional.

If defined, this is used as the display value for

any members of any level within this cube whose value is null (missing) and has not has its local <property>nullReplacement</property> property set.  

◆ owner

owner

This is the user name of the owner of this cube.


This is used for determining some privileges for this cube.  

◆ precompute

precompute

Specify if certain aggregates and counts should be pre-computed when this cube is built.

If set to 0, then no precomputation is done. If set 1, counts and aggregates based on 1 level are computed. If set to 2, then combinations of 2 levels are used.
For small cubes (less than 1 million facts) this does not have a very big impact. For larger cubes this can help the initial performance of certain queries, though over time, the cell cache will naturally build up the same set of values that would have been precomputed.
The default value is 0.  

◆ relationships

relationships

Relationships defined for this cube.

 

◆ resource

resource

Optional.

The resource needed to view or edit this cube:

If defined and the current user holds the USE privilege on this resource, then the user may view (run queries against) this item.
If defined and the current user holds the WRITE privilege on this resource, then the user may modify this item.
 

◆ sourceClass

sourceClass

Name of class that provides the original data.


This should either be the name of persistent class or a subclass of <class>DeepSee.DataConnector</class>.
This is used to generate code that updates the cube from the original data.
It is also used to enable drill-through.  

◆ version

version

If a version number is present, on compile this class will generate a new class represetning this version of the cube.

and compile that. This new version can be built while the previous version is still active. Once activated, a new version will be queried.