org.spdx.rdfparser

Class SPDXDocument.SPDXPackage

java.lang.Object

org.spdx.rdfparser.SPDXDocument.SPDXPackage

Enclosing class:

SPDXDocument

public class SPDXDocument.SPDXPackage
extends Object

Simple class representing an SPDX Package. This is stored in an RDF model. This package is initialized using an existing SPDXPackage in an RDF document by constructing the package with the node representing the SPDX package.

Author:

Gary O'Neall

Constructor Summary

Constructors

Constructor and Description
SPDXDocument.SPDXPackage(com.hp.hpl.jena.graph.Node pkgNode) Construct a new SPDX package and populate the properties from the node

Method Summary

Methods

Modifier and Type	Method and Description
void	addFile(SPDXFile file) Add a file to the package
SPDXLicenseInfo	getConcludedLicenses()
String	getDeclaredCopyright()
SPDXLicenseInfo	getDeclaredLicense()
String	getDeclaredName()
String	getDescription()
String	getDownloadUrl()
String	getFileName()
SPDXFile[]	getFiles()
String	getHomePage()
String	getLicenseComment()
SPDXLicenseInfo[]	getLicenseInfoFromFiles()
String	getOriginator()
SPDXPackageInfo	getPackageInfo()
String	getSha1()
String	getShortDescription()
String	getSourceInfo()
String	getSupplier()
SpdxPackageVerificationCode	getVerificationCode()
String	getVersionInfo()
void	removeFile(String fileName) Removes all SPDX files by the given name
void	setConcludedLicenses(SPDXLicenseInfo detectedLicenses)
void	setDeclaredCopyright(String declaredCopyright)
void	setDeclaredLicense(SPDXLicenseInfo declaredLicense)
void	setDeclaredName(String declaredName)
void	setDescription(String description)
void	setDownloadUrl(String url)
void	setFileName(String fileName)
void	setFiles(SPDXFile[] files)
void	setHomePage(String url)
void	setLicenseComment(String comments)
void	setLicenseInfoFromFiles(SPDXLicenseInfo[] licenseInfo)
void	setOriginator(String originator) Set the originator
void	setSha1(String sha1)
void	setShortDescription(String shortDescription)
void	setSourceInfo(String sourceInfo)
void	setSupplier(String supplier) Set the Supplier
void	setVerificationCode(SpdxPackageVerificationCode verificationCode)
void	setVersionInfo(String versionInfo) Set the version information of the package
ArrayList<String>	verify()

Methods inherited from class java.lang.Object

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

Constructor Detail

SPDXDocument.SPDXPackage

public SPDXDocument.SPDXPackage(com.hp.hpl.jena.graph.Node pkgNode)

Construct a new SPDX package and populate the properties from the node

Parameters:

pkgNode - Node in the RDF graph representing the SPDX package

Method Detail

getDeclaredName

public String getDeclaredName()
                       throws InvalidSPDXAnalysisException

Returns:

the declaredName

Throws:

InvalidSPDXAnalysisException

setDeclaredName

public void setDeclaredName(String declaredName)
                     throws InvalidSPDXAnalysisException

Parameters:

declaredName - the declaredName to set

Throws:

InvalidSPDXAnalysisException

getFileName

public String getFileName()
                   throws InvalidSPDXAnalysisException

Returns:

the fileName

Throws:

InvalidSPDXAnalysisException

setFileName

public void setFileName(String fileName)
                 throws InvalidSPDXAnalysisException

Parameters:

fileName - the fileName to set

Throws:

InvalidSPDXAnalysisException

getSha1

public String getSha1()
               throws InvalidSPDXAnalysisException

Returns:

the sha1

Throws:

InvalidSPDXAnalysisException

setSha1

public void setSha1(String sha1)
             throws InvalidSPDXAnalysisException

Parameters:

sha1 - the sha1 to set

Throws:

InvalidSPDXAnalysisException

getSourceInfo

public String getSourceInfo()
                     throws InvalidSPDXAnalysisException

Returns:

the sourceInfo

Throws:

InvalidSPDXAnalysisException

setSourceInfo

public void setSourceInfo(String sourceInfo)
                   throws InvalidSPDXAnalysisException

Parameters:

sourceInfo - the sourceInfo to set

Throws:

InvalidSPDXAnalysisException

getVersionInfo

public String getVersionInfo()
                      throws InvalidSPDXAnalysisException

Returns:

Version information of the package

Throws:

InvalidSPDXAnalysisException

setVersionInfo

public void setVersionInfo(String versionInfo)
                    throws InvalidSPDXAnalysisException

Set the version information of the package

Parameters:

versionInfo -

Throws:

InvalidSPDXAnalysisException

getDeclaredLicense

public SPDXLicenseInfo getDeclaredLicense()
                                   throws InvalidSPDXAnalysisException

Returns:

the declaredLicenses

Throws:

InvalidSPDXAnalysisException

setDeclaredLicense

public void setDeclaredLicense(SPDXLicenseInfo declaredLicense)
                        throws InvalidSPDXAnalysisException

Parameters:

declaredLicenses - the declaredLicenses to set

Throws:

InvalidSPDXAnalysisException

getConcludedLicenses

public SPDXLicenseInfo getConcludedLicenses()
                                     throws InvalidSPDXAnalysisException

Returns:

the detectedLicenses

Throws:

InvalidSPDXAnalysisException

setConcludedLicenses

public void setConcludedLicenses(SPDXLicenseInfo detectedLicenses)
                          throws InvalidSPDXAnalysisException

Parameters:

detectedLicenses - the detectedLicenses to set

Throws:

InvalidSPDXAnalysisException

getLicenseComment

public String getLicenseComment()
                         throws InvalidSPDXAnalysisException

Returns:

the licenseComment

Throws:

InvalidSPDXAnalysisException

setLicenseComment

public void setLicenseComment(String comments)
                       throws InvalidSPDXAnalysisException

Parameters:

comments - the license comments to set

Throws:

InvalidSPDXAnalysisException

getDeclaredCopyright

public String getDeclaredCopyright()
                            throws InvalidSPDXAnalysisException

Returns:

the declaredCopyright

Throws:

InvalidSPDXAnalysisException

setDeclaredCopyright

public void setDeclaredCopyright(String declaredCopyright)
                          throws InvalidSPDXAnalysisException

Parameters:

declaredCopyright - the declaredCopyright to set

Throws:

InvalidSPDXAnalysisException

getShortDescription

public String getShortDescription()
                           throws InvalidSPDXAnalysisException

Returns:

the shortDescription

Throws:

InvalidSPDXAnalysisException

setShortDescription

public void setShortDescription(String shortDescription)
                         throws InvalidSPDXAnalysisException

Parameters:

shortDescription - the shortDescription to set

Throws:

InvalidSPDXAnalysisException

getDescription

public String getDescription()
                      throws InvalidSPDXAnalysisException

Returns:

the description

Throws:

InvalidSPDXAnalysisException

setDescription

public void setDescription(String description)
                    throws InvalidSPDXAnalysisException

Parameters:

description - the description to set

Throws:

InvalidSPDXAnalysisException

setOriginator

public void setOriginator(String originator)
                   throws InvalidSPDXAnalysisException

Set the originator

Parameters:

originator - Either a valid originator string or NOASSERTION

Throws:

InvalidSPDXAnalysisException

setSupplier

public void setSupplier(String supplier)
                 throws InvalidSPDXAnalysisException

Set the Supplier

Parameters:

supplier - Either a valid originator string or NOASSERTION

Throws:

InvalidSPDXAnalysisException

getOriginator

public String getOriginator()
                     throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getSupplier

public String getSupplier()
                   throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getFiles

public SPDXFile[] getFiles()
                    throws InvalidSPDXAnalysisException

Returns:

the files

Throws:

InvalidSPDXAnalysisException

setFiles

public void setFiles(SPDXFile[] files)
              throws InvalidSPDXAnalysisException

Parameters:

files - the files to set

Throws:

InvalidSPDXAnalysisException

addFile

public void addFile(SPDXFile file)
             throws InvalidSPDXAnalysisException

Add a file to the package

Parameters:

file -

Throws:

InvalidSPDXAnalysisException

removeFile

public void removeFile(String fileName)
                throws InvalidSPDXAnalysisException

Removes all SPDX files by the given name

Parameters:

fileName - Name of SPDX file to be removed

Throws:

InvalidSPDXAnalysisException

getDownloadUrl

public String getDownloadUrl()
                      throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

setDownloadUrl

public void setDownloadUrl(String url)
                    throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getHomePage

public String getHomePage()
                   throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

setHomePage

public void setHomePage(String url)
                 throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getVerificationCode

public SpdxPackageVerificationCode getVerificationCode()
                                                throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

setVerificationCode

public void setVerificationCode(SpdxPackageVerificationCode verificationCode)
                         throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getPackageInfo

public SPDXPackageInfo getPackageInfo()
                               throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

setLicenseInfoFromFiles

public void setLicenseInfoFromFiles(SPDXLicenseInfo[] licenseInfo)
                             throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getLicenseInfoFromFiles

public SPDXLicenseInfo[] getLicenseInfoFromFiles()
                                          throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

verify

public ArrayList<String> verify()

Returns:

Array list of any error messages found in verifying the package model