Metric Definition Measure ABE UML Documentation

Element

Common Domain::Metric ABE::Metric Definition Measure ABE
Class MetricDefinitionDeterminationMethod

How the value of the metric is determined, examples are ratio, formula, algorithm, external call (web service).
This entity is may be further developed to support all determination methods. It may also be further defined and subclassed in the future.

Attributes
MetricMeasure	_metric
MetricDefinitionMethodArgument	_metricDefinitionMethodComponent
MetricDefMeasure	_metricDefMeasure
String	derivationFormula	A rule or principle represented in symbols, numbers, or letters, often in the form of an equation used to derive the value of a metric.
String	description	A narrative that explains in detail what the MetricDefinitionDeterminationMethod is.
String	exceptionAction	Action to take when one or more of the related MetricDefinitionMethodArgument cause indeterminate results, such as a denominator of 0 in a ratio or a missing value for a MetricDefinitionMethodArgument.
String	proseFormula	A prose expression of formula, may not be as precise as the XLS formula or some XLS-like formula.
String	type	Indicates whether the determination method is a ratio, formula, average, min, max, median, std dev, and so forth.
«baseType» TimePeriod	validFor	The period for which the MetricDefinitionDeterminationMethod is valid.
String	xLSFormula	A precise XLS-compatible formula using XLS named ranges (from XLS Name field).

Properties:

Alias
Classifier Behavior
Is Abstract	false
Is Active	false
Is Leaf	false
Keywords
Name	MetricDefinitionDeterminationMethod
Name Expression
Namespace	Metric Definition Measure ABE
Owned Template Signature
Owner	Metric Definition Measure ABE
Owning Template Parameter
Package	Metric Definition Measure ABE
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

_metric

Public MetricMeasure _metric

Constraints:

Properties:

Aggregation	None
Alias
Association	MetricMeasuredDefinedBy
Association End
Class	MetricDefinitionDeterminationMethod
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1
Name	_metric
Name Expression
Namespace	MetricDefinitionDeterminationMethod
Opposite	_metricDefinitionDeterminationMethod
Owner	MetricDefinitionDeterminationMethod
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod::_metric
Stereotype
Template Parameter
Type	MetricMeasure
Upper	1
Upper Value	(1)
Visibility	Public

_metricDefinitionMethodComponent

Public MetricDefinitionMethodArgument _metricDefinitionMethodComponent

Constraints:

Properties:

Aggregation	None
Alias
Association	MetricDefinitionDeterminationMethodUses
Association End
Class	MetricDefinitionDeterminationMethod
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	_metricDefinitionMethodComponent
Name Expression
Namespace	MetricDefinitionDeterminationMethod
Opposite	_metricDefinitionDeterminationMethod
Owner	MetricDefinitionDeterminationMethod
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod::_metricDefinitionMethodComponent
Stereotype
Template Parameter
Type	MetricDefinitionMethodArgument
Upper	*
Upper Value	(*)
Visibility	Public

_metricDefMeasure

Public MetricDefMeasure _metricDefMeasure

Constraints:

Properties:

Aggregation	None
Alias
Association	MetricDefMeasureDeterminedBy
Association End
Class	MetricDefinitionDeterminationMethod
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1
Name	_metricDefMeasure
Name Expression
Namespace	MetricDefinitionDeterminationMethod
Opposite	_metricDefinitionDeterminationMethod
Owner	MetricDefinitionDeterminationMethod
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod::_metricDefMeasure
Stereotype
Template Parameter
Type	MetricDefMeasure
Upper	1
Upper Value	(1)
Visibility	Public

derivationFormula

Public String derivationFormula

A rule or principle represented in symbols, numbers, or letters, often in the form of an equation used to derive the value of a metric.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	MetricDefinitionDeterminationMethod
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	derivationFormula
Name Expression
Namespace	MetricDefinitionDeterminationMethod
Opposite
Owner	MetricDefinitionDeterminationMethod
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod::derivationFormula
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

description

Public String description

A narrative that explains in detail what the MetricDefinitionDeterminationMethod is.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	MetricDefinitionDeterminationMethod
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	description
Name Expression
Namespace	MetricDefinitionDeterminationMethod
Opposite
Owner	MetricDefinitionDeterminationMethod
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod::description
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

exceptionAction

Public String exceptionAction

Action to take when one or more of the related MetricDefinitionMethodArgument cause indeterminate results, such as a denominator of 0 in a ratio or a missing value for a MetricDefinitionMethodArgument.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	MetricDefinitionDeterminationMethod
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	exceptionAction
Name Expression
Namespace	MetricDefinitionDeterminationMethod
Opposite
Owner	MetricDefinitionDeterminationMethod
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod::exceptionAction
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

proseFormula

Public String proseFormula

A prose expression of formula, may not be as precise as the XLS formula or some XLS-like formula.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	MetricDefinitionDeterminationMethod
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	proseFormula
Name Expression
Namespace	MetricDefinitionDeterminationMethod
Opposite
Owner	MetricDefinitionDeterminationMethod
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod::proseFormula
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

type

Public String type

Indicates whether the determination method is a ratio, formula, average, min, max, median, std dev, and so forth.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	MetricDefinitionDeterminationMethod
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	type
Name Expression
Namespace	MetricDefinitionDeterminationMethod
Opposite
Owner	MetricDefinitionDeterminationMethod
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod::type
Stereotype	required
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

validFor

Public «baseType» TimePeriod validFor

The period for which the MetricDefinitionDeterminationMethod is valid.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	MetricDefinitionDeterminationMethod
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	validFor
Name Expression
Namespace	MetricDefinitionDeterminationMethod
Opposite
Owner	MetricDefinitionDeterminationMethod
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod::validFor
Stereotype
Template Parameter
Type	«baseType» TimePeriod
Upper	1
Upper Value
Visibility	Public

xLSFormula

Public String xLSFormula

A precise XLS-compatible formula using XLS named ranges (from XLS Name field).

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	MetricDefinitionDeterminationMethod
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	xLSFormula
Name Expression
Namespace	MetricDefinitionDeterminationMethod
Opposite
Owner	MetricDefinitionDeterminationMethod
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Metric ABE::Metric Definition Measure ABE::MetricDefinitionDeterminationMethod::xLSFormula
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

Overview

Top

Package

Element

Metric Definition Measure ABE UML Documentation

Summary:AttributesProperties

Detail:Attributes