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

Package | mx.olap
Class | public class OLAPResult
Inheritance | OLAPResult Object
Implements | IOLAPResult

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The OLAPResult class represents the result of a query on an OLAP cube.

See also

mx.olap.IOLAPResult
mx.olap.OLAPQuery
mx.olap.OLAPQueryAxis
mx.olap.IOLAPResultAxis
mx.olap.OLAPResultAxis

Public Properties

| Property | Defined By
--- | --- | ---
|  | axes : Array [read-only] An Array of IOLAPResultAxis instances that represent all the axes of the query. | OLAPResult
|  | COLUMN_AXIS : int = 0 [static] Specifies a column axis. | OLAPResult
|  | query : IOLAPQuery The query whose result is represented by this object. | OLAPResult
|  | ROW_AXIS : int = 1 [static] Specifies a row axis. | OLAPResult
|  | SLICER_AXIS : int = 2 [static] Specifies a slicer axis. | OLAPResult

Protected Properties

| Property | Defined By
--- | --- | ---
|  | cellData : Array An Array of Arrays that contains the value of each cell of the result. | OLAPResult

Public Methods

| Method | Defined By
--- | --- | ---
|  | getAxis(axisOrdinal:int):IOLAPResultAxis Returns an axis of the query result. | OLAPResult
|  | getCell(x:int, y:int):IOLAPCell Returns a cell at the specified location in the query result. | OLAPResult
|  | hasRowData(rowIndex:int):Boolean Returns true if the row contains data. | OLAPResult

Property Detail

axes | property

`axes:Array` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

An Array of IOLAPResultAxis instances that represent all the axes of the query.

Implementation
`public function get axes():Array`

cellData | property |

`protected var cellData:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

An Array of Arrays that contains the value of each cell of the result. A cell is an intersection of a row and a column axis position.

COLUMN_AXIS | property |

`public static var COLUMN_AXIS:int = 0`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies a column axis. Use this property as a value of the `axisOrdinal` argument to the `getAxis()` method.

query | property |

`query:IOLAPQuery`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The query whose result is represented by this object.

Implementation
`public function get query():IOLAPQuery`
`public function set query(value:IOLAPQuery):void`

ROW_AXIS | property |

`public static var ROW_AXIS:int = 1`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies a row axis. Use this property as a value of the `axisOrdinal` argument to the `getAxis()` method.

SLICER_AXIS | property |

`public static var SLICER_AXIS:int = 2`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies a slicer axis. Use this property as a value of the `axisOrdinal` argument to the `getAxis()` method.

Method Detail

getAxis | () | method

`public function getAxis(axisOrdinal:int):IOLAPResultAxis`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns an axis of the query result.

Parameters

| `axisOrdinal:int` — Specify `OLAPQuery.COLUMN AXIS` for a column axis, `OLAPQuery.ROW_AXIS` for a row axis, and `OLAPQuery.SLICER_AXIS` for a slicer axis.

Returns

| `IOLAPResultAxis` — The IOLAPQueryAxis instance.

getCell | () | method |

`public function getCell(x:int, y:int):IOLAPCell`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a cell at the specified location in the query result.

Parameters

| `x:int` — The column of the query result.
| `y:int` — The row of the query result.

Returns

| `IOLAPCell` — An IOLAPCell instance representing the cell.

hasRowData | () | method |

`public function hasRowData(rowIndex:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns `true` if the row contains data.

Parameters

| `rowIndex:int` — The index of the row in the result.

Returns

| `Boolean` — `true` if the row contains data, and `false` if not.

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