org.spdx.spdxspreadsheet.AbstractSpreadsheet

org.spdx.spdxspreadsheet.SPDXSpreadsheet

public class SPDXSpreadsheet
extends AbstractSpreadsheet

A spreadsheet containing information on an SPDX Document. The spreadsheet contains 4 sheets: - Origins - Information about the origin of the SPDX Document (Version, createdby, ...) - Package Info - Information about the package itself - Non-standard licenses - text from any non-standard licenses found - Per File Info - Information about each file in the document - Reviewers - Information on any organizations who have reviewed the documents See notes below on version management

Author:: Gary O'Neall

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CURRENT_VERSION`
`static com.google.common.collect.ImmutableList<String>`	`SUPPORTED_VERSIONS`
`static String`	`UNKNOWN_VERSION`
`static String`	`VERSION_0_9_1`
`static String`	`VERSION_0_9_2`
`static String`	`VERSION_0_9_3`
`static String`	`VERSION_0_9_4`
`static String`	`VERSION_1_1_0`
`static String`	`VERSION_1_2_0`
`static String`	`VERSION_2_0_0`
`static String`	`VERSION_2_1_0`

Fields inherited from class org.spdx.spdxspreadsheet.AbstractSpreadsheet

logger, saveFile, workbook

Constructor Summary

Constructors

Constructor Description

SPDXSpreadsheet(File spreadsheetFile, boolean create, boolean readonly)
Creates a new spreadsheet based on an existing file.

Method Summary

Modifier and Type	Method	Description
`void`	`clear()`
`void`	`create(File spreadsheetFile)`
`AnnotationsSheet`	`getAnnotationsSheet()`
`ExternalRefsSheet`	`getExternalRefsSheet()`
`NonStandardLicensesSheet`	`getNonStandardLicensesSheet()`
`DocumentInfoSheet`	`getOriginsSheet()`
`PackageInfoSheet`	`getPackageInfoSheet()`
`PerFileSheet`	`getPerFileSheet()`
`RelationshipsSheet`	`getRelationshipsSheet()`
`ReviewersSheet`	`getReviewersSheet()`
`SnippetSheet`	`getSnippetSheet()`
`void`	`resizeRow()`	Resize the height of all rows - will not exceed a maximum height
`void`	`setAnnotationsSheet(AnnotationsSheet annotationsSheet)`
`void`	`setExternaRefsSheet(ExternalRefsSheet externalRefsSheet)`
`void`	`setNonStandardLicensesSheet(NonStandardLicensesSheet nonStandardLicensesSheet)`
`void`	`setNonStandardLicensesSheet(NonStandardLicensesSheetV0d9d4 nonStandardLicensesSheet)`
`void`	`setOriginsSheet(DocumentInfoSheet originsSheet)`
`void`	`setPackageInfoSheet(PackageInfoSheet packageInfoSheet)`
`void`	`setPackageInfoSheet(PackageInfoSheetV09d2 packageInfoSheet)`
`void`	`setPerFileSheet(PerFileSheet perFileSheet)`
`void`	`setPerFileSheet(PerFileSheetV09d3 perFileSheet)`
`void`	`setRelationshipsSheet(RelationshipsSheet relationshipsSheet)`
`void`	`setReviewersSheet(ReviewersSheet reviewersSheet)`
`void`	`setSnippetSheet(SnippetSheet snippetSheet)`
`static boolean`	`verifyVersion(String versionToCheck)`
`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 Details
- CURRENT_VERSION
  
  public static final String CURRENT_VERSION
  
  See Also:
  
  Constant Field Values
- VERSION_2_1_0
  
  public static final String VERSION_2_1_0
  
  See Also:
  
  Constant Field Values
- VERSION_2_0_0
  
  public static final String VERSION_2_0_0
  
  See Also:
  
  Constant Field Values
- VERSION_1_2_0
  
  public static final String VERSION_1_2_0
  
  See Also:
  
  Constant Field Values
- VERSION_1_1_0
  
  public static final String VERSION_1_1_0
  
  See Also:
  
  Constant Field Values
- VERSION_0_9_4
  
  public static final String VERSION_0_9_4
  
  See Also:
  
  Constant Field Values
- VERSION_0_9_3
  
  public static final String VERSION_0_9_3
  
  See Also:
  
  Constant Field Values
- VERSION_0_9_2
  
  public static final String VERSION_0_9_2
  
  See Also:
  
  Constant Field Values
- VERSION_0_9_1
  
  public static final String VERSION_0_9_1
  
  See Also:
  
  Constant Field Values
- SUPPORTED_VERSIONS
  
  public static final com.google.common.collect.ImmutableList<String> SUPPORTED_VERSIONS
- UNKNOWN_VERSION
  
  public static final String UNKNOWN_VERSION
  
  See Also:
  
  Constant Field Values
Constructor Details
- SPDXSpreadsheet
  
  public SPDXSpreadsheet(File spreadsheetFile, boolean create, boolean readonly) throws SpreadsheetException
  
  Creates a new spreadsheet based on an existing file. Handles all version compatibilities
  
  Parameters:
  
  spreadsheetFile -
  
  create -
  
  readonly -
  
  Throws:
  
  SpreadsheetException
Method Details
- verifyVersion
  
  public static boolean verifyVersion(String versionToCheck)
  
  Parameters:
  
  versionToCheck -
  
  Returns:
- create
  
  public void create(File spreadsheetFile) throws IOException, SpreadsheetException
  
  Specified by:
  
  create in class AbstractSpreadsheet
  
  Throws:
  
  IOException
  
  SpreadsheetException
- clear
  
  public void clear()
  
  Specified by:
  
  clear in class AbstractSpreadsheet
- verifyWorkbook
  
  public String verifyWorkbook()
  
  Specified by:
  
  verifyWorkbook in class AbstractSpreadsheet
- getOriginsSheet
  
  public DocumentInfoSheet getOriginsSheet()
  
  Returns:
  
  the originsSheet
- setOriginsSheet
  
  public void setOriginsSheet(DocumentInfoSheet originsSheet)
  
  Parameters:
  
  originsSheet - the originsSheet to set
- getPackageInfoSheet
  
  public PackageInfoSheet getPackageInfoSheet()
  
  Returns:
  
  the packageInfoSheet
- setPackageInfoSheet
  
  public void setPackageInfoSheet(PackageInfoSheetV09d2 packageInfoSheet)
  
  Parameters:
  
  packageInfoSheet - the packageInfoSheet to set
- getNonStandardLicensesSheet
  
  public NonStandardLicensesSheet getNonStandardLicensesSheet()
  
  Returns:
  
  the nonStandardLicensesSheet
- setNonStandardLicensesSheet
  
  public void setNonStandardLicensesSheet(NonStandardLicensesSheetV0d9d4 nonStandardLicensesSheet)
  
  Parameters:
  
  nonStandardLicensesSheet - the nonStandardLicensesSheet to set
- getPerFileSheet
  
  public PerFileSheet getPerFileSheet()
  
  Returns:
  
  the perFileSheet
- setPerFileSheet
  
  public void setPerFileSheet(PerFileSheetV09d3 perFileSheet)
  
  Parameters:
  
  perFileSheet - the perFileSheet to set
- getReviewersSheet
  
  public ReviewersSheet getReviewersSheet()
  
  Returns:
  
  the reviewersSheet
- setReviewersSheet
  
  public void setReviewersSheet(ReviewersSheet reviewersSheet)
  
  Parameters:
  
  reviewersSheet - the reviewersSheet to set
- getRelationshipsSheet
  
  public RelationshipsSheet getRelationshipsSheet()
- setRelationshipsSheet
  
  public void setRelationshipsSheet(RelationshipsSheet relationshipsSheet)
- getAnnotationsSheet
  
  public AnnotationsSheet getAnnotationsSheet()
- setAnnotationsSheet
  
  public void setAnnotationsSheet(AnnotationsSheet annotationsSheet)
- setPackageInfoSheet
  
  public void setPackageInfoSheet(PackageInfoSheet packageInfoSheet)
- setNonStandardLicensesSheet
  
  public void setNonStandardLicensesSheet(NonStandardLicensesSheet nonStandardLicensesSheet)
- setPerFileSheet
  
  public void setPerFileSheet(PerFileSheet perFileSheet)
- getSnippetSheet
  
  public SnippetSheet getSnippetSheet()
  
  Returns:
  
  the snippetSheet
- setSnippetSheet
  
  public void setSnippetSheet(SnippetSheet snippetSheet)
  
  Parameters:
  
  snippetSheet - the snippetSheet to set
- getExternalRefsSheet
  
  public ExternalRefsSheet getExternalRefsSheet()
  
  Returns:
  
  the externalRefsSheet
- setExternaRefsSheet
  
  public void setExternaRefsSheet(ExternalRefsSheet externalRefsSheet)
  
  Parameters:
  
  snippetSheet - the snippetSheet to set
- resizeRow
  
  public void resizeRow()
  
  Resize the height of all rows - will not exceed a maximum height

Class SPDXSpreadsheet

Field Summary

Fields inherited from class org.spdx.spdxspreadsheet.AbstractSpreadsheet

Constructor Summary

Method Summary

Methods inherited from class org.spdx.spdxspreadsheet.AbstractSpreadsheet

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details