Package org.spdx.spreadsheetstore

Class DocumentInfoSheetV2d0

java.lang.Object

org.spdx.spreadsheetstore.AbstractSheet

org.spdx.spreadsheetstore.DocumentInfoSheet

org.spdx.spreadsheetstore.DocumentInfoSheetV2d0

public class DocumentInfoSheetV2d0
extends DocumentInfoSheet

DocumentInfoSheet for version 2.0+ of the SPDX Spec

Author:

Gary O'Neall

Field Summary

Fields inherited from class org.spdx.spreadsheetstore.DocumentInfoSheet

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
DocumentInfoSheetV2d0(org.apache.poi.ss.usermodel.Workbook workbook, String sheetName, String version, org.spdx.storage.IModelStore modelStore, org.spdx.library.ModelCopyManager copyManager)

Method Summary

Modifier and Type	Method	Description
void	addDocument(org.spdx.library.model.v2.SpdxDocument doc)	Add all origin information from the document
static void	create(org.apache.poi.ss.usermodel.Workbook wb, String sheetName, String documentUri)
String	getAuthorComments()	Retrieve the author comments for the SPDX document
Date	getCreated()	Retrieve the creation date of the SPDX document
List<String>	getCreatedBy()	Retrieve the list of creators of the SPDX document
String	getDataLicense()	Retrieve the license for the SPDX document
String	getDocumentComment()	Retrieve the document comment for the SPDX document
Collection<String>	getDocumentContents()	Set SPDX identifier for the document
String	getDocumentName()	Retrieve the document name
Collection<org.spdx.library.model.v2.ExternalDocumentRef>	getExternalDocumentRefs()	Retrieve the external document refs
String	getLicenseListVersion()	Retrieve the license list version for the SPDX document
String	getNamespace()	Retrieve the namespace for the SPDX document
String	getSpdxId()	Retrieve the SPDX identifier for the SPDX document
String	getSPDXVersion()	Retrieve the SPDX specification version of the SPDX document
String	getSpreadsheetVersion()
void	setAuthorComments(String comments)	Set the author comments for the SPDX document
void	setCreated(Date created)	Set the created date for the SPDX document
void	setCreatedBy(String createdBy)
void	setCreatedBy(Collection<String> createdByCollection)	Set the list of creators of the SPDX document
void	setDataLicense(String dataLicense)	Set the license for the SPDX document
void	setDocumentComment(String docComment)	Set the document comment for the SPDX document
void	setDocumentDescribes(Collection<String> contentsCollection)	Set the SPDX ID's for content described by this SPDX document
void	setDocumentName(String documentName)	Set the document name
void	setExternalDocumentRefs(Collection<org.spdx.library.model.v2.ExternalDocumentRef> externalDocumentRefColleciton)	Set the external document refs
void	setLicenseListVersion(String licenseVersion)	Set the license list version for the SPDX document
void	setSpdxId(String id)	Set the SPDX identifier for the document
void	setSPDXVersion(String version)	Set the SPDX specification version for the SPDX document
void	setSpreadsheetVersion(String version)
String	verify()	Verifies the integrity of the sheet's data

Methods inherited from class org.spdx.spreadsheetstore.DocumentInfoSheet

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

Methods inherited from class org.spdx.spreadsheetstore.AbstractSheet

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

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentInfoSheetV2d0

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

Throws:

SpreadsheetException

Method Details

verify

public String verify()

Description copied from class: AbstractSheet

Verifies the integrity of the sheet's data

Specified by:

verify in class AbstractSheet

Returns:

A string describing any issues, or an empty string if valid.

create

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

setAuthorComments

public void setAuthorComments(String comments)

Description copied from class: DocumentInfoSheet

Set the author comments for the SPDX document

Specified by:

setAuthorComments in class DocumentInfoSheet

Parameters:

comments - Author comments

setCreatedBy

public void setCreatedBy(String createdBy)

setDataLicense

public void setDataLicense(String dataLicense)

Description copied from class: DocumentInfoSheet

Set the license for the SPDX document

Specified by:

setDataLicense in class DocumentInfoSheet

Parameters:

dataLicense - License ID

setSPDXVersion

public void setSPDXVersion(String version)

Description copied from class: DocumentInfoSheet

Set the SPDX specification version for the SPDX document

Specified by:

setSPDXVersion in class DocumentInfoSheet

Parameters:

version - SPDX specification version

setSpreadsheetVersion

public void setSpreadsheetVersion(String version)

getAuthorComments

public String getAuthorComments()

Description copied from class: DocumentInfoSheet

Retrieve the author comments for the SPDX document

Specified by:

getAuthorComments in class DocumentInfoSheet

Returns:

Author comments

getCreated

public Date getCreated()

Description copied from class: DocumentInfoSheet

Retrieve the creation date of the SPDX document

Specified by:

getCreated in class DocumentInfoSheet

Returns:

Date the SPDX document was created

getDataLicense

public String getDataLicense()

Description copied from class: DocumentInfoSheet

Retrieve the license for the SPDX document

Specified by:

getDataLicense in class DocumentInfoSheet

Returns:

License ID

getSPDXVersion

public String getSPDXVersion()

Description copied from class: DocumentInfoSheet

Retrieve the SPDX specification version of the SPDX document

Specified by:

getSPDXVersion in class DocumentInfoSheet

Returns:

SPDX specification version

getSpreadsheetVersion

public String getSpreadsheetVersion()

setCreatedBy

public void setCreatedBy(Collection<String> createdByCollection)

Description copied from class: DocumentInfoSheet

Set the list of creators of the SPDX document

Specified by:

setCreatedBy in class DocumentInfoSheet

Parameters:

createdByCollection - List of creators

getCreatedBy

public List<String> getCreatedBy()

Description copied from class: DocumentInfoSheet

Retrieve the list of creators of the SPDX document

Specified by:

getCreatedBy in class DocumentInfoSheet

Returns:

List of creators

setCreated

public void setCreated(Date created)

Description copied from class: DocumentInfoSheet

Set the created date for the SPDX document

Specified by:

setCreated in class DocumentInfoSheet

Parameters:

created - Created date

getDocumentComment

public String getDocumentComment()

Description copied from class: DocumentInfoSheet

Retrieve the document comment for the SPDX document

Specified by:

getDocumentComment in class DocumentInfoSheet

Returns:

Document comment

setDocumentComment

public void setDocumentComment(String docComment)

Description copied from class: DocumentInfoSheet

Set the document comment for the SPDX document

Specified by:

setDocumentComment in class DocumentInfoSheet

Parameters:

docComment - Document comment

getLicenseListVersion

public String getLicenseListVersion()

Description copied from class: DocumentInfoSheet

Retrieve the license list version for the SPDX document

Specified by:

getLicenseListVersion in class DocumentInfoSheet

Returns:

License list version

setLicenseListVersion

public void setLicenseListVersion(String licenseVersion)

Description copied from class: DocumentInfoSheet

Set the license list version for the SPDX document

Specified by:

setLicenseListVersion in class DocumentInfoSheet

Parameters:

licenseVersion - License list version

getNamespace

public String getNamespace()

Description copied from class: DocumentInfoSheet

Retrieve the namespace for the SPDX document

Specified by:

getNamespace in class DocumentInfoSheet

Returns:

Namespace

addDocument

public void addDocument(org.spdx.library.model.v2.SpdxDocument doc)
                 throws SpreadsheetException

Description copied from class: DocumentInfoSheet

Add all origin information from the document

Specified by:

addDocument in class DocumentInfoSheet

Parameters:

doc - SPDX document to add

Throws:

SpreadsheetException

getSpdxId

public String getSpdxId()

Description copied from class: DocumentInfoSheet

Retrieve the SPDX identifier for the SPDX document

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 identifier for the document

Specified by:

setSpdxId in class DocumentInfoSheet

Parameters:

id - SPDX identifier

getDocumentName

public String getDocumentName()

Description copied from class: DocumentInfoSheet

Retrieve the document name

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

Parameters:

documentName - Document name

getDocumentContents

public Collection<String> getDocumentContents()

Description copied from class: DocumentInfoSheet

Set SPDX identifier for the document

Specified by:

getDocumentContents in class DocumentInfoSheet

Returns:

SPDX ID's for content described by this SPDX document

setDocumentDescribes

public void setDocumentDescribes(Collection<String> contentsCollection)

Description copied from class: DocumentInfoSheet

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

Specified by:

setDocumentDescribes in class DocumentInfoSheet

Parameters:

contentsCollection - SPDX ID's for content described by this SPDX document

getExternalDocumentRefs

public Collection<org.spdx.library.model.v2.ExternalDocumentRef> getExternalDocumentRefs()
                                                                                  throws SpreadsheetException

Description copied from class: DocumentInfoSheet

Retrieve the external document refs

Specified by:

getExternalDocumentRefs in class DocumentInfoSheet

Returns:

External document refs

Throws:

SpreadsheetException

setExternalDocumentRefs

public void setExternalDocumentRefs(Collection<org.spdx.library.model.v2.ExternalDocumentRef> externalDocumentRefColleciton)
                             throws SpreadsheetException

Description copied from class: DocumentInfoSheet

Set the external document refs

Specified by:

setExternalDocumentRefs in class DocumentInfoSheet

Parameters:

externalDocumentRefColleciton -

Throws:

SpreadsheetException