public class RuleData
Checks the design rules for a model and provides a tabular view of the design
The class creates one table for each element type for which there are
elements with rule violations. Each row of the table reports the violation of
one design rule by one model element. Each table has five columns describing
various properties of the rule violation:
1. column (index 0) shows the name of the violated design rule,
2. column (index 1) shows a value detailing how the model element
violated the rule (if available)
3. column (index 2) is the category name of the violated design rule,
4. column (index 3) is the severity of the violated design rule,
5. column (index 4) is a short description of the violated design rule.
public boolean setRuleFilter(MessageHandler msgHandler,
Sets the rule filter that specifies the rules to apply. Parsers the rule
filter string, reporting any errors if the filter string is syntactically
msgHandler - Handler for error messages
filter - The rule filter string.
true if the filter was correctly installed,
false if an error occurred. The error will be
reported to the message handler.
public java.lang.String checkFilterIdentifiers()
Checks the application areas of the rule filter for plausibility.
Application areas specified in the current rule filter are suspect if
they are not defined explicitly by at least one design rule (maybe the
user misspelled the application area). The filter can be used regardless,
but you may want to warn the users about it, because the result may not
be what they expect.
Empty string if all application areas are defined explicitly, or
the name of an application area in the rule filter that is not
defined explicitly by any of the rules.
public boolean checkRules(MessageHandler msgHandler,
Checks all design rules, reports any errors.
msgHandler - Handler for progress and error messages
startPercent - Initial value of the progress indicator
finishPercent - Value of the progress indicator at the completion of
this calculation run
true if all rule were checked without any errors,
false if an error occurred.
Returns a short description of a column. The description is a short
string (one-liner), providing a brief, informal description of the
column, and can be used, e.g., as a tool tip for the column headers when
displaying the table on screen.