org.spdx.spdxspreadsheet

Class LicenseSheet

java.lang.Object

org.spdx.spdxspreadsheet.AbstractSheet

org.spdx.spdxspreadsheet.LicenseSheet

public class LicenseSheet
extends AbstractSheet

Spreadsheet holding SPDX Licenses The text column can contain either the text for the license or a hyperlink to a file containing the text. The text file location is relative to the directory containing the spreadsheet.

Author:

Gary O'Neall

Field Summary

Fields inherited from class org.spdx.spdxspreadsheet.AbstractSheet

checkboxStyle, dateStyle, firstCellNum, firstRowNum, FONT_SIZE, greenWrapped, lastRowNum, redWrapped, sheet, workbook, yellowWrapped

Constructor Summary

Constructors

Constructor and Description
LicenseSheet(org.apache.poi.ss.usermodel.Workbook workbook, String sheetName, File workbookFile)

Method Summary

Modifier and Type	Method and Description
void	add(SpdxListedLicense license)
static void	create(org.apache.poi.ss.usermodel.Workbook wb, String sheetName, String version, String releaseDate) Create a blank worksheet NOTE: Replaces / deletes existing sheet by the same name
SpdxListedLicense	getLicense(int rowNum) Retrieve a license for a specific row in the sheet
static String	getLicenseTemplateText(org.apache.poi.ss.usermodel.Cell textCell, String textFilePath) Retrieve the text from a license text cell either through the hyperlink to a text file in a directory local to the spreadsheet or from the cell itself if there is no hyperlink present
String	getReleaseDate()
String	getVersion()
static void	setTemplateText(org.apache.poi.ss.usermodel.Cell textCell, String text, String licenseId, String textFilePath, org.apache.poi.ss.usermodel.Workbook workbook) Adds a license template to a text cell.
String	verify()

Methods inherited from class org.spdx.spdxspreadsheet.AbstractSheet

addRow, clear, createCenterStyle, createHeaderStyle, createLeftWrapStyle, getFirstDataRow, getNumDataRows, getSheet, resizeRows

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseSheet

public LicenseSheet(org.apache.poi.ss.usermodel.Workbook workbook,
                    String sheetName,
                    File workbookFile)

Method Detail

create

public static void create(org.apache.poi.ss.usermodel.Workbook wb,
                          String sheetName,
                          String version,
                          String releaseDate)

Create a blank worksheet NOTE: Replaces / deletes existing sheet by the same name

getVersion

public String getVersion()

Returns:

the version

getReleaseDate

public String getReleaseDate()

Returns:

the releaseDate

add

public void add(SpdxListedLicense license)

setTemplateText

public static void setTemplateText(org.apache.poi.ss.usermodel.Cell textCell,
                                   String text,
                                   String licenseId,
                                   String textFilePath,
                                   org.apache.poi.ss.usermodel.Workbook workbook)

Adds a license template to a text cell. First attempts to create a file and a hyperlink to the file. If that fails, will attempt to add the text directly to the file.

Parameters:

textCell -

text -

getLicenseTemplateText

public static String getLicenseTemplateText(org.apache.poi.ss.usermodel.Cell textCell,
                                            String textFilePath)

Retrieve the text from a license text cell either through the hyperlink to a text file in a directory local to the spreadsheet or from the cell itself if there is no hyperlink present

Parameters:

textCell -

Returns:

getLicense

public SpdxListedLicense getLicense(int rowNum)
                             throws InvalidSPDXAnalysisException

Retrieve a license for a specific row in the sheet

Parameters:

rowNum -

Returns:

Throws:

InvalidSPDXAnalysisException

verify

public String verify()

Specified by:

verify in class AbstractSheet