org.spdx.spdxspreadsheet

Class DocumentInfoSheet

java.lang.Object

org.spdx.spdxspreadsheet.AbstractSheet

org.spdx.spdxspreadsheet.DocumentInfoSheet

Direct Known Subclasses:

OriginsSheetV0d9d4, OriginsSheetV1d1, OriginsSheetV1d2, OriginsSheetV2d0

public abstract class DocumentInfoSheet
extends AbstractSheet

Abstract class for sheet containing information about the origins of an SPDX document Specific versions 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
DocumentInfoSheet(org.apache.poi.ss.usermodel.Workbook workbook, String sheetName, String version)

Method Summary

Modifier and Type	Method and Description
abstract void	addDocument(SpdxDocument doc) Add all origin information from the document
static void	create(org.apache.poi.ss.usermodel.Workbook wb, String sheetName)
abstract String	getAuthorComments()
abstract Date	getCreated()
abstract String[]	getCreatedBy()
protected Date	getDataCellDateValue(int colNum)
protected String	getDataCellStringValue(int colNum)
abstract String	getDataLicense()
protected org.apache.poi.ss.usermodel.Row	getDataRow()
protected org.apache.poi.ss.usermodel.Row	getDataRow(int rowIndex)
abstract String	getDocumentComment()
abstract String[]	getDocumentContents()
abstract String	getDocumentName()
abstract ExternalDocumentRef[]	getExternalDocumentRefs()
abstract String	getLicenseListVersion()
abstract String	getNamespace()
protected org.apache.poi.ss.usermodel.Cell	getOrCreateDataCell(int colNum)
abstract String	getSpdxId()
abstract String	getSPDXVersion()
static DocumentInfoSheet	openVersion(org.apache.poi.ss.usermodel.Workbook workbook, String originSheetName, String version) Open an existing worksheet
abstract void	setAuthorComments(String comments)
abstract void	setCreated(Date parse)
abstract void	setCreatedBy(String[] createdBys)
protected void	setDataCellDateValue(int colNum, Date value)
protected void	setDataCellStringValue(int colNum, String value)
abstract void	setDataLicense(String id)
abstract void	setDocumentComment(String docComment)
abstract void	setDocumentDescribes(String[] contents) Set the SPDX ID's for content described by this SPDX document
abstract void	setDocumentName(String documentName) Set the document name
abstract void	setExternalDocumentRefs(ExternalDocumentRef[] externalDocumentRefs) Set the external document refs
abstract void	setLicenseListVersion(String licenseVersion)
abstract void	setSpdxId(String id) Set the SPDX identified for the document
abstract void	setSPDXVersion(String spdxVersion)

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

DocumentInfoSheet

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

Method Detail

create

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

openVersion

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

Open an existing worksheet

Parameters:

workbook -

originSheetName -

version - Spreadsheet version

Returns:

getDataRow

protected org.apache.poi.ss.usermodel.Row getDataRow()

getDataRow

protected org.apache.poi.ss.usermodel.Row getDataRow(int rowIndex)

getOrCreateDataCell

protected org.apache.poi.ss.usermodel.Cell getOrCreateDataCell(int colNum)

setDataCellStringValue

protected void setDataCellStringValue(int colNum,
                                      String value)

setDataCellDateValue

protected void setDataCellDateValue(int colNum,
                                    Date value)

getDataCellDateValue

protected Date getDataCellDateValue(int colNum)

getDataCellStringValue

protected String getDataCellStringValue(int colNum)

setSPDXVersion

public abstract void setSPDXVersion(String spdxVersion)

Parameters:

spdxVersion -

setCreatedBy

public abstract void setCreatedBy(String[] createdBys)

Parameters:

createdBys -

setDataLicense

public abstract void setDataLicense(String id)

Parameters:

id -

setAuthorComments

public abstract void setAuthorComments(String comments)

Parameters:

comments -

setCreated

public abstract void setCreated(Date parse)

Parameters:

parse -

getCreated

public abstract Date getCreated()

Returns:

getCreatedBy

public abstract String[] getCreatedBy()

Returns:

getAuthorComments

public abstract String getAuthorComments()

Returns:

getSPDXVersion

public abstract String getSPDXVersion()

Returns:

getDataLicense

public abstract String getDataLicense()

Returns:

getDocumentComment

public abstract String getDocumentComment()

Returns:

setDocumentComment

public abstract void setDocumentComment(String docComment)

Parameters:

docComment -

getLicenseListVersion

public abstract String getLicenseListVersion()

Returns:

setLicenseListVersion

public abstract void setLicenseListVersion(String licenseVersion)

Parameters:

licenseVersion -

getNamespace

public abstract String getNamespace()

Returns:

addDocument

public abstract void addDocument(SpdxDocument doc)
                          throws SpreadsheetException

Add all origin information from the document

Parameters:

doc -

Throws:

SpreadsheetException

getSpdxId

public abstract String getSpdxId()

Returns:

SPDX Identifier for the document

setSpdxId

public abstract void setSpdxId(String id)

Set the SPDX identified for the document

Parameters:

id -

getDocumentName

public abstract String getDocumentName()

Returns:

Document name

setDocumentName

public abstract void setDocumentName(String documentName)

Set the document name

Parameters:

documentName -

getDocumentContents

public abstract String[] getDocumentContents()

Returns:

SPDX ID's for content described by this SPDX document

setDocumentDescribes

public abstract void setDocumentDescribes(String[] contents)

Set the SPDX ID's for content described by this SPDX document

Parameters:

contents -

getExternalDocumentRefs

public abstract ExternalDocumentRef[] getExternalDocumentRefs()
                                                       throws SpreadsheetException

Returns:

External document refs

Throws:

SpreadsheetException

setExternalDocumentRefs

public abstract void setExternalDocumentRefs(ExternalDocumentRef[] externalDocumentRefs)
                                      throws SpreadsheetException

Set the external document refs

Parameters:

externalDocumentRefs -

Throws:

SpreadsheetException