com.reqdesign.reqif.compliance.implementationguide

Class ImplementationGuideComplianceChecker

java.lang.Object

com.reqdesign.reqif.compliance.implementationguide.ImplementationGuideComplianceChecker

public final class ImplementationGuideComplianceChecker
extends java.lang.Object

Class used for checking ReqIF archives and files against the rules documented in the Implementation Guide

Constructor Summary

Constructors

Constructor and Description
ImplementationGuideComplianceChecker()

Method Summary

Modifier and Type	Method and Description
static boolean	validateArchive(java.lang.String reqIFPath, java.util.function.Consumer<ValidationMessage> logMessage) Validates the ReqIF archive specified by reqIFPath against the rules documented in the Implementation Guide.
static void	validateAttributeDefinitionIsEditable(ReqIFFile reqIFFile, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Validates a ReqIF file for appropriate usage of the isEditable an an AttributeDefinitionEnumeration
static boolean	validateFile(java.lang.String reqIFPath, java.util.function.Consumer<ValidationMessage> logMessage) Validates the ReqIF file specified by reqIFPath against the rules documented in the Implementation Guide.
static void	validateSpecRelationsInRelationGroups(ReqIFFile reqIFFile, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Validates a ReqIF file for appropriate assignment of SpecRelations to RelationGroups when the SpecRelation source and target SpecObject are in a different Specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImplementationGuideComplianceChecker

public ImplementationGuideComplianceChecker()

Method Detail

validateFile

public static boolean validateFile(java.lang.String reqIFPath,
                                   java.util.function.Consumer<ValidationMessage> logMessage)
                            throws java.io.IOException

Validates the ReqIF file specified by reqIFPath against the rules documented in the Implementation Guide.

Parameters:

reqIFPath - the full path to the ReqIF file, not null

logMessage - a consumer of ValidationMessage, not null

Returns:

Boolean flag indicating whether one or more validation errors occurred

Throws:

java.io.IOException - if the ReqIF file at path reqIFPath could not be loaded

validateArchive

public static boolean validateArchive(java.lang.String reqIFPath,
                                      java.util.function.Consumer<ValidationMessage> logMessage)

Validates the ReqIF archive specified by reqIFPath against the rules documented in the Implementation Guide.

Parameters:

reqIFPath - the full path to the ReqIF archive, not null

logMessage - a consumer of ValidationMessage, not null

Returns:

Boolean flag indicating whether one or more validation errors occurred

validateSpecRelationsInRelationGroups

public static void validateSpecRelationsInRelationGroups(ReqIFFile reqIFFile,
                                                         java.util.function.Consumer<ValidationMessage> validationMessageConsumer)

Validates a ReqIF file for appropriate assignment of SpecRelations to RelationGroups when the SpecRelation source and target SpecObject are in a different Specification.

Parameters:

reqIFFile - reference to the ReqIFFile, not null

validationMessageConsumer - reference to the ValidationMessage consumer to receive validation messages, not null

validateAttributeDefinitionIsEditable

public static void validateAttributeDefinitionIsEditable(ReqIFFile reqIFFile,
                                                         java.util.function.Consumer<ValidationMessage> validationMessageConsumer)

Validates a ReqIF file for appropriate usage of the isEditable an an AttributeDefinitionEnumeration

Parameters:

reqIFFile - reference to the ReqIFFile, not null

validationMessageConsumer - reference to the ValidationMessage consumer to receive validation messages, non null