org.spdx.tools.compare.MultiDocumentSpreadsheet

public class MultiDocumentSpreadsheet
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type Class Description

protected static class MultiDocumentSpreadsheet.SpdxFileComparator

Field Summary

Fields
Modifier and Type	Field	Description
`protected static String`	`CREATOR_SHEET_NAME`
`protected CreatorSheet`	`creatorSheet`
`protected static String`	`DOCUMENT_ANNOTATION_SHEET_NAME`
`protected static String`	`DOCUMENT_RELATIONSHIP_SHEET_NAME`
`protected static String`	`DOCUMENT_SHEET_NAME`
`protected DocumentAnnotationSheet`	`documentAnnotationSheet`
`protected DocumentRelationshipSheet`	`documentRelationshipSheet`
`protected DocumentSheet`	`documentSheet`
`protected static String`	`EXTERNAL_REFERENCES_SHEET_NAME`
`protected ExternalReferencesSheet`	`externalReferencesSheet`
`protected static String`	`EXTRACTED_LICENSE_SHEET_NAME`
`protected ExtractedLicenseSheet`	`extractedLicenseSheet`
`protected static String`	`FILE_ANNOTATION_SHEET_NAME`
`protected static String`	`FILE_ATTRIBUTION_SHEET_NAME`
`protected static String`	`FILE_CHECKSUM_SHEET_NAME`
`protected static String`	`FILE_COMMENT_SHEET_NAME`
`protected static String`	`FILE_CONCLUDED_SHEET_NAME`
`protected static String`	`FILE_CONTRIBUTOR_SHEET_NAME`
`protected static String`	`FILE_COPYRIGHT_SHEET_NAME`
`protected static String`	`FILE_FOUND_SHEET_NAME`
`protected static String`	`FILE_LICENSE_COMMENT_SHEET_NAME`
`protected static String`	`FILE_NOTICE_SHEET_NAME`
`protected static String`	`FILE_RELATIONSHIP_SHEET`
`protected static String`	`FILE_SPDX_ID_SHEET_NAME`
`protected static String`	`FILE_TYPE_SHEET_NAME`
`protected FileAnnotationSheet`	`fileAnnotationSheet`
`protected FileAttributionSheet`	`fileAttributionSheet`
`protected FileChecksumSheet`	`fileChecksumSheet`
`protected FileCommentSheet`	`fileCommentSheet`
`protected FileConcludedSheet`	`fileConcludedSheet`
`protected FileContributorsSheet`	`fileContributorsSheet`
`protected FileCopyrightSheet`	`fileCopyrightSheet`
`protected FileLicenseCommentsSheet`	`fileLicenseCommentsSheet`
`protected FileLicenseInfoSheet`	`fileLicenseInfoSheet`
`protected FileNoticeSheet`	`fileNoticeSheet`
`protected FileRelationshipSheet`	`fileRelationshipSheet`
`protected FileSpdxIdSheet`	`fileSpdxIdSheet`
`protected FileTypeSheet`	`fileTypeSheet`
`static int`	`MAX_DOCUMENTS`
`protected static String`	`PACKAGE_SHEET_NAME`
`protected PackageSheet`	`packageSheet`
`protected File`	`saveFile`
`protected static String`	`SNIPPET_SHEET_NAME`
`protected SnippetSheet`	`snippetSheet`
`protected static String`	`VERIFICATION_SHEET_NAME`
`protected VerificationSheet`	`verificationSheet`
`protected org.apache.poi.ss.usermodel.Workbook`	`workbook`

Constructor Summary

Constructors

Constructor Description

MultiDocumentSpreadsheet(File spreadsheetFile, boolean create, boolean readonly)

Method Summary

Modifier and Type	Method	Description
`void`	`clear()`
`void`	`close()`
`void`	`create(File spreadsheetFile)`
`DocumentSheet`	`getDocumentSheet()`
`void`	`importCompareResults(org.spdx.utility.compare.SpdxComparer comparer, List<String> docNames)`
`void`	`importVerificationErrors(List<List<String>> verificationErrors, List<String> docNames)`
`String`	`verifyWorkbook()`
`void`	`writeToFile(File file)`	Writes the spreadsheet to a file

Methods inherited from class java.lang.Object

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

Field Details
- saveFile
  
  protected File saveFile
- workbook
  
  protected org.apache.poi.ss.usermodel.Workbook workbook
- DOCUMENT_SHEET_NAME
  
  protected static final String DOCUMENT_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- documentSheet
  
  protected DocumentSheet documentSheet
- CREATOR_SHEET_NAME
  
  protected static final String CREATOR_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- creatorSheet
  
  protected CreatorSheet creatorSheet
- PACKAGE_SHEET_NAME
  
  protected static final String PACKAGE_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- packageSheet
  
  protected PackageSheet packageSheet
- EXTRACTED_LICENSE_SHEET_NAME
  
  protected static final String EXTRACTED_LICENSE_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- extractedLicenseSheet
  
  protected ExtractedLicenseSheet extractedLicenseSheet
- FILE_CHECKSUM_SHEET_NAME
  
  protected static final String FILE_CHECKSUM_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- fileChecksumSheet
  
  protected FileChecksumSheet fileChecksumSheet
- FILE_CONCLUDED_SHEET_NAME
  
  protected static final String FILE_CONCLUDED_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- fileConcludedSheet
  
  protected FileConcludedSheet fileConcludedSheet
- FILE_FOUND_SHEET_NAME
  
  protected static final String FILE_FOUND_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- fileLicenseInfoSheet
  
  protected FileLicenseInfoSheet fileLicenseInfoSheet
- FILE_LICENSE_COMMENT_SHEET_NAME
  
  protected static final String FILE_LICENSE_COMMENT_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- fileLicenseCommentsSheet
  
  protected FileLicenseCommentsSheet fileLicenseCommentsSheet
- FILE_COMMENT_SHEET_NAME
  
  protected static final String FILE_COMMENT_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- fileCommentSheet
  
  protected FileCommentSheet fileCommentSheet
- FILE_TYPE_SHEET_NAME
  
  protected static final String FILE_TYPE_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- fileTypeSheet
  
  protected FileTypeSheet fileTypeSheet
- FILE_CONTRIBUTOR_SHEET_NAME
  
  protected static final String FILE_CONTRIBUTOR_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- fileContributorsSheet
  
  protected FileContributorsSheet fileContributorsSheet
- FILE_ATTRIBUTION_SHEET_NAME
  
  protected static final String FILE_ATTRIBUTION_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- fileAttributionSheet
  
  protected FileAttributionSheet fileAttributionSheet
- FILE_NOTICE_SHEET_NAME
  
  protected static final String FILE_NOTICE_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- fileNoticeSheet
  
  protected FileNoticeSheet fileNoticeSheet
- VERIFICATION_SHEET_NAME
  
  protected static final String VERIFICATION_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- MAX_DOCUMENTS
  
  public static final int MAX_DOCUMENTS
  
  See Also:
  
  Constant Field Values
- EXTERNAL_REFERENCES_SHEET_NAME
  
  protected static final String EXTERNAL_REFERENCES_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- DOCUMENT_RELATIONSHIP_SHEET_NAME
  
  protected static final String DOCUMENT_RELATIONSHIP_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- DOCUMENT_ANNOTATION_SHEET_NAME
  
  protected static final String DOCUMENT_ANNOTATION_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- FILE_SPDX_ID_SHEET_NAME
  
  protected static final String FILE_SPDX_ID_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- FILE_COPYRIGHT_SHEET_NAME
  
  protected static final String FILE_COPYRIGHT_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- FILE_ANNOTATION_SHEET_NAME
  
  protected static final String FILE_ANNOTATION_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- FILE_RELATIONSHIP_SHEET
  
  protected static final String FILE_RELATIONSHIP_SHEET
  
  See Also:
  
  Constant Field Values
- SNIPPET_SHEET_NAME
  
  protected static final String SNIPPET_SHEET_NAME
  
  See Also:
  
  Constant Field Values
- verificationSheet
  
  protected VerificationSheet verificationSheet
- externalReferencesSheet
  
  protected ExternalReferencesSheet externalReferencesSheet
- documentAnnotationSheet
  
  protected DocumentAnnotationSheet documentAnnotationSheet
- documentRelationshipSheet
  
  protected DocumentRelationshipSheet documentRelationshipSheet
- fileSpdxIdSheet
  
  protected FileSpdxIdSheet fileSpdxIdSheet
- fileCopyrightSheet
  
  protected FileCopyrightSheet fileCopyrightSheet
- fileAnnotationSheet
  
  protected FileAnnotationSheet fileAnnotationSheet
- fileRelationshipSheet
  
  protected FileRelationshipSheet fileRelationshipSheet
- snippetSheet
  
  protected SnippetSheet snippetSheet
Constructor Details
- MultiDocumentSpreadsheet
  
  public MultiDocumentSpreadsheet(File spreadsheetFile, boolean create, boolean readonly) throws org.spdx.spreadsheetstore.SpreadsheetException
  
  Parameters:
  
  spreadsheetFile -
  
  create -
  
  readonly -
  
  Throws:
  
  org.spdx.spreadsheetstore.SpreadsheetException
Method Details
- create
  
  public void create(File spreadsheetFile) throws IOException, org.spdx.spreadsheetstore.SpreadsheetException
  
  Throws:
  
  IOException
  
  org.spdx.spreadsheetstore.SpreadsheetException
- importCompareResults
  
  public void importCompareResults(org.spdx.utility.compare.SpdxComparer comparer, List<String> docNames) throws org.spdx.utility.compare.SpdxCompareException, org.spdx.library.InvalidSPDXAnalysisException
  
  Throws:
  
  org.spdx.utility.compare.SpdxCompareException
  
  org.spdx.library.InvalidSPDXAnalysisException
- clear
  
  public void clear()
- verifyWorkbook
  
  public String verifyWorkbook()
- importVerificationErrors
  
  public void importVerificationErrors(List<List<String>> verificationErrors, List<String> docNames) throws org.spdx.spreadsheetstore.SpreadsheetException
  
  Parameters:
  
  verificationErrors -
  
  docNames -
  
  Throws:
  
  org.spdx.spreadsheetstore.SpreadsheetException
- close
  
  public void close() throws org.spdx.spreadsheetstore.SpreadsheetException
  
  Throws:
  
  AnalyzeException
  
  org.spdx.spreadsheetstore.SpreadsheetException
- writeToFile
  
  public void writeToFile(File file) throws IOException
  
  Writes the spreadsheet to a file
  
  Throws:
  
  IOException
- getDocumentSheet
  
  public DocumentSheet getDocumentSheet()

Class MultiDocumentSpreadsheet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details