|
IRISLIB database
|
|
|
IRISLIB database
|
|
Static Public Member Functions | |
| _.Library.Status | ClearValues (_.Library.Integer pDomainId, _.Library.Integer pMetricId, _.Library.List pTargets) |
| Drops all metric values for metric pMetricId in domain pDomainId. More... | |
| _.Library.Integer | GetMetricId (_.Library.Integer pDomainId, _.Library.Integer pMetricName, _.Library.Status pSC) |
| Returns the ID corresponding to the supplied metric name for this domain. | |
| _.Library.Status | GetMetrics (pResult, _.Library.Integer pDomainId) |
| Returns all the metrics registered in this domain. | |
| _.Library.Status | GetTargets (pResult, _.Library.Integer pDomainId, _.Library.Integer pMetricId) |
| Returns all the target types registered for a given metric. | |
| _.Library.Status | GetTop (pResult, _.Library.Integer pDomainId, _.Library.Integer pMetricId, _.Library.Integer pPage, _.Library.Integer pPageSize, _.Library.String pContext, _.Library.String pTargetType) |
| _.Library.Numeric | GetValue (_.Library.Integer pDomainId, _.Library.Integer pMetricId, _.Library.String pTargetType, _.Library.Integer pTargetId, _.Library.String pContext) |
| _.Library.Status | SetValue (_.Library.Integer pDomainId, _.Library.Integer pMetricId, _.Library.String pTargetType, _.Library.Integer pTargetId, _.Library.Integer pValue, _.Library.String pContext) |
The <package>iKnow.Metrics</package> infrastructure is deprecated in favour of the more SQL-oriented approach offered through <class>iKnow.Tables.Utils</class>, where you can add computed fields at different levels and choose whether they need to be persisted or not.
This class offers a number of API methods to interact with any custom metrics registered in a particular domain. Use <class>iKnow.Metrics.MetricDefinition</class> to configure any custom metric properties, eventually referring a <class>iKnow.Metrics.MetricsBuilder</class> implementation for applicable calculations and then consult the results through the different methods in this interface.
|
static |
Drops all metric values for metric pMetricId in domain pDomainId.
This can optionally be limited to one or more target types using pTargets. If pTargets is "" (default), values for all targets registered for this metric will be dropped.
|
static |
Returns the elements with the highest values for custom metric pMetricId,
optionally restricted to the target type pTargetType.
pContext is ignored when the metric is type $$$IKMTRTYPEDOMAIN and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP. In the latter case, pContext is optional and the top entries for all metadata values will be returned if left blank.
|
static |
Returns the value of a particular target element identified by pTargetId (for example,
when pTargetType = $$$IKMTRENTITY, pTargetId is a unique entity ID).
pContext is only required when the metric is not of type $$$IKMTRTYPEDOMAIN and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP.
|
static |
Sets the value of a particular target element identified by pTargetId (for example,
when pTargetType = $$$IKMTRENTITY, pTargetId is a unique entity ID) to pValue.
pContext is only required when the metric is not of type $$$IKMTRTYPEDOMAIN and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP.
1.9.1