new MetricToken()
Do NOT instantiate this class directly. Token objects
should be accessed and modified through the Oracle.BDD.Portlets.Visualization.Model.QueryConfig#getToken
function ONLY.
- Source:
Extends
Methods
getAggregationFunction() → {string}
Gets the attribute aggregation function for the token of the given name
- Source:
Returns:
The token's aggregation function
- Type
- string
getAttributeKey() → {string}
Gets the attribute key for the attribute token of the given name
- Inherited From:
- Source:
Returns:
The token's attribute key
- Type
- string
getDataType() → {string}
Gets the MDEX datatype of the token's attribute
- Inherited From:
- Source:
Returns:
The token's data type
- Type
- string
getDataViewKey() → {string}
Gets the token's dataview key
- Inherited From:
- Source:
Returns:
The token's dataview key
- Type
- string
getDisplayName() → {string}
Gets the attribute display name for the attribute token of the given name
- Inherited From:
- Source:
Returns:
The token's attribute display name
- Type
- string
getType() → {string}
Gets the token type (e.g. 'metric', 'dimension', 'sort', data', 'dataview'
- Inherited From:
- Source:
Returns:
The token's type ('metric', 'dimension', etc.)
- Type
- string
getValidAggregations(tokenName) → {Array.<Object>}
Gets an array of aggregation functions that are valid for the token of the given name and the token's
attribute.
Parameters:
| Name | Type | Description |
|---|---|---|
tokenName |
string | Name of the token |
- Source:
Returns:
The token's valid aggregation functions
- Type
- Array.<Object>
getValue() → {string|Number}
Gets the value for token of the given name. This is the literal value that replaced the
value in the EQL query.
- Inherited From:
- Source:
Returns:
The token's value
- Type
- string | Number
isSingleAssign() → {boolean}
Indicates if the attribute is single assign
- Inherited From:
- Source:
Returns:
- Type
- boolean
setAggregationFunction(aggregation)
Sets the aggregation function for the token of the given name
Parameters:
| Name | Type | Description |
|---|---|---|
aggregation |
string | The aggregation function to set |
- Source:
setAttributeKey(attributeKey)
Sets the attribute key for the attribute token of the given name
Parameters:
| Name | Type | Description |
|---|---|---|
attributeKey |
string | The attribute key value |
- Inherited From:
- Source: