Class sap.ui.model.analytics.odata4analytics.DimensionModule: sap/ui/model/analytics/odata4analytics


Representation of a property annotated with sap:aggregation-role="dimension".

Constructor Summary
new sap.ui.model.analytics.odata4analytics.Dimension(oQueryResult, oProperty)Create a representation of a dimension provided by an analytic query.
Method Summary
findAttributeByName(sName)Find attribute by name
getAllAttributeNames()Get the names of all attributes included in this dimension
getAllAttributes()Get all attributes of this dimension
getContainingQueryResult()Get query result containing this dimension
getHierarchy()Get associated hierarchy
getKeyProperty()Get the key property
getLabelText()Get label
getMasterDataEntitySet()Get master data entity set for this dimension
getName()Get the name of the dimension
getSuperOrdinateDimension()Get super-ordinate dimension
getTextProperty()Get text property related to this dimension
hasMasterData()Get indicator whether or not master data is available for this dimension
Constructor Detail
new sap.ui.model.analytics.odata4analytics.Dimension(oQueryResult, oProperty)
Create a representation of a dimension provided by an analytic query. Do not create your own instances.
Parameters:
{sap.ui.model.analytics.odata4analytics.QueryResult}oQueryResult The query result containing this dimension
{object}oProperty The DataJS object object representing the dimension
Method Detail
Find attribute by name
Parameters:
{string}sName Attribute name
Returns:
{sap.ui.model.analytics.odata4analytics.Dimension} The dimension attribute object with this name or null if it does not exist
getAllAttributeNames(): array(string)
Get the names of all attributes included in this dimension
Returns:
{array(string)} List of all attribute names
getAllAttributes(): object
Get all attributes of this dimension
Returns:
{object} An object with individual JS properties for each attribute of this dimension. The JS object properties all are objects of type odata4analytics.DimensionAttribute. The names of the JS object properties are given by the OData entity type property names representing the dimension attribute keys.
Get query result containing this dimension
Returns:
{sap.ui.model.analytics.odata4analytics.QueryResult} The query result object
getHierarchy(): object
Get associated hierarchy
Returns:
{object} The hierarchy object or null if there is none. It can be an instance of class odata4analytics.RecursiveHierarchy (TODO later: or a leveled hierarchy). Use methods isLeveledHierarchy and isRecursiveHierarchy to determine object type.
getKeyProperty(): object
Get the key property
Returns:
{object} The DataJS object representing the property for the dimension key
getLabelText(): string
Get label
Returns:
{string} The (possibly language-dependent) label text for this dimension
Get master data entity set for this dimension
Returns:
{sap.ui.model.analytics.odata4analytics.EntitySet} The master data entity set for this dimension, or null, if it does not exist
getName(): string
Get the name of the dimension
Returns:
{string} The name of this dimension, which is identical to the name of the dimension key property in the entity type
getSuperOrdinateDimension(): object
Get super-ordinate dimension
Returns:
{object} The super-ordinate dimension or null if there is none
getTextProperty(): object
Get text property related to this dimension
Returns:
{object} The DataJS object representing the text property or null if it does not exist
hasMasterData(): boolean
Get indicator whether or not master data is available for this dimension
Returns:
{boolean} True iff master data is available