(Flex Data Visualization components only)
Packagemx.olap
Classpublic class OLAPHierarchy
InheritanceOLAPHierarchy Inheritance OLAPElement Inheritance Proxy Inheritance Object
Implements IOLAPHierarchy
Subclasses OLAPAttribute

The OLAPHierarchy class represents a hierarchy of the schema of an OLAP cube.

MXML SyntaxexpandedHide MXML Syntax

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

  <mx:OLAPHierarchy
    Properties
    allMemberName="(All)"
    elements="An array of Levels of this hierarchy"
    hasAll="true|false"
    name="No default"
  />

Default MXML Propertyelements

See also

mx.olap.IOLAPHierarchy

Public Properties
 PropertyDefined By
  allMemberName : String
The name of the all member of the hierarchy.
OLAPHierarchy
  children : IList
[read-only] The children of the all member, as a list of IOLAPMember instances.
OLAPHierarchy
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  defaultMember : IOLAPMember
[read-only] The default member of the hierarchy.
OLAPHierarchy
 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
  elements : Array
[write-only] An Array of the levels of the hierarchy, as OLAPLevel instances.
OLAPHierarchy
  hasAll : Boolean
Specifies whether the hierarchy has an all member, true, or not, false.
OLAPHierarchy
  levels : IList
All the levels of this hierarchy, as a list of IOLAPLevel instances.
OLAPHierarchy
  members : IList
[read-only] All members of all the levels that belong to this hierarchy, as a list of IOLAPMember instances.
OLAPHierarchy
  name : String
User defined name of this hierarchy.
OLAPHierarchy
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheriteduniqueName : String
[read-only] The unique name of the OLAP element in the cube.
OLAPElement
Public Methods
 MethodDefined By
  
OLAPHierarchy(name:String = null, displayName:String = null)
Constructor
OLAPHierarchy
  
findLevel(name:String):IOLAPLevel
Returns the level with the given name within the hierarchy.
OLAPHierarchy
  
findMember(name:String):IOLAPMember
Returns the member with the given name within the hierarchy.
OLAPHierarchy
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns the unique name of the element.
OLAPElement
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
allMemberNameproperty
allMemberName:String  [read-write]

The name of the all member of the hierarchy.

The default value is "(All)".


Implementation
    public function get allMemberName():String
    public function set allMemberName(value:String):void
childrenproperty 
children:IList  [read-only]

The children of the all member, as a list of IOLAPMember instances.


Implementation
    public function get children():IList
defaultMemberproperty 
defaultMember:IOLAPMember  [read-only]

The default member of the hierarchy. The default member is used if the hierarchy is used where a member is expected.


Implementation
    public function get defaultMember():IOLAPMember
elementsproperty 
elements:Array  [write-only]

An Array of the levels of the hierarchy, as OLAPLevel instances.


Implementation
    public function set elements(value:Array):void
hasAllproperty 
hasAll:Boolean  [read-write]

Specifies whether the hierarchy has an all member, true, or not, false. If true, the all member name is as specified by the allMemberName property.

The default value is true.


Implementation
    public function get hasAll():Boolean
    public function set hasAll(value:Boolean):void
levelsproperty 
levels:IList  [read-write]

All the levels of this hierarchy, as a list of IOLAPLevel instances. The returned list might represent remote data and therefore can throw an ItemPendingError.


Implementation
    public function get levels():IList
    public function set levels(value:IList):void
membersproperty 
members:IList  [read-only]

All members of all the levels that belong to this hierarchy, as a list of IOLAPMember instances. The returned list might represent remote data and therefore can throw an ItemPendingError.


Implementation
    public function get members():IList
nameproperty 
name:String  [read-write]

User defined name of this hierarchy. If user has not set a explicit name then the dimension name is returned.


Implementation
    public function get name():String
    public function set name(value:String):void
Constructor Detail
OLAPHierarchy()Constructor
public function OLAPHierarchy(name:String = null, displayName:String = null)

Constructor

Parameters
name:String (default = null) — The name of the OLAP level that includes the OLAP schema hierarchy of the element.
 
displayName:String (default = null) — The name of the OLAP level, as a String, which can be used for display.
Method Detail
findLevel()method
public function findLevel(name:String):IOLAPLevel

Returns the level with the given name within the hierarchy.

Parameters

name:String — The name of the level.

Returns
IOLAPLevel — An IOLAPLevel instance representing the level, or null if a level is not found.
findMember()method 
public function findMember(name:String):IOLAPMember

Returns the member with the given name within the hierarchy.

Parameters

name:String — The name of the member.

Returns
IOLAPMember — An IOLAPMember instance representing the member, or null if a member is not found.



© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Fri Feb 15 2008, 2:47 AM GMT-08:00