%iKnow.Metrics.MetricBuilder

Builds all the metrics referring this class in their BuilderClass property. See also BuildAll().

This is the main method to be invoked to build all the Metrics for a given domain, optionally limited to a number of metrics specified by ID through pMetrics. It will build a list of all MetricBuilder implementations referred by registered metrics and then run through all targets and types. For each target, it will first invoke all MetricBuilder implementations NOT supporting parallel processing (with SUPPORTSMULTIPROCESS=0) and then spawn a number of jobs to take care of the ones that can run in parallel. These spawned processes will reserve batches of the target element (for example a batch of entities) and then let all MetricBuilder implementations that support metrics for that target run through them and calculate any metric values using the different Calculate***Metrics() methods.

Note: metrics can only be calculated in a domain in which they are already registered. See the Register() method in the %iKnow.Metrics.MetricDefinition class for more details.

This method builds an index for a particular Metric and Target.

Note: no indices will be built for metrics of type $$$IKMTRTYPESOURCE, as these intra-source entries will be sorted on the fly when calling any applicable sorted queries.

This is the main method a custom MetricBuilder should implement to support metrics targeting CCs. Depending on the value of Type, the properties CurrentSrcId (for $$$IKMTRTYPESOURCE), CurrentFieldName and CurrentFieldValue (for $$$IKMTRTYPEGROUP) or neither of these (for $$$IKMTRTYPEDOMAIN) will define the scope for which metrics should be calculated.

For a given unique CC pCcUniId, this method should calculate all metrics it knows about and return them through pValues in an array indexed by metric name: pValues(metricName) = value

This is the main method a custom MetricBuilder should implement to support metrics targeting CRCs. Depending on the value of Type, the properties CurrentSrcId (for $$$IKMTRTYPESOURCE), CurrentFieldName and CurrentFieldValue (for $$$IKMTRTYPEGROUP) or neither of these (for $$$IKMTRTYPEDOMAIN) will define the scope for which metrics should be calculated.

For a given unique CRC pCrcUniId, this method should calculate all metrics it knows about and return them through pValues in an array indexed by metric name: pValues(metricName) = value

This is the main method a custom MetricBuilder should implement to support metrics targeting entities. Depending on the value of Type, the properties CurrentSrcId (for $$$IKMTRTYPESOURCE), CurrentFieldName and CurrentFieldValue (for $$$IKMTRTYPEGROUP) or neither of these (for $$$IKMTRTYPEDOMAIN) will define the scope for which metrics should be calculated.

For a given unique entity pEntUniId, this method should calculate all metrics it knows about and return them through pValues in an array indexed by metric name: pValues(metricName) = value

This is the main method a custom MetricBuilder should implement to support metrics targeting Paths. Depending on the value of Type, the properties CurrentSrcId (for $$$IKMTRTYPESOURCE), CurrentFieldName and CurrentFieldValue (for $$$IKMTRTYPEGROUP) or neither of these (for $$$IKMTRTYPEDOMAIN) will define the scope for which metrics should be calculated.

For a given path pPathId, this method should calculate all metrics it knows about and return them through pValues in an array indexed by metric name: pValues(metricName) = value

This is the main method a custom MetricBuilder should implement to support metrics targeting sentences. Depending on the value of Type, the properties CurrentSrcId (for $$$IKMTRTYPESOURCE), CurrentFieldName and CurrentFieldValue (for $$$IKMTRTYPEGROUP) or neither of these (for $$$IKMTRTYPEDOMAIN) will define the scope for which metrics should be calculated.

For a given sentence pSentenceId, this method should calculate all metrics it knows about and return them through pValues in an array indexed by metric name: pValues(metricName) = value

This is the main method a custom MetricBuilder should implement to support metrics targeting sources. Depending on the value of Type, the properties CurrentSrcId (for $$$IKMTRTYPESOURCE), CurrentFieldName and CurrentFieldValue (for $$$IKMTRTYPEGROUP) or neither of these (for $$$IKMTRTYPEDOMAIN) will define the scope for which metrics should be calculated.

For a given source pSourceId in the context of a given source pSrcId, this method should calculate all metrics it knows about and return them through pValues in an array indexed by metric name: pValues(metricName) = value

Utility method called after a MetricBuilder instance starts building any metrics, in which custom code can be executed to clean up any auxiliary objects or data structures.

Note: depending on the value of SUPPORTSMULTIPROCESS, multiple MetricBuilder instances can be running alongside one another

Utility method called after a MetricBuilder starts building any metrics for a batch of elements, for metrics of type $$$IKMTRTYPEDOMAIN

Utility method called after a MetricBuilder instance finishes building any metrics for the group identified by CurrentFieldName and CurrentFieldValue, for metrics of type $$$IKMTRTYPEGROUP.

Utility method called after a MetricBuilder starts building any metrics for the source identified by pSrcId, for metrics of type $$$IKMTRTYPESOURCE.

Utility method called before a MetricBuilder instance starts building any metrics, in which custom code can be executed to set up any auxiliary objects or data structures.

Note: depending on the value of SUPPORTSMULTIPROCESS, multiple MetricBuilder instances can be running alongside one another

Utility method called before a MetricBuilder starts building any metrics for a batch of elements, for metrics of type $$$IKMTRTYPEDOMAIN

Utility method called before a MetricBuilder instance starts building any metrics for the group identified by CurrentFieldName and CurrentFieldValue, for metrics of type $$$IKMTRTYPEGROUP.

Utility method called before a MetricBuilder instance starts building any metrics for the source identified by pSrcId, for metrics of type $$$IKMTRTYPESOURCE.