org.spdx.spdxspreadsheet

Class OriginsSheetV1d1

java.lang.Object

org.spdx.spdxspreadsheet.AbstractSheet

org.spdx.spdxspreadsheet.DocumentInfoSheet

org.spdx.spdxspreadsheet.OriginsSheetV1d1

public class OriginsSheetV1d1
extends DocumentInfoSheet

Sheet containing information about the origins of an SPDX document Version 1.1

Author:

Gary O'Neall

Field Summary

Fields inherited from class org.spdx.spdxspreadsheet.DocumentInfoSheet

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

Method Summary

Modifier and Type	Method and Description
void	addDocument(SpdxDocument doc) Add all origin information from the document
static void	create(org.apache.poi.ss.usermodel.Workbook wb, String sheetName)
String	getAuthorComments()
Date	getCreated()
String[]	getCreatedBy()
String	getDataLicense()
String	getDocumentComment()
String[]	getDocumentContents()
String	getDocumentName()
ExternalDocumentRef[]	getExternalDocumentRefs()
String	getLicenseListVersion()
String	getNamespace()
String	getSpdxId()
String	getSPDXVersion()
String	getSpreadsheetVersion()
void	setAuthorComments(String comments)
void	setCreated(Date created)
void	setCreatedBy(String createdBy)
void	setCreatedBy(String[] createdBy)
void	setDataLicense(String dataLicense)
void	setDocumentComment(String docComment)
void	setDocumentDescribes(String[] contents) Set the SPDX ID's for content described by this SPDX document
void	setDocumentName(String documentName) Set the document name
void	setExternalDocumentRefs(ExternalDocumentRef[] externalDocumentRefs) Set the external document refs
void	setLicenseListVersion(String licenseVersion)
void	setSpdxId(String id) Set the SPDX identified for the document
void	setSPDXVersion(String version)
void	setSpreadsheetVersion(String version)
String	verify()

Methods inherited from class org.spdx.spdxspreadsheet.DocumentInfoSheet

getDataCellDateValue, getDataCellStringValue, getDataRow, getDataRow, getOrCreateDataCell, openVersion, setDataCellDateValue, setDataCellStringValue

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

OriginsSheetV1d1

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

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)

setAuthorComments

public void setAuthorComments(String comments)

Specified by:

setAuthorComments in class DocumentInfoSheet

setCreatedBy

public void setCreatedBy(String createdBy)

setDataLicense

public void setDataLicense(String dataLicense)

Specified by:

setDataLicense in class DocumentInfoSheet

setSPDXVersion

public void setSPDXVersion(String version)

Specified by:

setSPDXVersion in class DocumentInfoSheet

setSpreadsheetVersion

public void setSpreadsheetVersion(String version)

getAuthorComments

public String getAuthorComments()

Specified by:

getAuthorComments in class DocumentInfoSheet

Returns:

getCreated

public Date getCreated()

Specified by:

getCreated in class DocumentInfoSheet

Returns:

getDataLicense

public String getDataLicense()

Specified by:

getDataLicense in class DocumentInfoSheet

Returns:

getSPDXVersion

public String getSPDXVersion()

Specified by:

getSPDXVersion in class DocumentInfoSheet

Returns:

getSpreadsheetVersion

public String getSpreadsheetVersion()

setCreatedBy

public void setCreatedBy(String[] createdBy)

Specified by:

setCreatedBy in class DocumentInfoSheet

getCreatedBy

public String[] getCreatedBy()

Specified by:

getCreatedBy in class DocumentInfoSheet

Returns:

setCreated

public void setCreated(Date created)

Specified by:

setCreated in class DocumentInfoSheet

getDocumentComment

public String getDocumentComment()

Specified by:

getDocumentComment in class DocumentInfoSheet

Returns:

setDocumentComment

public void setDocumentComment(String docComment)

Specified by:

setDocumentComment in class DocumentInfoSheet

getLicenseListVersion

public String getLicenseListVersion()

Specified by:

getLicenseListVersion in class DocumentInfoSheet

Returns:

setLicenseListVersion

public void setLicenseListVersion(String licenseVersion)

Specified by:

setLicenseListVersion in class DocumentInfoSheet

getNamespace

public String getNamespace()

Specified by:

getNamespace in class DocumentInfoSheet

Returns:

addDocument

public void addDocument(SpdxDocument doc)
                 throws SpreadsheetException

Description copied from class: DocumentInfoSheet

Add all origin information from the document

Specified by:

addDocument in class DocumentInfoSheet

Throws:

SpreadsheetException

getSpdxId

public String getSpdxId()

Specified by:

getSpdxId in class DocumentInfoSheet

Returns:

SPDX Identifier for the document

setSpdxId

public void setSpdxId(String id)

Description copied from class: DocumentInfoSheet

Set the SPDX identified for the document

Specified by:

setSpdxId in class DocumentInfoSheet

getDocumentName

public String getDocumentName()

Specified by:

getDocumentName in class DocumentInfoSheet

Returns:

Document name

setDocumentName

public void setDocumentName(String documentName)

Description copied from class: DocumentInfoSheet

Set the document name

Specified by:

setDocumentName in class DocumentInfoSheet

getDocumentContents

public String[] getDocumentContents()

Specified by:

getDocumentContents in class DocumentInfoSheet

Returns:

SPDX ID's for content described by this SPDX document

setDocumentDescribes

public void setDocumentDescribes(String[] contents)

Description copied from class: DocumentInfoSheet

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

Specified by:

setDocumentDescribes in class DocumentInfoSheet

getExternalDocumentRefs

public ExternalDocumentRef[] getExternalDocumentRefs()

Specified by:

getExternalDocumentRefs in class DocumentInfoSheet

Returns:

External document refs

setExternalDocumentRefs

public void setExternalDocumentRefs(ExternalDocumentRef[] externalDocumentRefs)

Description copied from class: DocumentInfoSheet

Set the external document refs

Specified by:

setExternalDocumentRefs in class DocumentInfoSheet