Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
IOLAPHierarchy

Package | mx.olap
Interface | public interface IOLAPHierarchy extends IOLAPElement
Implementors | OLAPHierarchy

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The IOLAPHierarchy interface represents a user-defined hierarchy in a dimension of an OLAP schema.

See also

mx.olap.OLAPHierarchy

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

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

Public Methods

| Method | Defined By
--- | --- | ---
|  | findLevel(name:String):IOLAPLevel Returns the level with the given name within the hierarchy. | IOLAPHierarchy
|  | findMember(name:String):IOLAPMember Returns the member with the given name within the hierarchy. | IOLAPHierarchy

Property Detail

allMemberName | property

`allMemberName:String` [read-only]

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`

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`

hasAll | property |

`hasAll:Boolean` [read-only]

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`

levels | property |

`levels:IList` [read-only]

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`

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`
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.

Wed Nov 15 2017, 09:50 AM +01:00