com.nomagic.requirements.reqif

Class ReqIFUtils

java.lang.Object

com.nomagic.requirements.reqif.ReqIFUtils

@OpenApiAll
public class ReqIFUtils
extends java.lang.Object

ReqIF import utility.

Constructor Summary

Constructors

Constructor and Description
ReqIFUtils()

Method Summary

Modifier and Type	Method and Description
static void	checkSourceTool(java.lang.String sourceToolId) Check if given source tool (ReqIF flavor) is available.
static void	exportReqIFElements(java.io.File file, java.util.Collection<com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class> classes, java.lang.String sourceToolId, com.nomagic.task.ProgressStatus progressStatus) Exports given classes as ReqIF objects.
static void	exportReqIFSpecifications(java.io.File file, java.util.Collection<com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Package> specifications, java.lang.String sourceToolId, com.nomagic.task.ProgressStatus progressStatus) Exports given packages as ReqIF specifications.
static java.util.Collection<java.lang.String>	getSourceToolIds() Get supported ReqIF source tools ids to export to.
static void	importReqIF(java.io.File reqIfFile, com.nomagic.magicdraw.core.Project project) Imports ReqIF file.
static void	importReqIF(java.io.File reqIfFile, com.nomagic.magicdraw.core.Project project, ReqIFObjectOwnerProvider ownerProvider) Import ReqIF file.
static void	importReqIFSpecification(java.io.File reqIfFile, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Package specificationPackage) Imports (updates) ReqIF specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReqIFUtils

public ReqIFUtils()

Method Detail

importReqIF

public static void importReqIF(java.io.File reqIfFile,
                               com.nomagic.magicdraw.core.Project project)
                        throws java.lang.IllegalArgumentException,
                               ReqIFException

Imports ReqIF file.

Parameters:

reqIfFile - ReqIF file.

project - project to import to.

Throws:

java.lang.IllegalArgumentException - if illegal arguments are passed.

ReqIFException - if fails to import ReqIF file.

importReqIF

public static void importReqIF(java.io.File reqIfFile,
                               com.nomagic.magicdraw.core.Project project,
                               ReqIFObjectOwnerProvider ownerProvider)
                        throws java.lang.IllegalArgumentException,
                               ReqIFException

Import ReqIF file.

Parameters:

reqIfFile - ReqIF file.

project - project to import to.

ownerProvider - call back to provide an owner element for new ReqIF objects (if objects without specifications are imported).

Throws:

java.lang.IllegalArgumentException - if illegal arguments are passed.

ReqIFException - if fails to import ReqIF file.

importReqIFSpecification

public static void importReqIFSpecification(java.io.File reqIfFile,
                                            com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Package specificationPackage)
                                     throws java.lang.IllegalArgumentException

Imports (updates) ReqIF specification.

Parameters:

reqIfFile - ReqIF file.

specificationPackage - specification package to update.

Throws:

java.lang.IllegalArgumentException - if illegal arguments are passed.

getSourceToolIds

public static java.util.Collection<java.lang.String> getSourceToolIds()

Get supported ReqIF source tools ids to export to.

Returns:

supported source tools ids

exportReqIFSpecifications

public static void exportReqIFSpecifications(java.io.File file,
                                             java.util.Collection<com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Package> specifications,
                                             @CheckForNull
                                             java.lang.String sourceToolId,
                                             com.nomagic.task.ProgressStatus progressStatus)
                                      throws java.lang.Exception

Exports given packages as ReqIF specifications. Classes contained by packages are exported as ReqIF objects.

Parameters:

file - destination file.

specifications - specifications to export.

sourceToolId - source tool format.

progressStatus - progress status.

Throws:

java.lang.Exception - export exception.

exportReqIFElements

public static void exportReqIFElements(java.io.File file,
                                       java.util.Collection<com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class> classes,
                                       @CheckForNull
                                       java.lang.String sourceToolId,
                                       com.nomagic.task.ProgressStatus progressStatus)
                                throws java.lang.Exception

Exports given classes as ReqIF objects.

Parameters:

file - destination file.

classes - specifications to export.

sourceToolId - source tool format.

progressStatus - progress status.

Throws:

java.lang.Exception - export exception.

checkSourceTool

public static void checkSourceTool(@CheckForNull
                                   java.lang.String sourceToolId)
                            throws java.lang.IllegalArgumentException

Check if given source tool (ReqIF flavor) is available.

Parameters:

sourceToolId - source tool to check.

Throws:

java.lang.IllegalArgumentException - if given source tool is not supported.