com.nomagic.magicdraw.validation

Class ValidationHelper

java.lang.Object

com.nomagic.magicdraw.validation.ValidationHelper

@OpenApiAll
public class ValidationHelper
extends java.lang.Object

Class for manipulating with validation. It is able to validate for given ValidationRunData or for specific Element. It is also able to open validation window and display validation results in it.

Constructor Summary

Constructors

Constructor and Description
ValidationHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static void	openValidationWindow(ValidationRunData validationRunData, java.lang.String windowID, java.util.Collection<RuleViolationResult> results) Opens validation window and displays RuleViolationResult in it.
static java.util.Collection<RuleViolationResult>	validate(ValidationRunData validationRunData, java.lang.String validationTaskName, ProgressStatus progressStatus) Runs validation for given ValidationRunData
static java.util.List<RuleViolationResult>	validateElement(Element elementForValidation, java.util.List<Constraint> rules, boolean readOnly) Validates given element with given list of validation rules.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationHelper

public ValidationHelper()

Method Detail

validate

public static java.util.Collection<RuleViolationResult> validate(@Nonnull
                                                 ValidationRunData validationRunData,
                                                 @CheckForNull
                                                 java.lang.String validationTaskName,
                                                 @CheckForNull
                                                 ProgressStatus progressStatus)

Runs validation for given ValidationRunData

Parameters:

validationRunData - instance of ValidationRunData

validationTaskName - which is visible when running validation. If Passed null, it will show default value "Validating".

progressStatus - for validation, or null if to run validation with owe progress

Returns:

collection of validation results.

validateElement

@CheckForNull
public static java.util.List<RuleViolationResult> validateElement(@Nonnull
                                                               Element elementForValidation,
                                                               @Nonnull
                                                               java.util.List<Constraint> rules,
                                                               boolean readOnly)

Validates given element with given list of validation rules.

Parameters:

elementForValidation - element which should be validated.

rules - list of validation rules.

readOnly - exclude read only elements?

Returns:

list of violation results or null if element is valid.

openValidationWindow

public static void openValidationWindow(@Nonnull
                        ValidationRunData validationRunData,
                        @Nonnull
                        java.lang.String windowID,
                        @Nonnull
                        java.util.Collection<RuleViolationResult> results)

Opens validation window and displays RuleViolationResult in it.

Parameters:

validationRunData - instance of ValidationRunData

windowID - id which will be set to validation window.

results - collection of RuleViolationResult