mx.olap

# OLAPSchema - AS3 Flex

Package | mx.olap
Class | public class OLAPSchema
Inheritance | OLAPSchema Object
Implements | IOLAPSchema

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The OLAPSchema class represents an OLAP cube or cubes.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

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

      <mx:OLAPSchema
        Properties
           cubeArray=""
      />

Default MXML Property `cubeArray`

More examples

Creating an OLAP schema
Specifying the aggregation method for a measure
Creating a schema dimension
Creating a default member in a schema

Learn more

About OLAP data grids
About OLAP schemas

Related API Elements

mx.olap.IOLAPSchema
mx.olap.OLAPCube

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | cubeArray : Array [write-only] Lets you set the cubes of a schema by passing an Array of IOLAPCube instances. | OLAPSchema
|  | cubes : IList All the cubes known by this schema, as a list of IOLAPCube instances. | OLAPSchema

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | createCube(name:String):IOLAPCube Creates an OLAP cube from the schema. | OLAPSchema
|  | getCube(name:String):IOLAPCube Returns a cube specified by name. | OLAPSchema
|  | 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
|  | 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

### cubeArray

property

`cubeArray:Array` [write-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Lets you set the cubes of a schema by passing an Array of IOLAPCube instances.

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

### cubes

property

`cubes:IList`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

All the cubes known by this schema, as a list of IOLAPCube instances. The returned list might represent remote data and therefore can throw an ItemPendingError.

Implementation
`public function get cubes():IList`
`public function set cubes(value:IList):void`
Method Detail

### createCube

()
method

`public function createCube(name:String):IOLAPCube`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Creates an OLAP cube from the schema.

Parameters

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

Returns

| `IOLAPCube` — The IOLAPCube instance.

### getCube

()
method

`public function getCube(name:String):IOLAPCube`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns a cube specified by name.

Parameters

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

Returns

| `IOLAPCube` — The IOLAPCube instance, or null if one is not found.

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