mx.olap

# OLAPTuple - AS3 Flex

Package | mx.olap
Class | public class OLAPTuple
Inheritance | OLAPTuple Object
Implements | IOLAPTuple

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The OLAPTuple class reprsents a tuple expression pointing to an OLAP cube cell. A tuple is made up of one member from every dimension that is contained within a cube. The complete expression of a tuple identifier is made up of one or more explicitly specified members, in parentheses. A tuple can be fully qualified, can contain implicit members, or can contain a single member. Any dimension that is not explicitly referenced within a tuple is implicitly referenced.

The member for the implicitly referenced dimension depends on the structure of the dimension:

- If the implicitly referenced dimension has a default member, the default member is added to the tuple.
- If the implicitly referenced dimension has no default member, the (All) member of the default hierarchy is used.
- If the implicitly referenced dimension has no default member, and the default hierarchy has no (All) member, the first member of the topmost level of the default hierarchy is used.

Related API Elements

mx.olap.IOLAPTuple

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
|  | explicitMembers : IList [read-only] The user added members of this tuple, as a list of IOLAPMember instances. | OLAPTuple

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | OLAPTuple() Constructor | OLAPTuple
|  | addMember(element:IOLAPElement):void Adds a new member to the tuple. | OLAPTuple
|  | addMembers(value:IList):void Adds a list of members to the tuple. | OLAPTuple
|  | 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

### explicitMembers

property

`explicitMembers:IList` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The user added members of this tuple, as a list of IOLAPMember instances.

Implementation
`public function get explicitMembers():IList`
Constructor Detail

### OLAPTuple

()
Constructor

`public function OLAPTuple()`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor

Method Detail

### addMember

()
method

`public function addMember(element:IOLAPElement):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Adds a new member to the tuple.

Parameters

| `element:IOLAPElement` — The member to add. If `member` is a dimension or hierarchy, its default member is added. If `member` is an instance of IOLAPMember, it is added directly.

### addMembers

()
method

`public function addMembers(value:IList):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Adds a list of members to the tuple. This method can be called when many members need to be added to the tuple.

Parameters

| `value:IList` — The members to add, as a list of IOLAPMember instances.

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