Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.olap 
OLAPLevel 
Packagemx.olap
Classpublic class OLAPLevel
InheritanceOLAPLevel Inheritance OLAPElement Inheritance Proxy Inheritance Object
Implements IOLAPLevel

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The OLAPLevel class represents a level in an OLAP cube.

MXML SyntaxexpandedHide MXML Syntax

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

  <mx:OLAPLevel
    Properties
    attributeName=""
  />
 
  

See also



Public Properties
 PropertyDefined By
  attribute : OLAPAttribute
[read-only] The attribute connected to this level, as an instance of OLAPAttribute.
OLAPLevel
  attributeName : String
The name of the attribute to be used at this level.
OLAPLevel
  child : IOLAPLevel
[read-only] The next child level in the hierarchy.
OLAPLevel
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataField : String
[read-only] The field of the input data set that provides the data for this OLAPLevel instance.
OLAPLevel
  depth : int
[read-only] The depth of the level in the hierarchy of the dimension.
OLAPLevel
 Inheriteddimension : IOLAPDimension
The dimension to which this element belongs.
OLAPElement
 InheriteddisplayName : String
The name of the OLAP element, as a String, which can be used for display.
OLAPElement
  hierarchy : IOLAPHierarchy
The hierarchy of the dimension to which this level belongs.
OLAPLevel
  members : IList
[read-only] The members of this level, as a list of IOLAPMember instances, or null if a member is not found.
OLAPLevel
  name : String
[override] The value of the name property of the OLAPAttribute instance associated with this OLAPLevel instance.
OLAPLevel
  parent : IOLAPLevel
[read-only] The parent level of this level, or null if this level is not nested in another level.
OLAPLevel
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  uniqueName : String
[override] [read-only] The unique name of the OLAP element in the cube.
OLAPLevel
Public Methods
 MethodDefined By
  
OLAPLevel(name:String = null, displayName:String = null)
Constructor
OLAPLevel
  
Returns the members with the given name within the hierarchy.
OLAPLevel
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the unique name of the element.
OLAPElement
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

attribute

property
attribute:OLAPAttribute  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The attribute connected to this level, as an instance of OLAPAttribute.



Implementation
    public function get attribute():OLAPAttribute

attributeName

property 
attributeName:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The name of the attribute to be used at this level. The value of this property corresponds to the value of the OLAPAttribute.name property for the corresponding attribute.



Implementation
    public function get attributeName():String
    public function set attributeName(value:String):void

child

property 
child:IOLAPLevel  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The next child level in the hierarchy.



Implementation
    public function get child():IOLAPLevel

dataField

property 
dataField:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The field of the input data set that provides the data for this OLAPLevel instance.



Implementation
    public function get dataField():String

depth

property 
depth:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The depth of the level in the hierarchy of the dimension.



Implementation
    public function get depth():int

hierarchy

property 
hierarchy:IOLAPHierarchy

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The hierarchy of the dimension to which this level belongs.



Implementation
    public function get hierarchy():IOLAPHierarchy
    public function set hierarchy(value:IOLAPHierarchy):void

members

property 
members:IList  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The members of this level, as a list of IOLAPMember instances, or null if a member is not found. The list might represent remote data and therefore can throw an ItemPendingError.



Implementation
    public function get members():IList

name

property 
name:String[override]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The value of the name property of the OLAPAttribute instance associated with this OLAPLevel instance. Even though this property is writable, its value is determned by the OLAPAttribute instance associated with the level and cannot be set.



Implementation
    override public function get name():String
    override public function set name(value:String):void

parent

property 
parent:IOLAPLevel  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The parent level of this level, or null if this level is not nested in another level.



Implementation
    public function get parent():IOLAPLevel

uniqueName

property 
uniqueName:String  [read-only] [override]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The unique name of the OLAP element in the cube. For example, "[Time][Year][2007]" is a unique name, where 2007 is the element name belonging to the "Year" level of the "Time" dimension.



Implementation
    override public function get uniqueName():String
Constructor Detail

OLAPLevel

()Constructor
public function OLAPLevel(name:String = null, displayName:String = null)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor

Parameters
name:String (default = null) — The name of the OLAP level that includes the OLAP schema hierarchy of the element. For example, "Time_Year", where "Year" is a level of the "Time" dimension in an OLAP schema.
 
displayName:String (default = null) — The name of the OLAP level, as a String, which can be used for display.
Method Detail

findMember

()method
public function findMember(name:String):IList

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the members with the given name within the hierarchy.

Parameters

name:String — The name of the member.

Returns
IList — A list of IOLAPMember instances representing the members, or null if a member is not found.