com.reqdesign.reqif

Class ReqIFFile

java.lang.Object

com.reqdesign.reqif.ReqIFFile

public final class ReqIFFile
extends java.lang.Object

Class for a ReqIF file (extension .reqif). Can be constructed from an existing file or created empty and added to a ReqIFArchive.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	extension

Method Summary

Modifier and Type	Method and Description
static ReqIFFile	create(java.lang.String path, java.lang.String comment, java.util.Date creationTime, java.lang.String repositoryId, java.lang.String reqIFToolId, java.lang.String sourceToolId, java.lang.String title, java.lang.String reqIFIdentifier) Creates a new ReqIF file at the location specified and using the specified parameters for the Header
CoreContent	getCoreContent() The CoreContent object contained within this ReqIFFile object.
java.lang.String	getExchangeConversationIdentifier() The unique exchange conversation identifier for this ReqIF file.
java.lang.String	getFilename() The name of the ReqIF file either standalone or within the archive.
java.lang.String	getFullPath() Returns the path of this ReqIFFile
java.util.List<ReferencedFile>	getReferencedFiles()
ReqIFArchive	getReqIFArchive()
TheHeader	getTheHeader() The TheHeader object contained within this ReqIFFile object.
ToolExtensions	getToolExtensions() The ToolExtensions object contained within this ReqIFFile object.
boolean	isModified() Returns the modified status of this ReqIF file.
boolean	isUniqueIdentifier(java.lang.String identifier) Checks whether the specified identifier is defined in this ReqIFFile
static ReqIFFile	load(java.lang.String reqIFPath, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Create a ReqIFFile object from an existing .reqif file outside of an ReqIFArchive.
void	save(java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Saves this ReqIF.
void	setExchangeConversationIdentifier(java.lang.String exchangeConversationIdentifier) Sets the exchange conversation identifier for this ReqIF file.
void	setFilename(java.lang.String filename) Renames the ReqIF file
void	setIsModified(boolean isModified) Allows to set the modified state of the ReqIF file.
static ValidationOutcome	validate(java.lang.String reqIFPath, java.util.function.Consumer<java.lang.String> logValidationMessage) Performs validation of the ReqIF file specified by reqIFPath against reqif.xsd.

Methods inherited from class java.lang.Object

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

Field Detail

extension

public static final java.lang.String extension

See Also:

Constant Field Values

Method Detail

getReferencedFiles

public java.util.List<ReferencedFile> getReferencedFiles()

isModified

public boolean isModified()

Returns the modified status of this ReqIF file.

Returns:

true if any part of this ReqIF has been changed since it was either created or loaded false otherwise

load

public static ReqIFFile load(java.lang.String reqIFPath,
                             java.util.function.Consumer<ValidationMessage> validationMessageConsumer)
                      throws FileException,
                             ValidationException,
                             com.reqdesign.reqif.LicenseException

Create a ReqIFFile object from an existing .reqif file outside of an ReqIFArchive.

Parameters:

reqIFPath - path to the .reqif file, not null

validationMessageConsumer - a consumer of validation message objects ValidationMessage, not null

Returns:

reference to the created ReqIFFile object

Throws:

FileException - if the specified file is missing, corrupt or an IO exception occurs

ValidationException - if xsd validation or schema compliance errors occur that prevent loading e.g., REQ-IF-HEADER errors

LicenseException - if a valid license is not installed

create

public static ReqIFFile create(java.lang.String path,
                               java.lang.String comment,
                               java.util.Date creationTime,
                               java.lang.String repositoryId,
                               java.lang.String reqIFToolId,
                               java.lang.String sourceToolId,
                               java.lang.String title,
                               java.lang.String reqIFIdentifier)
                        throws InvalidValueException,
                               InvalidIdentifierException,
                               FileException,
                               com.reqdesign.reqif.LicenseException

Creates a new ReqIF file at the location specified and using the specified parameters for the Header

Parameters:

path - the path for the new ReqIFFile, not null

comment - the value to be assigned to the COMMENT header element, can be null

creationTime - the value to be assigned to the CREATION-DATE header element, can be null to auto-assign 'now'

repositoryId - the value to be assigned to the REPOSITORY-ID header element, can be null

reqIFToolId - the value to be assigned to the REQ-IF-TOOL-ID header element, not null

sourceToolId - the value to be assigned to the SOURCE-TOOL-ID header element, not null

title - the value to be assigned to the TITLE header element, not null

reqIFIdentifier - the value to be assigned to the @IDENTIFIER header attribute, not null and unique

Returns:

the created ReqIFFile object, not null

Throws:

InvalidValueException - if any parameter contains an unexpected value

InvalidIdentifierException - if the reqIFIdentifier parameter is not a valid xsd:ID

FileException - if an exception occurs in the file system during ReqIF creation

LicenseException - if a valid license is not installed

isUniqueIdentifier

public boolean isUniqueIdentifier(java.lang.String identifier)

Checks whether the specified identifier is defined in this ReqIFFile

Parameters:

identifier - String identifier to check

Returns:

Boolean flag indicating wehether the specified identifier is defined in this ReqIFFile

getReqIFArchive

public ReqIFArchive getReqIFArchive()

Returns:

the owning ReqIFArchive object, nullable

getFilename

public java.lang.String getFilename()

The name of the ReqIF file either standalone or within the archive.

Returns:

the ReqIF filename

setFilename

public void setFilename(java.lang.String filename)
                 throws java.lang.IllegalArgumentException

Renames the ReqIF file

Parameters:

filename - the String name to set for the filename, not null

Throws:

java.lang.IllegalArgumentException - if the filename is invalid

getTheHeader

public TheHeader getTheHeader()

The TheHeader object contained within this ReqIFFile object.

Returns:

the reference to the contained TheHeader object

getCoreContent

public CoreContent getCoreContent()

The CoreContent object contained within this ReqIFFile object.

Returns:

the reference to the contained CoreContent object

getToolExtensions

public ToolExtensions getToolExtensions()

The ToolExtensions object contained within this ReqIFFile object.

Returns:

the reference to the contained ToolExtensions object, not null

getFullPath

public java.lang.String getFullPath()

Returns the path of this ReqIFFile

Returns:

the path of this ReqIFFile

getExchangeConversationIdentifier

public java.lang.String getExchangeConversationIdentifier()

The unique exchange conversation identifier for this ReqIF file.

The ReqIF standard currently does not allow identifying which "conversation" (a.k.a. exchange process) a ReqIF XML document belongs to. This is solved by having an explicit "conversation identifier", that means: each exchange process gets its own, distinct identifier. It is an identifier that is created during the first export of a ReqIF XML document in a chain of exports and imports, and is not changed by following imports and exports of ReqIF XML documents. To preserve the conversation identifier, each exported ReqIF file stores the conversation identifier.

Returns:

the exchange conversation identifier for this ReqIF File, can be null

setExchangeConversationIdentifier

public void setExchangeConversationIdentifier(java.lang.String exchangeConversationIdentifier)
                                       throws InvalidValueException

Sets the exchange conversation identifier for this ReqIF file.

Parameters:

exchangeConversationIdentifier - the exchange conversation identifier to set for this ReqIF file, not null

Throws:

InvalidValueException - if the specified value is null or empty

save

public void save(java.util.function.Consumer<ValidationMessage> validationMessageConsumer)
          throws FileException

Saves this ReqIF. If this ReqIF is inside a ReqIFArchive, calling this method will save the ReqIF inside the archive but the archive must still be saved by calling the ReqIFArchive.save(Consumer) method if the archive was loaded or ReqIFArchive.saveAs(String, Consumer) if the archive was created.

Parameters:

validationMessageConsumer - a consumer of validation message objects ValidationMessage, not null

Throws:

FileException - if a file system exception occurs

setIsModified

public void setIsModified(boolean isModified)

Allows to set the modified state of the ReqIF file.

Parameters:

isModified - the required modified state boolean

validate

public static ValidationOutcome validate(java.lang.String reqIFPath,
                                         java.util.function.Consumer<java.lang.String> logValidationMessage)
                                  throws FileException

Performs validation of the ReqIF file specified by reqIFPath against reqif.xsd. Also validates against rules specified in the ReqIF Implementors Guide

Parameters:

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

logValidationMessage - a consumer of validation messages, can be null in which case validation messages are ignored

Returns:

the outcome of the validation as a ValidationOutcome enumeration value, not null

Throws:

FileException - if the specified file does not exist