Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.olap 
OLAPAttribute 
Packagemx.olap
Classpublic class OLAPAttribute
InheritanceOLAPAttribute Inheritance OLAPHierarchy Inheritance OLAPElement Inheritance Proxy Inheritance Object
Implements IOLAPAttribute

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

The OLAPAttribute class represents a single attribute of an OLAPDimension. Use this class to associate a field of the flat data that is used to populate an OLAP cube with a level of the dimension.

MXML SyntaxexpandedHide MXML Syntax

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

  <mx:OLAPAttribute
    Properties
    dataField=""
  />
 
  

Default MXML Propertyelements

See also



Public Properties
 PropertyDefined By
 InheritedallMemberName : String
The name of the all member of the hierarchy.
OLAPHierarchy
 Inheritedchildren : 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
  dataCompareFunction : Function
User supplied callback function that would be used to compare the data elements while sorting the data.
OLAPAttribute
  dataField : String
The field of the input data set that provides the data for this OLAPAttribute instance.
OLAPAttribute
  dataFunction : Function
A callback function that returns the actual data for the attribute.
OLAPAttribute
 InheriteddefaultMember : 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
  displayNameFunction : Function
A callback function that returns the display name of a member element.
OLAPAttribute
  hasAll : Boolean
[override] Contains true becasue attributes are assumed to be aggregatable and all member is present.
OLAPAttribute
  members : IList
[override] [read-only] All members of all the levels that belong to this hierarchy, as a list of IOLAPMember instances.
OLAPAttribute
 Inheritedname : String
[override] 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
  
OLAPAttribute(name:String = null, displayName:String = null)
Constructor.
OLAPAttribute
 Inherited
Returns the level with the given name within the hierarchy.
OLAPHierarchy
 Inherited
Returns the member with the given name within the hierarchy.
OLAPHierarchy
 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

dataCompareFunction

property
public var dataCompareFunction:Function

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

User supplied callback function that would be used to compare the data elements while sorting the data. By default the data members would be compared directly.

dataField

property 
dataField:String

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 OLAPAttribute instance.



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

dataFunction

property 
dataFunction:Function

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

A callback function that returns the actual data for the attribute. Use this callback function to return computed data based on the actual data. For example, you can return the month name as a String from actual date that represents the month as a number. Or, you can calculate a value. For example, your input data contains the ages of people, such as 1, 4, 9, 10, 12, 15, or 20. Your callback function can return an age group that contains the age, as in 1-10, or 11-20.

The signature of the callback function is:

         function myDataFunction(rowData:Object, dataField:String):Object;
where rowData contains the data for the row of the input flat data, and dataField contains the name of the data field.

The function can return a String or a Number.

The following example returns the age group for each age value in the flat data:

         private function ageGroupingHandler(rowData:Object, field:String):Object
         {
             return rowData[field] / 10;
         } 



Implementation
    public function get dataFunction():Function
    public function set dataFunction(value:Function):void

displayNameFunction

property 
public var displayNameFunction:Function

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

A callback function that returns the display name of a member element. Flex calls this function for each member added to the OLAPAttribute instance.

The function signature is:

          function myDisplayNameFunction(memberName:String):String

where memberName contains the name of the element.

The function returns the display name of the element.

The following example converts a numeric group name, such as 1,2, or 3 into display names "0-9", "10-19":

          private function myDispFunction(name:String):String
          {
              var value:int = parseInt(name);
              return String((value)0 + " - ") + String((value+1)0-1);     
          }

hasAll

property 
hasAll:Boolean[override]

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

Contains true becasue attributes are assumed to be aggregatable and all member is present.



Implementation
    override public function get hasAll():Boolean
    override public function set hasAll(value:Boolean):void

members

property 
members:IList  [read-only] [override]

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

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
    override public function get members():IList
Constructor Detail

OLAPAttribute

()Constructor
public function OLAPAttribute(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 OLAPAttribute instance. You use this parameter to associate the OLAPAttribute instance with an OLAPLevel instance.
 
displayName:String (default = null) — The name of the attribute, as a String, which can be used for display.