Package com.nomagic.reportwizard.tools

Class ModelValidationTool

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.Tool

com.nomagic.reportwizard.tools.ModelValidationTool

All Implemented Interfaces:

ITool, IVariable, Serializable, Cloneable

@OpenApiAll
public class ModelValidationTool
extends Tool

Provides ability to access MagicDraw model validation results for analysis purpose.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool

ITool.HTMLString, ITool.RetainedString, ITool.Void

Field Summary

Fields inherited from class com.nomagic.magicreport.engine.Tool

context, properties

Fields inherited from interface com.nomagic.magicreport.engine.ITool

VOID

Constructor Summary

Constructors

Constructor	Description
ModelValidationTool()

Method Summary

Modifier and Type	Method	Description
protected List<ValidationResult>	createResult(Collection<RuleViolationResult> validationResultList)	Create the wrapper of RuleViolationResult.
protected Package	findSuite(String suiteName)	Find the suite package from given suite name.
List<String>	getSuiteNames()	Return all available suites name.
List<ValidationResult>	validate(String suiteName)	Validate model from suite name.
List<ValidationResult>	validate(String suiteName, String severity)	Validate model from suite name and severity.
List<ValidationResult>	validate(String suiteName, Collection<Element> elements, String severity)	Validate model from suite name, element and severity.
List<ValidationResult>	validate(String suiteName, Collection<Element> elements, String severity, boolean excludeReadOnly)	Validate model from suite name, element and severity.

Methods inherited from class com.nomagic.magicreport.engine.Tool

clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.nomagic.magicreport.engine.ITool

clearTool

Constructor Details

ModelValidationTool

public ModelValidationTool()

Method Details

validate

public List<ValidationResult> validate(String suiteName)

Validate model from suite name. This method will validate whole project and use severity "debug" as default.

Parameters:

suiteName - the name of validation suite.

Returns:

model validation result.

validate

public List<ValidationResult> validate(String suiteName,
 String severity)

Validate model from suite name and severity. This method will validate whole project.

Parameters:

suiteName - the name of validation suite.

severity - the severity, choose the value from "debug", "info", "warning", "error" and "fatal"

Returns:

model validation result.

validate

public List<ValidationResult> validate(String suiteName,
 Collection<Element> elements,
 String severity)

Validate model from suite name, element and severity.

Parameters:

suiteName - the name of validation suite.

elements - the list of Element to be validated.

severity - the severity, choose the value from "debug", "info", "warning", "error" and "fatal"

Returns:

model validation result.

validate

public List<ValidationResult> validate(String suiteName,
 Collection<Element> elements,
 String severity,
 boolean excludeReadOnly)

Validate model from suite name, element and severity.

Parameters:

suiteName - the name of validation suite.

elements - the list of Element to be validated.

severity - the severity, choose the value from "debug", "info", "warning", "error" and "fatal"

excludeReadOnly - true to exclude elements from read-only used projects from validation scope

Returns:

model validation result.

getSuiteNames

public List<String> getSuiteNames()

Return all available suites name.

Returns:

the list of available suites name

findSuite

protected Package findSuite(String suiteName)

Find the suite package from given suite name.

Parameters:

suiteName - the suite name

Returns:

the suite package.

createResult

protected List<ValidationResult> createResult(Collection<RuleViolationResult> validationResultList)

Create the wrapper of RuleViolationResult.

Parameters:

validationResultList - a list of RuleViolationResult

Returns:

a list of ValidationResult