Package org.spdx.spreadsheetstore

Class SpdxSpreadsheet

java.lang.Object

org.spdx.spreadsheetstore.SpdxSpreadsheet

public class SpdxSpreadsheet
extends Object

Spreadsheet workbook for an SPDX Document

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURRENT_VERSION
static final List<String>	SUPPORTED_VERSIONS
static final String	UNKNOWN_NAMESPACE
static final String	UNKNOWN_VERSION
static final String	VERSION_2_0_0
static final String	VERSION_2_1_0
static final String	VERSION_2_2_0

Constructor Summary

Constructors

Constructor	Description
SpdxSpreadsheet(InputStream stream, org.spdx.storage.IModelStore modelStore, org.spdx.library.ModelCopyManager copyManager)	Open an existing SPDX spreadsheet from an input stream
SpdxSpreadsheet(org.spdx.storage.IModelStore modelStore, org.spdx.library.ModelCopyManager copyManager, String documentUri, SpreadsheetStore.SpreadsheetFormatType spreadsheetFormat)	Create a blank SPDX spreadsheet

Method Summary

Modifier and Type	Method	Description
void	clear()
AnnotationsSheet	getAnnotationsSheet()
org.spdx.library.ModelCopyManager	getCopyManager()
DocumentInfoSheet	getDocumentInfoSheet()
String	getDocumentUri()
ExternalRefsSheet	getExternalRefsSheet()
ExtractedLicenseInfoSheet	getExtractedLicenseInfoSheet()
org.spdx.storage.IModelStore	getModelStore()
DocumentInfoSheet	getOriginsSheet()
PackageInfoSheet	getPackageInfoSheet()
PerFileSheet	getPerFileSheet()
RelationshipsSheet	getRelationshipsSheet()
SnippetSheet	getSnippetSheet()
String	getVersion()
org.apache.poi.ss.usermodel.Workbook	getWorkbook()
void	resizeRow()	Resize the height of all rows - will not exceed a maximum height
void	setAnnotationsSheet(AnnotationsSheet annotationsSheet)
void	setDocumentInfoSheet(DocumentInfoSheet documentInfoSheet)
void	setExternalRefsSheet(ExternalRefsSheet externalRefsSheet)
void	setExternaRefsSheet(ExternalRefsSheet externalRefsSheet)
void	setExtractedLicenseInfoSheet(ExtractedLicenseInfoSheet extractedLicenseInfoSheet)
void	setOriginsSheet(DocumentInfoSheet originsSheet)
void	setPackageInfoSheet(PackageInfoSheet packageInfoSheet)
void	setPerFileSheet(PerFileSheet perFileSheet)
void	setRelationshipsSheet(RelationshipsSheet relationshipsSheet)
void	setSnippetSheet(SnippetSheet snippetSheet)
static boolean	verifyVersion(String ver)
String	verifyWorkbook()
void	write(OutputStream stream)	Write the spreadsheet to the output stream

Methods inherited from class java.lang.Object

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

Field Details

CURRENT_VERSION

public static final String CURRENT_VERSION

See Also:

• Constant Field Values

VERSION_2_2_0

public static final String VERSION_2_2_0

See Also:

• Constant Field Values

VERSION_2_1_0

public static final String VERSION_2_1_0

See Also:

• Constant Field Values

VERSION_2_0_0

public static final String VERSION_2_0_0

See Also:

• Constant Field Values

UNKNOWN_VERSION

public static final String UNKNOWN_VERSION

See Also:

• Constant Field Values

UNKNOWN_NAMESPACE

public static final String UNKNOWN_NAMESPACE

See Also:

• Constant Field Values

SUPPORTED_VERSIONS

public static final List<String> SUPPORTED_VERSIONS

Constructor Details

SpdxSpreadsheet

public SpdxSpreadsheet(InputStream stream,
 org.spdx.storage.IModelStore modelStore,
 org.spdx.library.ModelCopyManager copyManager)
                throws SpreadsheetException

Open an existing SPDX spreadsheet from an input stream

Parameters:

stream -

modelStore -

copyManager -

Throws:

SpreadsheetException

SpdxSpreadsheet

public SpdxSpreadsheet(org.spdx.storage.IModelStore modelStore,
 org.spdx.library.ModelCopyManager copyManager,
 String documentUri,
 SpreadsheetStore.SpreadsheetFormatType spreadsheetFormat)
                throws SpreadsheetException

Create a blank SPDX spreadsheet

Parameters:

modelStore -

copyManager -

spreadsheetFormat -

Throws:

SpreadsheetException

Method Details

clear

public void clear()

verifyVersion

public static boolean verifyVersion(String ver)

verifyWorkbook

public String verifyWorkbook()

getDocumentUri

public String getDocumentUri()

Returns:

the documentUri

getOriginsSheet

public DocumentInfoSheet getOriginsSheet()

Returns:

the originsSheet

setOriginsSheet

public void setOriginsSheet(DocumentInfoSheet originsSheet)

Parameters:

originsSheet - the originsSheet to set

getPackageInfoSheet

public PackageInfoSheet getPackageInfoSheet()

Returns:

the packageInfoSheet

getPerFileSheet

public PerFileSheet getPerFileSheet()

Returns:

the perFileSheet

getRelationshipsSheet

public RelationshipsSheet getRelationshipsSheet()

setRelationshipsSheet

public void setRelationshipsSheet(RelationshipsSheet relationshipsSheet)

getAnnotationsSheet

public AnnotationsSheet getAnnotationsSheet()

setAnnotationsSheet

public void setAnnotationsSheet(AnnotationsSheet annotationsSheet)

setPackageInfoSheet

public void setPackageInfoSheet(PackageInfoSheet packageInfoSheet)

setPerFileSheet

public void setPerFileSheet(PerFileSheet perFileSheet)

getSnippetSheet

public SnippetSheet getSnippetSheet()

Returns:

the snippetSheet

setSnippetSheet

public void setSnippetSheet(SnippetSheet snippetSheet)

Parameters:

snippetSheet - the snippetSheet to set

getExternalRefsSheet

public ExternalRefsSheet getExternalRefsSheet()

Returns:

the externalRefsSheet

setExternaRefsSheet

public void setExternaRefsSheet(ExternalRefsSheet externalRefsSheet)

Parameters:

externalRefsSheet - the externalRefsSheet to set

getDocumentInfoSheet

public DocumentInfoSheet getDocumentInfoSheet()

Returns:

the documentInfoSheet

setDocumentInfoSheet

public void setDocumentInfoSheet(DocumentInfoSheet documentInfoSheet)

Parameters:

documentInfoSheet - the documentInfoSheet to set

getExtractedLicenseInfoSheet

public ExtractedLicenseInfoSheet getExtractedLicenseInfoSheet()

Returns:

the extractedLicenseInfoSheet

setExtractedLicenseInfoSheet

public void setExtractedLicenseInfoSheet(ExtractedLicenseInfoSheet extractedLicenseInfoSheet)

Parameters:

extractedLicenseInfoSheet - the extractedLicenseInfoSheet to set

getWorkbook

public org.apache.poi.ss.usermodel.Workbook getWorkbook()

Returns:

the workbook

getModelStore

public org.spdx.storage.IModelStore getModelStore()

Returns:

the modelStore

getVersion

public String getVersion()

Returns:

the version

getCopyManager

public org.spdx.library.ModelCopyManager getCopyManager()

Returns:

the copyManager

setExternalRefsSheet

public void setExternalRefsSheet(ExternalRefsSheet externalRefsSheet)

Parameters:

externalRefsSheet - the externalRefsSheet to set

resizeRow

public void resizeRow()

Resize the height of all rows - will not exceed a maximum height

write

public void write(OutputStream stream)
           throws IOException

Write the spreadsheet to the output stream

Parameters:

stream -

Throws:

IOException