org.spdx.spdxspreadsheet

Class NonStandardLicensesSheet

java.lang.Object

org.spdx.spdxspreadsheet.AbstractSheet

org.spdx.spdxspreadsheet.NonStandardLicensesSheet

Direct Known Subclasses:

NonStandardLicensesSheetV0d9d4, NonStandardLicensesSheetV1d1

public abstract class NonStandardLicensesSheet
extends AbstractSheet

Abstract sheet for NonSTandardLicenses. Specific versions are implemented as subclasses.

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field and Description
protected String	version

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
NonStandardLicensesSheet(org.apache.poi.ss.usermodel.Workbook workbook, String sheetName, String version)

Method Summary

Modifier and Type	Method and Description
abstract void	add(String identifier, String extractedText, String licenseName, String[] crossRefUrls, String comment) Add a new row to the NonStandardLicenses sheet
static void	create(org.apache.poi.ss.usermodel.Workbook wb, String nonStandardLicenseSheetName) Create a blank worksheet NOTE: Replaces / deletes existing sheet by the same name
abstract String	getComment(int rowNum)
abstract String[]	getCrossRefUrls(int rowNum)
abstract String	getExtractedText(int rowNum) Retrieve the extracted text for a specific row in the spreadsheet
abstract String	getIdentifier(int rowNum) Retrieve the license identifier for a specific row in the spreadsheet
abstract String	getLicenseName(int rowNum)
static NonStandardLicensesSheet	openVersion(org.apache.poi.ss.usermodel.Workbook workbook, String nonStandardLicenseSheetName, String version) Open an existing NonStandardLicenseSheet

Methods inherited from class org.spdx.spdxspreadsheet.AbstractSheet

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

Methods inherited from class java.lang.Object

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

Field Detail

version

protected String version

Constructor Detail

NonStandardLicensesSheet

public NonStandardLicensesSheet(org.apache.poi.ss.usermodel.Workbook workbook,
                                String sheetName,
                                String version)

Parameters:

workbook -

sheetName -

Method Detail

getIdentifier

public abstract String getIdentifier(int rowNum)

Retrieve the license identifier for a specific row in the spreadsheet

Parameters:

rowNum -

Returns:

getExtractedText

public abstract String getExtractedText(int rowNum)

Retrieve the extracted text for a specific row in the spreadsheet

Parameters:

rowNum -

Returns:

add

public abstract void add(String identifier,
                         String extractedText,
                         String licenseName,
                         String[] crossRefUrls,
                         String comment)

Add a new row to the NonStandardLicenses sheet

Parameters:

identifier - License ID

extractedText - Extracted license text

optional - license name

crossRefUrls - optional cross reference URL's

optional - comment

openVersion

public static NonStandardLicensesSheet openVersion(org.apache.poi.ss.usermodel.Workbook workbook,
                                                   String nonStandardLicenseSheetName,
                                                   String version)

Open an existing NonStandardLicenseSheet

Parameters:

workbook -

nonStandardLicenseSheetName -

version - Spreadsheet version

Returns:

create

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

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

Parameters:

wb -

nonStandardLicenseSheetName -

getLicenseName

public abstract String getLicenseName(int rowNum)

Returns:

getCrossRefUrls

public abstract String[] getCrossRefUrls(int rowNum)

Returns:

getComment

public abstract String getComment(int rowNum)

Returns: