mx.olap

# OLAPHierarchy - AS3 Flex

Package | mx.olap
Class | public class OLAPHierarchy
Inheritance | OLAPHierarchy OLAPElement Proxy
Implements | IOLAPHierarchy
Subclasses | OLAPAttribute

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The OLAPHierarchy class represents a hierarchy of the schema of an OLAP cube.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<mx:OLAPHierarchy>` tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

      <mx:OLAPHierarchy
        Properties
        allMemberName="(All)"
        elements="An array of Levels of this hierarchy"
        hasAll="true|false"
        name="No default"
      />

Default MXML Property `elements`

More examples

Creating an OLAP schema

Learn more

About OLAP data grids

Related API Elements

mx.olap.IOLAPHierarchy

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | allMemberName : String The name of the all member of the hierarchy. | OLAPHierarchy
|  | children : IList [read-only] The children of the all member, as a list of IOLAPMember instances. | OLAPHierarchy
|  | defaultMember : IOLAPMember [read-only] The default member of the hierarchy. | OLAPHierarchy
|  | dimension : IOLAPDimension The dimension to which this element belongs. | OLAPElement
|  | displayName : String The name of the OLAP element, as a String, which can be used for display. | OLAPElement
|  | elements : Array [write-only] An Array of the levels of the hierarchy, as OLAPLevel instances. | OLAPHierarchy
|  | hasAll : Boolean Specifies whether the hierarchy has an all member, true, or not, false. | OLAPHierarchy
|  | levels : IList All the levels of this hierarchy, as a list of IOLAPLevel instances. | OLAPHierarchy
|  | members : IList [read-only] All members of all the levels that belong to this hierarchy, as a list of IOLAPMember instances. | OLAPHierarchy
|  | name : String [override] User defined name of this hierarchy. | OLAPHierarchy
|  | uniqueName : String [read-only] The unique name of the OLAP element in the cube. | OLAPElement

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | OLAPHierarchy(name:String = null, displayName:String = null) Constructor | OLAPHierarchy
|  | findLevel(name:String):IOLAPLevel Returns the level with the given name within the hierarchy. | OLAPHierarchy
|  | findMember(name:String):IOLAPMember Returns the member with the given name within the hierarchy. | OLAPHierarchy
|  | toString():String Returns the unique name of the element. | OLAPElement

Property Detail

### allMemberName

property

`allMemberName:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The name of the all member of the hierarchy.

The default value is `"(All)".`

Implementation
`public function get allMemberName():String`
`public function set allMemberName(value:String):void`

### children

property

`children:IList` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The children of the all member, as a list of IOLAPMember instances.

Implementation
`public function get children():IList`

### defaultMember

property

`defaultMember:IOLAPMember` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The default member of the hierarchy. The default member is used if the hierarchy is used where a member is expected.

Implementation
`public function get defaultMember():IOLAPMember`

### elements

property

`elements:Array` [write-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

An Array of the levels of the hierarchy, as OLAPLevel instances.

Implementation
`public function set elements(value:Array):void`

### hasAll

property

`hasAll:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Specifies whether the hierarchy has an all member, `true`, or not, `false`. If `true`, the all member name is as specified by the `allMemberName` property.

The default value is `true.`

Implementation
`public function get hasAll():Boolean`
`public function set hasAll(value:Boolean):void`

### levels

property

`levels:IList`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

All the levels of this hierarchy, as a list of IOLAPLevel instances. The returned list might represent remote data and therefore can throw an ItemPendingError.

Implementation
`public function get levels():IList`
`public function set levels(value:IList):void`

### members

property

`members:IList` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

All members of all the levels that belong to this hierarchy, as a list of IOLAPMember instances. The returned list might represent remote data and therefore can throw an ItemPendingError.

Implementation
`public function get members():IList`

### name

property

`name:String`[override]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

User defined name of this hierarchy. If user has not set a explicit name then the dimension name is returned.

Implementation
`override public function get name():String`
`override public function set name(value:String):void`
Constructor Detail

### OLAPHierarchy

()
Constructor

`public function OLAPHierarchy(name:String = null, displayName:String = null)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor

Parameters

| `name:String` (default = `null`)`` — The name of the OLAP level that includes the OLAP schema hierarchy of the element.
| `displayName:String` (default = `null`)`` — The name of the OLAP level, as a String, which can be used for display.

Method Detail

### findLevel

()
method

`public function findLevel(name:String):IOLAPLevel`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the level with the given name within the hierarchy.

Parameters

| `name:String` — The name of the level.

Returns

| `IOLAPLevel` — An IOLAPLevel instance representing the level, or null if a level is not found.

### findMember

()
method

`public function findMember(name:String):IOLAPMember`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the member with the given name within the hierarchy.

Parameters

| `name:String` — The name of the member.

Returns

| `IOLAPMember` — An IOLAPMember instance representing the member, or null if a member is not found.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00