(Flex Data Visualization components only)
Packagemx.olap
Classpublic class OLAPDimension
InheritanceOLAPDimension Inheritance OLAPElement Inheritance Proxy Inheritance Object
Implements IOLAPDimension

The OLAPDimension class represents a dimension of an OLAP cube.

MXML SyntaxexpandedHide MXML Syntax

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

  <mx:OLAPDimension
    Properties
    attributes=""
    elements=""
    hierarchies=""
   />

Default MXML Propertyelements

See also

mx.olap.IOLAPDimension
Creating an OLAP schema
Creating an OLAP schema

Public Properties
 PropertyDefined By
  attributes : IList
The attributes of this dimension, as a list of OLAPAttribute instances.
OLAPDimension
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  cube : IOLAPCube
The cube to which this dimension belongs.
OLAPDimension
  defaultMember : IOLAPMember
[read-only] The default member of this dimension.
OLAPDimension
 InheriteddisplayName : String
The name of the OLAP element, as a String, which can be used for display.
OLAPElement
  elements : Array
[write-only] Processes the input Array and initializes the attributes and hierarchies properties based on the elements of the Array.
OLAPDimension
  hierarchies : IList
All the hierarchies for this dimension, as a list of IOLAPHierarchy instances.
OLAPDimension
  isMeasure : Boolean
[read-only] Contains true if this is the measures dimension, which holds all the measure members.
OLAPDimension
  members : IList
[read-only] Returns all the members of this dimension, as a list of IOLAPMember instances.
OLAPDimension
 Inheritedname : String
The name of the OLAP element that includes the OLAP schema hierarchy of the element.
OLAPElement
 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
  
OLAPDimension(name:String = null, displayName:String = null)
Constructor
OLAPDimension
  
findAttribute(name:String):IOLAPAttribute
Returns the attribute with the given name within the dimension.
OLAPDimension
  
findHierarchy(name:String):IOLAPHierarchy
Returns the hierarchy with the given name within the dimension.
OLAPDimension
  
findMember(name:String):IOLAPMember
Returns the member with the given name within the dimension.
OLAPDimension
 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
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
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
attributesproperty
attributes:IList

The attributes of this dimension, as a list of OLAPAttribute instances.



Implementation
    public function get attributes():IList
    public function set attributes(value:IList):void
cubeproperty 
cube:IOLAPCube

The cube to which this dimension belongs.



Implementation
    public function get cube():IOLAPCube
    public function set cube(value:IOLAPCube):void
defaultMemberproperty 
defaultMember:IOLAPMember  [read-only]

The default member of this dimension.



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

Processes the input Array and initializes the attributes and hierarchies properties based on the elements of the Array. Attributes are represented in the Array by instances of the OLAPAttribute class, and hierarchies are represented by instances of the OLAPHierarchy class.

Use this property to define the attributes and hierarchies of a cube in a single Array.



Implementation
    public function set elements(value:Array):void
hierarchiesproperty 
hierarchies:IList

All the hierarchies for this dimension, as a list of IOLAPHierarchy instances.



Implementation
    public function get hierarchies():IList
    public function set hierarchies(value:IList):void
isMeasureproperty 
isMeasure:Boolean  [read-only]

Contains true if this is the measures dimension, which holds all the measure members.



Implementation
    public function get isMeasure():Boolean
membersproperty 
members:IList  [read-only]

Returns all the members of this dimension, 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
Constructor Detail
OLAPDimension()Constructor
public function OLAPDimension(name:String = null, displayName:String = null)

Constructor

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

Returns the attribute with the given name within the dimension.

Parameters

name:String — The name of the attribute.

Returns
IOLAPAttribute — An IOLAPAttribute instance representing the attribute, or null if an attribute is not found.
findHierarchy()method 
public function findHierarchy(name:String):IOLAPHierarchy

Returns the hierarchy with the given name within the dimension.

Parameters

name:String — The name of the hierarchy.

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

Returns the member with the given name within the dimension.

Parameters

name:String — The name of the member.

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



© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Aug 13 2009, 03:11 AM -07:00