org.spdx.compare

Class MultiDocumentSpreadsheet

java.lang.Object

org.spdx.spdxspreadsheet.AbstractSpreadsheet

org.spdx.compare.MultiDocumentSpreadsheet

public class MultiDocumentSpreadsheet
extends AbstractSpreadsheet

Spreadsheet holding the results of a comparison from multiple SPDX documents Each sheet contains the comparison result results with the columns representing the SPDX documents and the rows representing the SPDX fields. The sheets include: - document: Document level fields Created, Data License, Document Comment, created date, creator comment - creator: Creators - package: Package level fields name, version, filename, supplier, ... - extracted license info: Extracted license text and identifiers - file checksums: file checksums - file concluded: license concluded for each file - file licenseInfo: license information from each file - file license comments: license comments from each file - file artifactOfs: artifact of for all files - file type: file type of all files - reviewers: review information - verification: List of any verification errors

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_DOCUMENTS

Fields inherited from class org.spdx.spdxspreadsheet.AbstractSpreadsheet

saveFile, workbook

Constructor Summary

Constructors

Constructor and Description
MultiDocumentSpreadsheet(File spreadsheetFile, boolean create, boolean readonly)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
void	create(File spreadsheetFile)
void	importCompareResults(SpdxComparer comparer, String[] docNames)
void	importVerificationErrors(ArrayList<String>[] verificationErrors, String[] docNames)
String	verifyWorkbook()

Methods inherited from class org.spdx.spdxspreadsheet.AbstractSpreadsheet

close, writeToFile

Methods inherited from class java.lang.Object

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

Field Detail

MAX_DOCUMENTS

public static final int MAX_DOCUMENTS

See Also:

Constant Field Values

Constructor Detail

MultiDocumentSpreadsheet

public MultiDocumentSpreadsheet(File spreadsheetFile,
                        boolean create,
                        boolean readonly)
                         throws SpreadsheetException

Parameters:

spreadsheetFile -

create -

readonly -

Throws:

SpreadsheetException

Method Detail

create

public void create(File spreadsheetFile)
            throws IOException,
                   SpreadsheetException

Specified by:

create in class AbstractSpreadsheet

Throws:

IOException

SpreadsheetException

importCompareResults

public void importCompareResults(SpdxComparer comparer,
                        String[] docNames)
                          throws SpdxCompareException,
                                 InvalidSPDXAnalysisException

Throws:

SpdxCompareException

InvalidSPDXAnalysisException

clear

public void clear()

Specified by:

clear in class AbstractSpreadsheet

verifyWorkbook

public String verifyWorkbook()

Specified by:

verifyWorkbook in class AbstractSpreadsheet

importVerificationErrors

public void importVerificationErrors(ArrayList<String>[] verificationErrors,
                            String[] docNames)
                              throws SpreadsheetException

Parameters:

verificationErrors -

docNames -

Throws:

SpreadsheetException