Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
IOLAPDimension

Package | mx.olap
Interface | public interface IOLAPDimension extends IOLAPElement
Implementors | OLAPDimension

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The IOLAPDimension interface represents a dimension in an IOLAPCube instance.

See also

mx.olap.OLAPDimension

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | attributes : IList [read-only] The attributes of this dimension, as a list of OLAPAttribute instances. | IOLAPDimension
|  | cube : IOLAPCube [read-only] The cube to which this dimension belongs. | IOLAPDimension
|  | defaultMember : IOLAPMember [read-only] The default member of this dimension. | IOLAPDimension
|  | 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
|  | hierarchies : IList [read-only] All the hierarchies for this dimension, as a list of IOLAPHierarchy instances. | IOLAPDimension
|  | isMeasure : Boolean [read-only] Contains true if this is the measures dimension, which holds all the measure members. | IOLAPDimension
|  | members : IList [read-only] Returns all the members of this dimension, as a list of IOLAPMember instances. | IOLAPDimension
|  | 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
--- | --- | ---
|  | findAttribute(name:String):IOLAPAttribute Returns the attribute with the given name within the dimension. | IOLAPDimension
|  | findHierarchy(name:String):IOLAPHierarchy Returns the hierarchy with the given name within the dimension. | IOLAPDimension
|  | findMember(name:String):IOLAPMember Returns the member with the given name within the dimension. | IOLAPDimension

Property Detail

attributes | property

`attributes:IList` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The attributes of this dimension, as a list of OLAPAttribute instances.

Implementation
`public function get attributes():IList`

cube | property |

`cube:IOLAPCube` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The cube to which this dimension belongs.

Implementation
`public function get cube():IOLAPCube`

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 this dimension.

Implementation
`public function get defaultMember():IOLAPMember`

hierarchies | property |

`hierarchies:IList` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

All the hierarchies for this dimension, as a list of IOLAPHierarchy instances.

Implementation
`public function get hierarchies():IList`

isMeasure | property |

`isMeasure:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Contains `true` if this is the measures dimension, which holds all the measure members.

Implementation
`public function get isMeasure():Boolean`

members | property |

`members:IList` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns all the members of this dimension, 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

findAttribute | () | method

`public function findAttribute(name:String):IOLAPAttribute`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns the attribute with the given name within the dimension.

Parameters

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

Returns

| `IOLAPAttribute` — An IOLAPAttribute instance representing the attribute, or null if an attribute is not found.

findHierarchy | () | method |

`public function findHierarchy(name:String):IOLAPHierarchy`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns the hierarchy with the given name within the dimension.

Parameters

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

Returns

| `IOLAPHierarchy` — An IOLAPHierarchy instance representing the hierarchy, or null if a hierarchy 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 dimension.

Parameters

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

Returns

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

Sun Mar 5 2017, 03:42 PM +11:00