IRISLIB database
dimension Class Reference

Meta-data for a dimension within a DeepSee cube. More...

Inheritance diagram for dimension:
Collaboration diagram for dimension:

Public Attributes

 allCaption
 Optional. More...
 
 allDisplayName
 Optional. More...
 
 calendar
 Specifies which calendar is to be used if this is a time dimension. More...
 
 cube
 Cube that this dimension belongs to. More...
 
 hasAll
 Indicates whether this dimension has an "All" level. More...
 
 hidden
 If true, this dimension is hidden. More...
 
 hierarchies
 Set of hierarchies defined for this dimension. More...
 
 iKnowMeasure
 Optional. More...
 
 iKnowType
 Optional. More...
 
 sharesFrom
 Optional. More...
 
 showHierarchies
 If "true", then always display this dimension's hierarchies within the Analyzer. More...
 
 sourceExpression
 Optional expression used to get the value of this member. More...
 
 sourceProperty
 Name of the property in the source data that provides the. More...
 
 type
 Specifies what type of dimension this is. 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...
 

Private Member Functions

_.Library.DynamicAbstractObject AtScaleExport (_.Library.Status pStatus, _.Library.DynamicAbstractObject pAuxiliaryIndex)
 Produce the structures needed to emit the appropriate JSON and export this item to AtScale.
 
_.Library.Status Validate ()
 Test if this dimension's definition is valid.
 

Static Private Member Functions

_.Library.String GetSQLColumnName (_.Library.String pClass, _.Library.String pProp)
 Returns the SQL name of property pProp for class pClass.
 
_.Library.String GetSQLTableName (_.Library.String pClass)
 Return the SQL table name for the given class name.
 

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...
 
- 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...
 
- 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 for a dimension within a DeepSee cube.

Subclasses of this class are used to implement specific types of dimension.

Member Data Documentation

◆ allCaption

allCaption

Optional.

Specifies the name used for the All level for this dimension.

If not provided, then "All" + dimension name is used.  

◆ allDisplayName

allDisplayName

Optional.

Specifies the localized name used for the All level for this dimension.

If defined, this is the text displayed by DeepSee applications, otherwise the <property>allCaption</property> is used.  

◆ calendar

calendar

Specifies which calendar is to be used if this is a time dimension.

 

◆ cube

Cube that this dimension belongs to.

 

◆ hasAll

hasAll

Indicates whether this dimension has an "All" level.


The default is true.  

◆ hidden

hidden

If true, this dimension is hidden.

That is, it will not be listed among the

cube's members within the various DeepSee utilities.
It can still be used within MDX queries and expressions.  

◆ hierarchies

hierarchies

Set of hierarchies defined for this dimension.


Via a set of levels, a hierarchy defines a way in which this dimension can roll up.  

◆ iKnowMeasure

iKnowMeasure

Optional.

For "iKnow" dimensions, this is the name of the "iKnow" measure that provides the

data for this dimension.  

◆ iKnowType

iKnowType

Optional.

For "iKnow" dimensions, this provides a way to define the specific way in which

iKnow works with this dimension.  

◆ sharesFrom

sharesFrom

Optional.

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

dimension shares from. This means that the other cube has a dimension of the same name and that the dimensional tables of the other cube are used to track members of the dimension in this cube.  

◆ showHierarchies

showHierarchies

If "true", then always display this dimension's hierarchies within the Analyzer.

If "false", then never display hierarchies. If "default", then only show hierarchies if there is more than one hierarchy.
This has no effect on the operation of the cube.  

◆ sourceExpression

sourceExpression

Optional expression used to get the value of this member.


This can refer to properties of the source table using the syntax: "%source.Property".  

◆ sourceProperty

sourceProperty

Name of the property in the source data that provides the.

value for this element.
If specified, this is used as a default value for any level within this dimension that does not explicitly define a sourceProperty.
For time dimensions, this property must be defined.
Using dot syntax, it is possible to refer to a property within a related class, for example "City.Name" or "City.State.Name".  

◆ type

type

Specifies what type of dimension this is.


The type can be one of the following:

  • "measures" - reserved.
  • "data" - this dimension is based on data values supplied from a source property or expression. One or more dimension tables are generated to hold the set of possible values.
  • "time" - this dimension is based on time values. No dimension tables are generated, instead the hierarchy of time classes are used to process the values for this dimension.
  • "age" - similar to "time" except that the hierarchy of age classes are used to process the values for this dimension.
  • "computed" - a computed dimension that uses a special dimension class (<property>dimensionClass</property>) to process its values.
  • "iKnow" - a dimension that makes use of text processed by the iKnow Smart Indexing API. This must be linked to an "iKnow" measure (<property>iKnowMeasure</property>) which supplies the values for this dimension.

If not specified, then the type will be set to "data".