Package org.spdx.spreadsheetstore

Class ExtractedLicenseInfoSheetV1d1

java.lang.Object

org.spdx.spreadsheetstore.AbstractSheet

org.spdx.spreadsheetstore.ExtractedLicenseInfoSheet

org.spdx.spreadsheetstore.ExtractedLicenseInfoSheetV1d1

public class ExtractedLicenseInfoSheetV1d1
extends ExtractedLicenseInfoSheet

Sheet containing the text of any non-standard licenses found in an SPDX document Implementat for version 1.1

Author:

Gary O'Neall

Field Summary

Fields inherited from class org.spdx.spreadsheetstore.ExtractedLicenseInfoSheet

version

Fields inherited from class org.spdx.spreadsheetstore.AbstractSheet

checkboxStyle, CHECKSUM_PATTERN, copyManager, dateStyle, documentUri, firstCellNum, firstRowNum, FONT_SIZE, greenWrapped, lastRowNum, modelStore, redWrapped, sheet, workbook, yellowWrapped

Constructor Summary

Constructors

Constructor	Description
ExtractedLicenseInfoSheetV1d1(org.apache.poi.ss.usermodel.Workbook workbook, String packageInfoSheetName, String version, org.spdx.storage.IModelStore modelStore, String documentUri, org.spdx.library.ModelCopyManager copyManager)

Method Summary

Modifier and Type	Method	Description
void	add(String identifier, String extractedTextIn, String licenseName, Collection<String> crossRefUrlCollection, String comment)	Add a new row to the NonStandardLicenses sheet
static void	create(org.apache.poi.ss.usermodel.Workbook wb, String sheetName)
String	getComment(int rowNum)	Retrieves the comment for a specific row.
Collection<String>	getCrossRefUrls(int rowNum)	Retrieves the cross-reference URLs for a specific row.
String	getExtractedText(int rowNum)	Retrieve the extracted text for a specific row in the spreadsheet
String	getIdentifier(int rowNum)	Retrieve the license identifier for a specific row in the spreadsheet
String	getLicenseName(int rowNum)	Retrieves the license name for a specific row.
String	verify()	Verifies the integrity of the sheet's data

Methods inherited from class org.spdx.spreadsheetstore.ExtractedLicenseInfoSheet

openVersion

Methods inherited from class org.spdx.spreadsheetstore.AbstractSheet

addRow, checksumsToString, checksumToString, clear, createCenterStyle, createHeaderStyle, createLeftWrapStyle, csvToStrings, getFirstDataRow, getNumDataRows, getSheet, licensesToString, parseChecksum, resizeRows, stringsToCsv, strToChecksums

Methods inherited from class java.lang.Object

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

Constructor Details

ExtractedLicenseInfoSheetV1d1

public ExtractedLicenseInfoSheetV1d1(org.apache.poi.ss.usermodel.Workbook workbook,
 String packageInfoSheetName,
 String version,
 org.spdx.storage.IModelStore modelStore,
 String documentUri,
 org.spdx.library.ModelCopyManager copyManager)

Method Details

create

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

getIdentifier

public String getIdentifier(int rowNum)

Description copied from class: ExtractedLicenseInfoSheet

Retrieve the license identifier for a specific row in the spreadsheet

Specified by:

getIdentifier in class ExtractedLicenseInfoSheet

Parameters:

rowNum - Row number in the sheet.

Returns:

License identifier.

getExtractedText

public String getExtractedText(int rowNum)

Description copied from class: ExtractedLicenseInfoSheet

Retrieve the extracted text for a specific row in the spreadsheet

Specified by:

getExtractedText in class ExtractedLicenseInfoSheet

Parameters:

rowNum - Row number in the sheet.

Returns:

Extracted license text.

add

public void add(String identifier,
 String extractedTextIn,
 String licenseName,
 Collection<String> crossRefUrlCollection,
 String comment)

Description copied from class: ExtractedLicenseInfoSheet

Add a new row to the NonStandardLicenses sheet

Specified by:

add in class ExtractedLicenseInfoSheet

Parameters:

identifier - License ID

extractedTextIn - Extracted license text

licenseName - optional license name

crossRefUrlCollection - optional cross reference URL's

comment - optional comment

getLicenseName

public String getLicenseName(int rowNum)

Description copied from class: ExtractedLicenseInfoSheet

Retrieves the license name for a specific row.

Specified by:

getLicenseName in class ExtractedLicenseInfoSheet

Parameters:

rowNum - Row number in the sheet.

Returns:

License name.

getCrossRefUrls

public Collection<String> getCrossRefUrls(int rowNum)

Description copied from class: ExtractedLicenseInfoSheet

Retrieves the cross-reference URLs for a specific row.

Specified by:

getCrossRefUrls in class ExtractedLicenseInfoSheet

Parameters:

rowNum - Row number in the sheet.

Returns:

A collection of cross-reference URLs.

getComment

public String getComment(int rowNum)

Description copied from class: ExtractedLicenseInfoSheet

Retrieves the comment for a specific row.

Specified by:

getComment in class ExtractedLicenseInfoSheet

Parameters:

rowNum - Row number in the sheet.

Returns:

Comment as a string.

verify

public String verify()

Description copied from class: AbstractSheet

Verifies the integrity of the sheet's data

Specified by:

verify in class AbstractSheet

Returns:

A string describing any issues, or an empty string if valid.