IRISLIB database
All Classes Namespaces Functions Variables Pages
level Class Reference

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

Inheritance diagram for level:
Collaboration diagram for level:

Public Member Functions

def __init__ (self)
 Optional. 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...
 

Static Public Member Functions

_.Library.Status timeFunctionIsValid (_, val)
 Override default validation to allow for additional time classes.
 
- 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...
 

Public Attributes

 castAsNumeric
 If true, the engine will treat the members of this level as numbers. More...
 
 dependsOn
 If defined, this is an MDX expression identifying another level within this cube. More...
 
 factNumber
 Define a stable fact number for this level. More...
 
 hidden
 If true, this level is hidden. More...
 
 hierarchy
 Hierarchy that this level belongs to. More...
 
 list
 If true, then the value for this level contains a list of items. More...
 
 listDelimiter
 Optional. More...
 
 memberList
 
 members
 Optional. More...
 
 nullReplacement
 Optional. More...
 
 properties
 Set of properties defined for this level. More...
 
 rangeExpression
 Optional. More...
 
 sort
 If specified, then use this property to define the default sort order for members of the current level. More...
 
 useAsFilter
 If true (the default), then this level can be used a filter within a dashboard. More...
 
 useDisplayValue
 If true, then use the display (external) value of the field (if applicable) in the source. 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 source
 factName
 Optional. More...
 
 factSelectivity
 Optional. More...
 
 linkClass
 Optional. More...
 
 linkProperty
 Optional. 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...
 

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.
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self)

Optional.

If defined, this is a comma-delimited list of the members that

are to be displayed for this level in the given order.
This is deprecated in favor of the <property>members</property> collection.  

Reimplemented from node.

Member Data Documentation

◆ castAsNumeric

castAsNumeric

If true, the engine will treat the members of this level as numbers.

 

◆ dependsOn

dependsOn

If defined, this is an MDX expression identifying another level within this cube.

that this level depends on, e.g., "[Outlet].[H1].[City]"
This causes the following changes to this cube.

  1. An additional index is created based on the "master" level's fact and this level's fact.
  2. When the set of members for this level is produced it is filtered using this index.

 

◆ factNumber

factNumber

Define a stable fact number for this level.

 

◆ hidden

hidden

If true, this level 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.  

◆ hierarchy

Hierarchy that this level belongs to.

 

◆ list

list

If true, then the value for this level contains a list of items.

Each

distinct item is treated as a member of this level.
By default the list consists of a $List of items. You can also use a character-delimited list by setting the <property>listDelimiter</property> attribute.
A <property>nullReplacement</property> for a list property is applied when the entire list is missing. Missing elements within a list are simply ignored.  

◆ listDelimiter

listDelimiter

Optional.

If the <property>list</property> attribute for this level is true, then

setting this will cause the list to be interpreted as a character delimited value using this attribute as the delimiter character.  

◆ memberList

memberList

◆ members

members

Optional.

Set of explicitly defined members for this level.

If defined, this is a list of the members that are to be displayed for this level in the given order.
 

◆ nullReplacement

nullReplacement

Optional.

If defined, this is used as the display value for

any members of this level whose value is null (missing).
If not defined, then missing members will not be listed by queries.
This cannot be used for levels within time dimensions or for levels that contain a list of values (see <property>list</property>).  

◆ properties

properties

Set of properties defined for this level.


 

◆ rangeExpression

rangeExpression

Optional.

If defined, this contains a range expression that transforms incoming

values according to a set of range conditions.
A range condition is a string containing one or more range conditions. Each condition has a test value and a replacement value of the form "test:replace;" A test value can contain a single value or a range. A range is enclosed with () (exclusive) or [] (inclusive).
For example:
"(,0]:Below Normal;(0,100):Normal;[100,):Above Normal;" This cannot be used for levels within time dimensions or for levels that contain a list of values (see <property>list</property>).
Range expressions are applied before null value substitution.
Values that do not match any range condition are converted to null.
 

◆ sort

sort

If specified, then use this property to define the default sort order for members of the current level.


The value can be "asc" for ascending order, "desc" for descending order, "asc numeric" for ascending numeric order, or "desc numeric" for descending numeric order.
For more precise control, you can specify sort order within the property definitions associated with this level.  

◆ useAsFilter

useAsFilter

If true (the default), then this level can be used a filter within a dashboard.

If false,

it is still visible to the Analyzer, but is not listed as a choice for a widget filter.
This has no effect on the operation of the cube.  

◆ useDisplayValue

useDisplayValue

If true, then use the display (external) value of the field (if applicable) in the source.

table when fetching data for this level.
This is only applied for levels that specify a <property>sourceProperty</property>.