mx.olap.OLAPQuery - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.olap
Class	public class OLAPQuery
Inheritance	OLAPQuery Object
Implements	IOLAPQuery

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The OLAPQuery interface represents an OLAP query that is executed on an IOLAPCube.

MXML Syntax expanded

Hide MXML Syntax

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

  <mx:OLAPQuery
    Properties
       axis=""
  />

Default MXML Propertyaxes

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		axes : Array The axis of the Query as an Array of OLAPQueryAxis instances.	OLAPQuery
		COLUMN_AXIS : int = 0 [static] Specifies a column axis.	OLAPQuery
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		ROW_AXIS : int = 1 [static] Specifies a row axis.	OLAPQuery
		SLICER_AXIS : int = 2 [static] Specifies a slicer axis.	OLAPQuery

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		getAxis(axisOrdinal:int):IOLAPQueryAxis Gets an axis from the query.	OLAPQuery
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setAxis(axisOrdinal:int, axis:IOLAPQueryAxis):void Sets an axis to the query.	OLAPQuery
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

axes

property

axes:Array

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The axis of the Query as an Array of OLAPQueryAxis instances. A query can have three axes: column, row, and slicer.

Implementation
public function get axes():Array
public function set axes(value:Array):void

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.

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):IOLAPQueryAxis

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Gets an axis from the query. You typically call this method to obtain an uninitialized IOLAPQueryAxis instance, then configure the IOLAPQueryAxis instance for the query.

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

IOLAPQueryAxis — The IOLAPQueryAxis instance.

setAxis

()

method

public function setAxis(axisOrdinal:int, axis:IOLAPQueryAxis):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Sets an axis to the query.

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.

	`axis:IOLAPQueryAxis` — The IOLAPQueryAxis instance.