com.reqdesign.reqif

Class ReqIFArchive

java.lang.Object

com.reqdesign.reqif.ReqIFArchive

public final class ReqIFArchive
extends java.lang.Object

Class for a ReqIF archive (extension .reqifz). Can be constructed from an existing archive or created empty and existing or new ReqIF files added to it.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
ReqIFFile	addExistingReqIFFile(java.lang.String reqIFPath, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Adds to this archive a new ReqIFFile object loaded from the existing ReqIF file identified by the specified full path
ReqIFFile	createReqIFFile(java.lang.String filename, 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) Constructs a new empty named ReqIF file and adds it to the archive.
java.util.List<java.lang.String>	getArchiveFileRelativePaths() Returns the List<String> of relative paths obtained from all 'data' attributes in XHTML <object> elements
Identifiable<?>	getIdentifiable(java.lang.String identifier) Returns the Identifiable object according to the specified identifier
java.lang.String	getPath() Returns the path of this archive if the archive was loaded or saved from disk.
ReqIFFiles	getReqIFFiles() Gets the collection of ReqIFFile objects inside this archive.
java.nio.file.Path	getTempDirPath()
void	removeReqIFFile(ReqIFFile reqIFFileToRemove) Removes the specified ReqIFFile from the archive
void	save(java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Saves this archive in the current archive path as established when the archive was loaded, if it was loaded Otherwise established in the last call to saveAs.
void	saveAs(java.lang.String targetPath, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Saves this archive in the specified path

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

getArchiveFileRelativePaths

public java.util.List<java.lang.String> getArchiveFileRelativePaths()

Returns the List<String> of relative paths obtained from all 'data' attributes in XHTML <object> elements

Returns:

the List<String> of relative paths obtained from all 'data' attributes in XHTML <object> elements

getPath

public java.lang.String getPath()

Returns the path of this archive if the archive was loaded or saved from disk.

If the archive was created not loaded/saved, this methods returns the temporary location

Returns:

the path of the ReqIF archive, or null if the archive has not yet been saved

createReqIFFile

public ReqIFFile createReqIFFile(java.lang.String filename,
                                 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 AlreadyExistsException,
                                 FileException,
                                 InvalidValueException,
                                 InvalidIdentifierException

Constructs a new empty named ReqIF file and adds it to the archive. At this point the file identified by filename is not located on any file system and it must not contain any folder paths and must end with the extension .reqif

Parameters:

filename - the name of the ReqIF file, 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 ReqIFFile object, not null

Throws:

AlreadyExistsException - if the ReqIF file identified by the filename parameter has already been added to the archive

FileException - if an exception occurs during creation of the ReqIF file

InvalidValueException - if a required parameter is null or empty

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

getReqIFFiles

public ReqIFFiles getReqIFFiles()

Gets the collection of ReqIFFile objects inside this archive.

Returns:

the ReqIFFiles collection, not null

removeReqIFFile

public void removeReqIFFile(ReqIFFile reqIFFileToRemove)
                     throws NotFoundException

Removes the specified ReqIFFile from the archive

Parameters:

reqIFFileToRemove - ReqIFFile object to removeItem from the archive

Throws:

NotFoundException - Specified ReqIFFile object is not in this archive

getIdentifiable

public Identifiable<?> getIdentifiable(java.lang.String identifier)

Returns the Identifiable object according to the specified identifier

Parameters:

identifier - the String identifier of the Identifiable to search, not null

Returns:

the Identifiable object with the specified identifier or null

addExistingReqIFFile

public ReqIFFile addExistingReqIFFile(java.lang.String reqIFPath,
                                      java.util.function.Consumer<ValidationMessage> validationMessageConsumer)
                               throws NotFoundException,
                                      AlreadyExistsException,
                                      FileException,
                                      ValidationException,
                                      java.io.IOException

Adds to this archive a new ReqIFFile object loaded from the existing ReqIF file identified by the specified full path

Parameters:

reqIFPath - the full path to the ReqIF file to add to this archive

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

Returns:

the ReqIFFile object loaded from the specified file, not null

Throws:

NotFoundException - if the file at the specified path does not exist

AlreadyExistsException - if the specified path already represented in the archive

FileException - if the file at the specified path is not a valid ReqIF

ValidationException - if ReqIF validation errors have occurred

java.io.IOException - if the ReqIF file could not be copied into the archive temp folder

getTempDirPath

public java.nio.file.Path getTempDirPath()

save

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

Saves this archive in the current archive path as established when the archive was loaded, if it was loaded Otherwise established in the last call to saveAs.

Parameters:

validationMessageConsumer - the Consumer to receive validation messages, not null

Throws:

FileException - if a file system exception occurs when saving

NotSavedException - if the path has not already been established in a previous call to saveAs

saveAs

public void saveAs(java.lang.String targetPath,
                   java.util.function.Consumer<ValidationMessage> validationMessageConsumer)
            throws FileException

Saves this archive in the specified path

Parameters:

targetPath - the path for the ReqIF archive

validationMessageConsumer - the Consumer to receive validation messages, not null

Throws:

FileException - if a file system exception occurs when saving