Rules Set

org.topcased.traceability.engine.rulesSet

1.0.0

Rules Set extension point allow the definition of some particular rules that are needed to be raised during the analysis of TopCased Traceability project.

<!ELEMENT extension (rule+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT rule EMPTY>

<!ATTLIST rule

id               CDATA #REQUIRED

displayName      CDATA #IMPLIED

defaultMessage   CDATA #IMPLIED

applicationClass CDATA #REQUIRED

actionClass      CDATA #REQUIRED

activate         (true | false) "true"

level            CDATA "2">


The following is an example of the Rules Set Extension point usage:

 

<extension id=

"org.topcased.traceability.editor.basicRules"

name=

"Basic Rules"

point=

"org.topcased.traceability.engine.rulesSet"

>

<rule id=

"org.topcased.traceability.editor.uncoveredRequirement"

actionClass=

"ttm.rules.UncoveredRequirementRule"

activate=

"true"

applicationClass=

"ttm.Requirement"

displayMessage=

"uncovered requirement"

displayName=

"Uncovered"

level=

"1"

/>

</extension>

    /**
     * Method to implement to indicate how the rule is raised for element.
     * @param elt the element that is checked with the rule
     * @param project the project that can be needed
     *  to determine if the rule should raised
     * @return if the Rule is raised
     */
    Boolean isRaisedForElement(Element elt, Project project);

    /**
     * Method that can be implemented to customize
     *  the displayed message when the rule is raised.
     * @param elt the element that owns thr Rule
     * @return the displayed message for the rule on the element
     */
    String getDisplayMessageForElement(Element elt);

[Enter information about supplied implementation of this extension point.]