org.spdx.spdxspreadsheet

Class SnippetSheet

java.lang.Object

org.spdx.spdxspreadsheet.AbstractSheet

org.spdx.spdxspreadsheet.SnippetSheet

public class SnippetSheet
extends AbstractSheet

Sheet to hold all snippet information

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

Method Summary

Modifier and Type	Method and Description
void	add(SpdxSnippet snippet)
static void	create(org.apache.poi.ss.usermodel.Workbook wb, String sheetName)
SpdxSnippet	getSnippet(int rowNum, SpdxDocumentContainer container) Get the SPDX snippet represented in the row rownum.
String	getSnippetFileId(int rowNum) Get the SpdxFromFileSNippet for the given row
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

SnippetSheet

public SnippetSheet(org.apache.poi.ss.usermodel.Workbook workbook,
                    String snippetSheetName)

Parameters:

workbook -

snippetSheetName -

Method Detail

verify

public String verify()

Specified by:

verify in class AbstractSheet

create

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

add

public void add(SpdxSnippet snippet)
         throws SpreadsheetException

Parameters:

snippet -

Throws:

SpreadsheetException

getSnippet

public SpdxSnippet getSnippet(int rowNum,
                              SpdxDocumentContainer container)
                       throws SpreadsheetException

Get the SPDX snippet represented in the row rownum. IMPORTANT: The Snippet From File will only be filled in if the associated file is found in the container. This property can be set after calling getSnippet if the model is not already populated with the file The ID from the Snippet From File can be obtained through the getSnippetFileId(int rowNum) method

Parameters:

rowNum -

Returns:

Snippet at the row rowNum or null if the row does not exist

Throws:

SpreadsheetException

getSnippetFileId

public String getSnippetFileId(int rowNum)
                        throws SpreadsheetException

Get the SpdxFromFileSNippet for the given row

Parameters:

rowNum -

Returns:

Throws:

SpreadsheetException