Package org.spdx.spreadsheetstore

Class PerFileSheet

java.lang.Object

org.spdx.spreadsheetstore.AbstractSheet

org.spdx.spreadsheetstore.PerFileSheet

Direct Known Subclasses:

PerFileSheetV2d0, PerFileSheetV2d2, PerFileSheetV2d3

public abstract class PerFileSheet
extends AbstractSheet

Abstract class for PerFileSheet. Specific version implementations are implemented as subclasses.

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field	Description
protected String	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
PerFileSheet(org.apache.poi.ss.usermodel.Workbook workbook, String sheetName, String version, org.spdx.storage.IModelStore modelStore, String documentUri, org.spdx.library.ModelCopyManager copyManager)

Method Summary

Modifier and Type	Method	Description
abstract void	add(org.spdx.library.model.v2.SpdxFile file, String pkgIds)	Add the file to the spreadsheet
static void	create(org.apache.poi.ss.usermodel.Workbook wb, String perFileSheetName)	Create a blank worksheet NOTE: Replaces / deletes existing sheet by the same name
static String	fileTypesToString(Collection<org.spdx.library.model.v2.enumerations.FileType> fileTypeCollection)
protected abstract String	getFileId(int rowNum)
abstract org.spdx.library.model.v2.SpdxFile	getFileInfo(int rowNum)	Get the file information for a row in the PerFileSheet
abstract List<String>	getPackageIds(int row)
static PerFileSheet	openVersion(org.apache.poi.ss.usermodel.Workbook workbook, String perFileSheetName, String version, org.spdx.storage.IModelStore modelStore, String documentUri, org.spdx.library.ModelCopyManager copyManager)	Open a specific version of the PerFileSheet
static Collection<org.spdx.library.model.v2.enumerations.FileType>	parseFileTypeString(String typeStr)

Methods inherited from class org.spdx.spreadsheetstore.AbstractSheet

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

Methods inherited from class java.lang.Object

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

Field Details

version

protected String version

Constructor Details

PerFileSheet

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

Parameters:

workbook -

sheetName -

version -

modelStore -

documentUri -

copyManager -

Method Details

openVersion

public static PerFileSheet openVersion(org.apache.poi.ss.usermodel.Workbook workbook,
 String perFileSheetName,
 String version,
 org.spdx.storage.IModelStore modelStore,
 String documentUri,
 org.spdx.library.ModelCopyManager copyManager)

Open a specific version of the PerFileSheet

Parameters:

workbook -

perFileSheetName -

version -

modelStore -

documentUri -

copyManager -

Returns:

add

public abstract void add(org.spdx.library.model.v2.SpdxFile file,
 String pkgIds)
                  throws SpreadsheetException

Add the file to the spreadsheet

Parameters:

file -

pkgIds - string containing the package ID's which contain this file

Throws:

SpreadsheetException

getFileInfo

public abstract org.spdx.library.model.v2.SpdxFile getFileInfo(int rowNum)
                                                        throws SpreadsheetException,
org.spdx.core.DefaultStoreNotInitializedException

Get the file information for a row in the PerFileSheet

Parameters:

rowNum -

Returns:

Throws:

org.spdx.core.DefaultStoreNotInitializedException

SpreadsheetException

create

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

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

Parameters:

wb -

perFileSheetName -

getPackageIds

public abstract List<String> getPackageIds(int row)

Parameters:

row -

Returns:

fileTypesToString

public static String fileTypesToString(Collection<org.spdx.library.model.v2.enumerations.FileType> fileTypeCollection)

Parameters:

fileTypeCollection -

Returns:

parseFileTypeString

public static Collection<org.spdx.library.model.v2.enumerations.FileType> parseFileTypeString(String typeStr)
                                                                                       throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

typeStr -

Returns:

Throws:

org.spdx.core.InvalidSPDXAnalysisException

getFileId

protected abstract String getFileId(int rowNum)

Parameters:

rowNum -

Returns:

file ID for rownum