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

Package | mx.olap
Interface | public interface IOLAPSet
Implementors | OLAPSet

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The IOLAPSet interface represents a set, which is used to configure the axis of an OLAP query.

See also

mx.olap.OLAPSet
mx.olap.OLAPQueryAxis
mx.olap.IOLAPResultAxis
mx.olap.OLAPResultAxis

Public Methods

| Method | Defined By
--- | --- | ---
|  | addElement(element:IOLAPElement):void Adds a new member to the set. | IOLAPSet
|  | addElements(elements:IList):void Adds a list of members to the set. | IOLAPSet
|  | addTuple(tuple:IOLAPTuple):void Adds a new tuple to the set. | IOLAPSet
|  | crossJoin(input:IOLAPSet):IOLAPSet Returns a new IOLAPSet instance that contains a crossjoin of this IOLAPSet instance and input. | IOLAPSet
|  | hierarchize(post:Boolean = false):IOLAPSet Returns a new IOLAPSet that is hierarchized version of this set. | IOLAPSet
|  | union(input:IOLAPSet):IOLAPSet Returns a new IOLAPSet instance that contains a union of this IOLAPSet instance and input. | IOLAPSet

Method Detail

addElement | () | method

`public function addElement(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 set.

This method adds the appropriate elements to the set, depending on the type of element passed in. If an IOLAPHierarchy element is passed, it adds the default member of the hierarchy. If an IOLAPLevel element is passed, it adds all the members of the level. If an IOLAPMember element is passed, it is added to the set.

Parameters

| `element:IOLAPElement` — The member to add. If `element` is a hierarchy or level, its members are added. If `element` is an instance of IOLAPMember, it is added directly. A new tuple is created for each member.

addElements | () | method |

`public function addElements(elements: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 set. This method can be called when members or children of a hierarchy or member need to be added to the set.

Parameters

| `elements:IList` — The members to add, as a list of IOLAPMember instances. A new tuple is created for each member.

addTuple | () | method |

`public function addTuple(tuple:IOLAPTuple):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Adds a new tuple to the set.

Parameters

| `tuple:IOLAPTuple` — The tuple to add.

crossJoin | () | method |

`public function crossJoin(input:IOLAPSet):IOLAPSet`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a new IOLAPSet instance that contains a crossjoin of this IOLAPSet instance and `input`.

Parameters

| `input:IOLAPSet` — An IOLAPSet instance.

Returns

| `IOLAPSet` — An IOLAPSet instance that contains a crossjoin of this IOLAPSet instance and `input`.

hierarchize | () | method |

`public function hierarchize(post:Boolean = false):IOLAPSet`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a new IOLAPSet that is hierarchized version of this set.

Parameters

| `post:Boolean` (default = `false`)`` — If `true` indicates that children should precede parents. By default, parents precede children.

Returns

| `IOLAPSet` — A new IOLAPSet that is hierarchized version of this set.

union | () | method |

`public function union(input:IOLAPSet):IOLAPSet`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a new IOLAPSet instance that contains a union of this IOLAPSet instance and `input`.

Parameters

| `input:IOLAPSet` — An IOLAPSet instance.

Returns

| `IOLAPSet` — An IOLAPSet instance that contains a union of this IOLAPSet instance and `input`.

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