Touchstone
Reference

The validation rules

Touchstone_Validation is a model library of 38 Constraints, grouped into five suites, that validates a model against the MB²SE method. ValidationShapeTest fails when the library and this page disagree.

Each table lists the identifier, the suite, the rule sentence, the severity, the stereotypes the Constraint constrains and the implementing class. Each sentence states a requirement with "shall", so the validation results read as requirements the flagged element fails. The library writes each sentence verbatim as the Constraint name, abbreviation, error message and specification. No sentence carries an apostrophe, an ampersand or an angle bracket. The identifiers N5 and I11 are unassigned.

Touchstone Objectives

IdSuiteSentenceSeverityConstrainedClass
O1Touchstone ObjectivesA Postponed or Rejected Objective shall have a rationale.warning«Objective»ObjectiveRationaleRule
O2Touchstone ObjectivesAn Approved Objective shall justify at least one Concept, Attribute or Relation.warning«Objective»ApprovedObjectiveJustifiesRule
O3Touchstone ObjectivesAn Objective shall be owned by an Objective Package.error«Objective»ObjectiveOwnerRule
O4Touchstone ObjectivesAn Objective shall have documentation.warning«Objective»ObjectiveDocumentedRule

Touchstone Ontology

IdSuiteSentenceSeverityConstrainedClass
N1Touchstone OntologyA Concept shall be justified by at least one Objective.warning«Concept»ConceptJustifiedRule
N2Touchstone OntologyA Relation shall be justified by at least one Objective.warning«Relation»RelationJustifiedRule
N3Touchstone OntologyA JustifiedBy shall not target a Rejected Objective.warning«JustifiedBy»JustifiedByRejectedObjectiveRule
N4Touchstone OntologyA JustifiedBy shall run from a Concept, Attribute or Relation to an Objective.error«JustifiedBy»JustifiedByEndsRule
N6Touchstone OntologyA Relation shall be typed by a Concept.error«Relation»RelationTypeRule
N7Touchstone OntologyAn Attribute shall be typed by a PrimitiveType or an Enumeration.error«Attribute»AttributeTypeRule
N8Touchstone OntologyA property owned by a Concept shall be an Attribute or a Relation.warning«Concept»ConceptPropertyKindRule
N9Touchstone OntologyA Concept shall specialize only Concepts.error«Concept»ConceptGeneralizationRule
N10Touchstone OntologyA Concept shall be owned by an Ontology Package.error«Concept»ConceptOwnerRule
N11Touchstone OntologyA Concept, Attribute or Relation shall have documentation.warning«Concept», «Attribute», «Relation»OntologyElementDocumentedRule

Touchstone Implementation

IdSuiteSentenceSeverityConstrainedClass
I1Touchstone ImplementationA Concept shall have a mapping or a specialization.warning«Concept»ConceptRealizedRule
I2Touchstone ImplementationA Concept Mapping shall set metaclasses or stereotype.error«ConceptMapping»ConceptMappingSelectsRule
I3Touchstone ImplementationA Concept Mapping shall name a metaclass one of its stereotypes can apply to.error«ConceptMapping»ConceptMappingNotEmptyRule
I4Touchstone ImplementationAn Attribute or Relation Mapping shall set exactly one of metaProperty, tag, derivedProperty and query.error«AttributeMapping», «RelationMapping»PropertyMappingSourceRule
I5Touchstone ImplementationAn Implements shall join one of the four legitimate pairs.error«Implements»ImplementsPairRule
I6Touchstone ImplementationA mapping or a Maturity Rule Implementation shall implement exactly one element.error«ConceptMapping», «AttributeMapping», «RelationMapping», «MaturityRuleImplementation»ImplementsExactlyOneRule
I7Touchstone ImplementationAn Attribute or Relation Mapping owned by a Concept Mapping shall bind a feature of the Concept that mapping implements.error«AttributeMapping», «RelationMapping»PropertyMappingFeatureRule
I8Touchstone ImplementationA filter or query behavior shall take exactly one Element in-parameter.error«ConceptMapping», «AttributeMapping», «RelationMapping»MappingBehaviorParameterRule
I9Touchstone ImplementationA Maturity Rule Implementation shall name a validation rule.error«MaturityRuleImplementation»ValidationRuleKindRule
I10Touchstone ImplementationAn Attribute or Relation of a mapped Concept shall have a mapping.warning«Attribute», «Relation»FeatureMappedRule

Touchstone Maturity

IdSuiteSentenceSeverityConstrainedClass
M1Touchstone MaturityA maturity rule shall constrain exactly one Concept, Attribute or Relation.error«MaturityRule»MaturityRuleContextRule
M2Touchstone MaturityA maturity rule shall have an expression or at least one implementation.error«MaturityRule»MaturityRuleDefinedRule
M3Touchstone MaturityThe expression of a maturity rule shall parse.error«MaturityRule»ExpressionSyntaxRule
M4Touchstone MaturityEvery reference in the expression of a maturity rule shall resolve to an element of the right kind.error«MaturityRule»ExpressionReferenceRule
M5Touchstone MaturityA hyperlink standing alone as a verdict shall name a rule applied to an individual.error«MaturityRule»ExpressionVerdictRule
M6Touchstone MaturityA bare anchor in the expression of a maturity rule shall name the context Concept of that rule.error«MaturityRule»ExpressionAnchorRule
M7Touchstone MaturityA maturity rule shall take no part in a reference cycle.error«MaturityRule»ExpressionCycleRule
M8Touchstone MaturityA maturity rule with an expression shall have no implementation.warning«MaturityRule»ExpressionShadowsImplementationRule
M9Touchstone MaturityA maturity rule shall state its specification in English.warning«MaturityRule»MaturityRuleSpecificationRule
M10Touchstone MaturityA maturity rule shall be owned by a Concept or an Ontology Package.error«MaturityRule»MaturityRuleOwnerRule

Touchstone Process

IdSuiteSentenceSeverityConstrainedClass
P1Touchstone ProcessA Step Action shall call a Step.error«StepAction»StepActionBehaviorRule
P2Touchstone ProcessA Step shall be owned by a Process Package.error«Step»StepOwnerRule
P3Touchstone ProcessA Step shall not call itself, directly or through its sub-steps.warning«Step»StepRecursionRule
P4Touchstone ProcessEvery parameter of a Step shall be typed by a Concept.warning«Step»StepParameterTypeRule

Reading the documentation rules

O4 and N11 read the documentation the tool shows in the Specification window, which is the first Comment the element owns. Documentation that is empty or holds only whitespace counts as missing.

Reading the Implementation rules

I3 applies only when both metaclasses and stereotype are set; I2 covers a mapping that sets neither. A mapping is empty by construction when no metaclass it selects, widened by includeSubtypes, is a metaclass, or a sub-metaclass, of a base metaclass of one of its stereotypes. A stereotype that extends metaclass E applies to the elements of E and of its sub-metaclasses, so the mapping can select an element when some listed metaclass M equals E or specializes E. With includeSubtypes true, the mapping can also select one when E specializes M.

I5 accepts four pairs of «Implements» client and supplier: a «ConceptMapping» implements a «Concept», an «AttributeMapping» an «Attribute», a «RelationMapping» a «Relation», and a «MaturityRuleImplementation» a «ModelingRule» or an «EngineeringRule».

I7 accepts a feature owned by the mapping's Concept or inherited from one of its general Concepts. I8 inspects filter on a ConceptMapping and query on the other two, and passes when the tag is unset. I9 passes when validationRule is a Constraint carrying «validationRule». I10 judges a feature whose owning Concept has a ConceptMapping of its own, and passes when a mapping of any owner implements the feature.

Reading the Maturity rules

Every maturity rule is constrained by «MaturityRule» and judges both of its specializations, «ModelingRule» and «EngineeringRule». M1 to M7 each report one defect kind of the rule engine; the failure table of the expression language states the specific cause of each.

IdDefect kind
M1CONTEXT
M2NO_DEFINITION
M3SYNTAX
M4REFERENCE
M5VERDICT
M6ANCHOR
M7CYCLE

M2 fires on a maturity rule with no expression and no implementation, and on a rule whose implementations name no validation rule; I9 flags the implementation itself in the second case. M8 warns because the engine evaluates the expression and ignores the implementations. M9 passes when the specification is an OpaqueExpression with a non-blank body.

On this page