MetricDefinition Class Reference

Inheritance diagram for MetricDefinition:

Collaboration diagram for MetricDefinition:

Static Public Member Functions
_.Library.Status	Register (_.Library.Integer pDomainId, _.Library.Boolean pVerbose)
	Registers all Metrics, their properties and targets, as defined in the <xdata>Metrics</xdata> More...
_.Library.Status	UnRegister (_.Library.Integer pDomainId, _.Library.Boolean pVerbose)
	Drops all metrics defined in the <xdata>Metrics</xdata> XData block from domain. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

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.

Use a Metric Definition to declare any custom metrics you wish to use in an application by creating a subclass of this class and supplying a <xdata>Metrics</xdata> XData block detailing the properties of these custom metrics. To be able to use a metric in a particular domain, use the <method>Register</method> method.

Unless custom metrics are only assigned on an individual basis (such as a "reader score" metric), a metric will refer to a Builder Class that is responsible for implementing the logic to calculate the appropriate values for a custom metric. See also <class>iKnow.Metrics.MetricBuilder</class> for more details.

Note: metric definitions can also transparently be included in a domain definition, with no further need to call <method>Register</method>. See also <class>iKnow.DomainDefinition</class>.

Member Function Documentation

Register()

_.Library.Status Register ( _.Library.Integer  pDomainId, _.Library.Boolean  pVerbose  )

static

Registers all Metrics, their properties and targets, as defined in the <xdata>Metrics</xdata>

XData block, in the domain pDomainId.

UnRegister()

_.Library.Status UnRegister ( _.Library.Integer  pDomainId, _.Library.Boolean  pVerbose  )

static

Drops all metrics defined in the <xdata>Metrics</xdata> XData block from domain.

pDomainId.