org.spdx.spdxspreadsheet

Class PerFileSheet

java.lang.Object

org.spdx.spdxspreadsheet.AbstractSheet

org.spdx.spdxspreadsheet.PerFileSheet

Direct Known Subclasses:

PerFileSheetV09d3, PerFileSheetV1d1, PerFileSheetV1d2, PerFileSheetV2d0

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

Method Summary

Modifier and Type	Method and Description
abstract void	add(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[]	csvToStrings(String csv) Converts a comma separated CSV string to an array of strings
abstract SpdxFile	getFileInfo(int rowNum, SpdxDocumentContainer container) Get the file information for a row in the PerFileSheet
abstract String[]	getPackageIds(int row)
static PerFileSheet	openVersion(org.apache.poi.ss.usermodel.Workbook workbook, String perFileSheetName, String version) Open a specific version of the PerFileSheet
static String	stringsToCsv(String[] strings) converts an array of strings to a comma separated list

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

PerFileSheet

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

Method Detail

openVersion

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

Open a specific version of the PerFileSheet

Parameters:

workbook -

perFileSheetName -

version - spreadsheet version

Returns:

stringsToCsv

public static String stringsToCsv(String[] strings)

converts an array of strings to a comma separated list

Parameters:

strings -

Returns:

csvToStrings

public static String[] csvToStrings(String csv)

Converts a comma separated CSV string to an array of strings

Parameters:

csv -

Returns:

add

public abstract void add(SpdxFile file,
                         String pkgIds)

Add the file to the spreadsheet

Parameters:

file -

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

getFileInfo

public abstract SpdxFile getFileInfo(int rowNum,
                                     SpdxDocumentContainer container)
                              throws SpreadsheetException

Get the file information for a row in the PerFileSheet

Parameters:

rowNum -

Returns:

Throws:

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 String[] getPackageIds(int row)

Parameters:

row -

Returns: