org.spdx.rdfparser

Class SPDXDocument

java.lang.Object

org.spdx.rdfparser.SPDXDocument

All Implemented Interfaces:

SpdxRdfConstants

public class SPDXDocument
extends Object
implements SpdxRdfConstants

Simple model for the SPDX Analysis document. The document is stored in a Jena RDF model which can be accessed through the model property. The class should be constructed using the SPDXDocumentFactory class The createSpdxDocument(uri) must be called first for a blank model The license, file, and package objects can be constructed then added to the model by using the set functions. The non-standard licenses must contain a unique ID of the form LicenseRef-NN where NN is a unique number. The method addNonStandardLicense(licenseText) can be called to create a new unique Non-Standard License.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SPDXDocument.SPDXPackage Simple class representing an SPDX Package.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_IMPLEMENTATION_VERSION
static String	CURRENT_SPDX_VERSION
protected int	nextLicenseRef Keeps tract of the next license reference number when generating the license ID's for non-standard licenses
static String	ONE_DOT_ONE_SPDX_VERSION
static String	ONE_DOT_ZERO_SPDX_VERSION
static String	POINT_EIGHT_SPDX_VERSION
static String	POINT_NINE_SPDX_VERSION

Fields inherited from interface org.spdx.rdfparser.SpdxRdfConstants

ALGORITHM_SHA1, CLASS_DOAP_PROJECT, CLASS_SPDX_ANALYSIS, CLASS_SPDX_ANY_LICENSE_INFO, CLASS_SPDX_CHECKSUM, CLASS_SPDX_CONJUNCTIVE_LICENSE_SET, CLASS_SPDX_CREATION_INFO, CLASS_SPDX_DISJUNCTIVE_LICENSE_SET, CLASS_SPDX_EXTRACTED_LICENSING_INFO, CLASS_SPDX_FILE, CLASS_SPDX_PACKAGE, CLASS_SPDX_REVIEW, CLASS_SPDX_SIMPLE_LICENSE_INFO, CLASS_SPDX_STANDARD_LICENSE, CLASS_SPDX_VERIFICATIONCODE, CREATOR_PREFIX_ORGANIZATION, CREATOR_PREFIX_PERSON, CREATOR_PREFIX_TOOL, DOAP_NAMESPACE, FILE_TYPE_ARCHIVE, FILE_TYPE_BINARY, FILE_TYPE_OTHER, FILE_TYPE_SOURCE, LICENSE_ID_PATTERN, NOASSERTION_VALUE, NON_STD_LICENSE_ID_PRENUM, NONE_VALUE, OWL_NAMESPACE, PROP_CHECKSUM_ALGORITHM, PROP_CHECKSUM_ALGORITHM_SHA1, PROP_CHECKSUM_VALUE, PROP_CREATION_CREATED, PROP_CREATION_CREATOR, PROP_EXTRACTED_TEXT, PROP_FILE_ARTIFACTOF, PROP_FILE_CHECKSUM, PROP_FILE_CONTRIBUTOR, PROP_FILE_COPYRIGHT, PROP_FILE_FILE_DEPENDENCY, PROP_FILE_LIC_COMMENTS, PROP_FILE_LICENSE, PROP_FILE_NAME, PROP_FILE_NOTICE, PROP_FILE_SEEN_LICENSE, PROP_FILE_TYPE, PROP_FILE_TYPE_ARCHIVE, PROP_FILE_TYPE_BINARY, PROP_FILE_TYPE_OTHER, PROP_FILE_TYPE_SOURCE, PROP_LICENSE_ID, PROP_LICENSE_LIST_VERSION, PROP_LICENSE_NAME, PROP_LICENSE_SET_MEMEBER, PROP_LICENSE_TEXT, PROP_OWL_SAME_AS, PROP_PACKAGE_CHECKSUM, PROP_PACKAGE_CONCLUDED_LICENSE, PROP_PACKAGE_DECLARED_COPYRIGHT, PROP_PACKAGE_DECLARED_LICENSE, PROP_PACKAGE_DECLARED_NAME, PROP_PACKAGE_DESCRIPTION, PROP_PACKAGE_DOWNLOAD_URL, PROP_PACKAGE_FILE, PROP_PACKAGE_FILE_NAME, PROP_PACKAGE_LICENSE_COMMENT, PROP_PACKAGE_LICENSE_INFO_FROM_FILES, PROP_PACKAGE_ORIGINATOR, PROP_PACKAGE_SHORT_DESC, PROP_PACKAGE_SOURCE_INFO, PROP_PACKAGE_SUPPLIER, PROP_PACKAGE_VERIFICATION_CODE, PROP_PACKAGE_VERSION_INFO, PROP_PROJECT_HOMEPAGE, PROP_PROJECT_NAME, PROP_REVIEW_DATE, PROP_REVIEW_REVIEWER, PROP_SPDX_CREATION_INFO, PROP_SPDX_DATA_LICENSE, PROP_SPDX_FILE, PROP_SPDX_NONSTANDARD_LICENSES, PROP_SPDX_PACKAGE, PROP_SPDX_REVIEWED_BY, PROP_SPDX_VERSION, PROP_STD_LICENSE_HEADER_VERSION_1, PROP_STD_LICENSE_NAME, PROP_STD_LICENSE_NAME_VERSION_1, PROP_STD_LICENSE_NOTES_VERSION_1, PROP_STD_LICENSE_NOTICE, PROP_STD_LICENSE_OSI_APPROVED, PROP_STD_LICENSE_OSI_APPROVED_VERSION_1, PROP_STD_LICENSE_TEMPLATE, PROP_STD_LICENSE_TEMPLATE_VERSION_1, PROP_STD_LICENSE_URL_VERSION_1, PROP_VALUE_NOASSERTION, PROP_VALUE_NONE, PROP_VERIFICATIONCODE_IGNORED_FILES, PROP_VERIFICATIONCODE_VALUE, RDF_NAMESPACE, RDF_PROP_RESOURCE, RDF_PROP_TYPE, RDFS_NAMESPACE, RDFS_PROP_COMMENT, RDFS_PROP_LABEL, RDFS_PROP_SEE_ALSO, SPDX_DATA_LICENSE_ID, SPDX_DATA_LICENSE_ID_VERSION_1_0, SPDX_DATE_FORMAT, SPDX_NAMESPACE, SPDX_VERSION_PATTERN, STANDARD_LICENSE_URL, TERM_LICENSE_NOASSERTION, TERM_LICENSE_NONE, URI_VALUE_NOASSERTION, URI_VALUE_NONE

Constructor Summary

Constructors

Constructor and Description
SPDXDocument(com.hp.hpl.jena.rdf.model.Model model)

Method Summary

Methods

Modifier and Type	Method and Description
void	addNewExtractedLicenseInfo(SPDXNonStandardLicense license) Adds the license as a new ExtractedLicenseInfo
SPDXNonStandardLicense	addNewExtractedLicenseInfo(String licenseText) Adds a new non-standard license containing the text provided.
void	createSpdxAnalysis(String uri) Creates a new empty SPDX Document with the current SPDX document version.
void	createSpdxAnalysis(String uri, String spdxVersion) Creates a new empty SPDX Document.
void	createSpdxPackage()
void	createSpdxPackage(String uri) Creates an empty SPDX package
protected boolean	extractedLicenseExists(String id)
static String	formNonStandardLicenseID(int idNum)
String	getCreated() Deprecated.
String	getCreatorComment() Deprecated.
SPDXCreatorInformation	getCreatorInfo()
String[]	getCreators() Deprecated.
SPDXStandardLicense	getDataLicense()
String	getDocumentComment()
SPDXNonStandardLicense[]	getExtractedLicenseInfos()
SPDXFile[]	getFileReferences()
int	getLicenseRefNum(String licenseID) Parses a license ID and return the integer representing the ID number (e.g.
com.hp.hpl.jena.rdf.model.Model	getModel()
String	getNextLicenseRef()
SPDXReview[]	getReviewers()
String	getSpdxDocUri()
SPDXDocument.SPDXPackage	getSpdxPackage()
String	getSpdxVersion()
void	setCreationInfo(SPDXCreatorInformation creator)
void	setDataLicense(SPDXStandardLicense dataLicense)
void	setDocumentComment(String comment)
void	setExtractedLicenseInfos(SPDXNonStandardLicense[] nonStandardLicenses) Resets all ExtractedLicenseInfos to nonStandardLicenses.
void	setModel(com.hp.hpl.jena.rdf.model.Model model)
void	setReviewers(SPDXReview[] reviewers)
void	setSpdxVersion(String spdxVersion)
ArrayList<String>	verify() Verifies the spdx document
String	verifySpdxVersion(String spdxVersion)

Methods inherited from class java.lang.Object

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

Field Detail

POINT_EIGHT_SPDX_VERSION

public static final String POINT_EIGHT_SPDX_VERSION

See Also:

Constant Field Values

POINT_NINE_SPDX_VERSION

public static final String POINT_NINE_SPDX_VERSION

See Also:

Constant Field Values

ONE_DOT_ZERO_SPDX_VERSION

public static final String ONE_DOT_ZERO_SPDX_VERSION

See Also:

Constant Field Values

ONE_DOT_ONE_SPDX_VERSION

public static final String ONE_DOT_ONE_SPDX_VERSION

See Also:

Constant Field Values

CURRENT_SPDX_VERSION

public static final String CURRENT_SPDX_VERSION

See Also:

Constant Field Values

CURRENT_IMPLEMENTATION_VERSION

public static final String CURRENT_IMPLEMENTATION_VERSION

See Also:

Constant Field Values

nextLicenseRef

protected int nextLicenseRef

Keeps tract of the next license reference number when generating the license ID's for non-standard licenses

Constructor Detail

SPDXDocument

public SPDXDocument(com.hp.hpl.jena.rdf.model.Model model)
             throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

Method Detail

getLicenseRefNum

public int getLicenseRefNum(String licenseID)
                     throws InvalidSPDXAnalysisException

Parses a license ID and return the integer representing the ID number (e.g. N in LicenseRef-N)

Parameters:

licenseID -

Returns:

Throws:

InvalidSPDXAnalysisException

formNonStandardLicenseID

public static String formNonStandardLicenseID(int idNum)

verifySpdxVersion

public String verifySpdxVersion(String spdxVersion)

verify

public ArrayList<String> verify()

Verifies the spdx document

Returns:

error messages for any fields which do not match the spec. Return an empty array list if no issues.

getSpdxVersion

public String getSpdxVersion()
                      throws InvalidSPDXAnalysisException

Returns:

the spdxVersion or null if there is no SPDX document

Throws:

InvalidSPDXAnalysisException

setDocumentComment

public void setDocumentComment(String comment)
                        throws InvalidSPDXAnalysisException

Parameters:

comment - the documentComment to set

Throws:

InvalidSPDXAnalysisException

getDocumentComment

public String getDocumentComment()
                          throws InvalidSPDXAnalysisException

Returns:

the documentComment or null if there is no SPDX document or SPDX document comment

Throws:

InvalidSPDXAnalysisException

setSpdxVersion

public void setSpdxVersion(String spdxVersion)
                    throws InvalidSPDXAnalysisException

Parameters:

spdxVersion - the spdxVersion to set

Throws:

InvalidSPDXAnalysisException

getDataLicense

public SPDXStandardLicense getDataLicense()
                                   throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

setDataLicense

public void setDataLicense(SPDXStandardLicense dataLicense)
                    throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getFileReferences

public SPDXFile[] getFileReferences()
                             throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getCreators

@Deprecated
public String[] getCreators()
                     throws InvalidSPDXAnalysisException

Deprecated.

Throws:

InvalidSPDXAnalysisException

getCreatorInfo

public SPDXCreatorInformation getCreatorInfo()
                                      throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

setCreationInfo

public void setCreationInfo(SPDXCreatorInformation creator)
                     throws InvalidSPDXAnalysisException

Parameters:

creators - the creators of the analysis

Throws:

InvalidSPDXDocException

InvalidSPDXAnalysisException

getCreatorComment

@Deprecated
public String getCreatorComment()
                         throws InvalidSPDXAnalysisException

Deprecated.

Throws:

InvalidSPDXAnalysisException

getReviewers

public SPDXReview[] getReviewers()
                          throws InvalidSPDXAnalysisException

Returns:

the reviewers

Throws:

InvalidSPDXAnalysisException

setReviewers

public void setReviewers(SPDXReview[] reviewers)
                  throws InvalidSPDXAnalysisException

Parameters:

reviewers - the reviewers to set

Throws:

InvalidSPDXAnalysisException

getCreated

@Deprecated
public String getCreated()
                  throws InvalidSPDXAnalysisException

Deprecated.

Throws:

InvalidSPDXAnalysisException

getSpdxPackage

public SPDXDocument.SPDXPackage getSpdxPackage()
                                        throws InvalidSPDXAnalysisException

Returns:

the spdxPackage

Throws:

InvalidSPDXAnalysisException

createSpdxPackage

public void createSpdxPackage(String uri)
                       throws InvalidSPDXAnalysisException

Creates an empty SPDX package

Parameters:

uri - Unique URI representing the SPDX package

Throws:

InvalidSPDXAnalysisException

createSpdxPackage

public void createSpdxPackage()
                       throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getExtractedLicenseInfos

public SPDXNonStandardLicense[] getExtractedLicenseInfos()
                                                  throws InvalidSPDXAnalysisException

Returns:

the nonStandardLicenses

Throws:

InvalidSPDXAnalysisException

setExtractedLicenseInfos

public void setExtractedLicenseInfos(SPDXNonStandardLicense[] nonStandardLicenses)
                              throws InvalidSPDXAnalysisException

Resets all ExtractedLicenseInfos to nonStandardLicenses. Removes references to any ExtractedLicenseInfos not present in nonStandardLicenses. If any LicenseID's are already present in the model, the text will be replaced with the text in the new nonStandardLicenses

Parameters:

nonStandardLicenses - the nonStandardLicenses to set

Throws:

InvalidSPDXAnalysisException

addNewExtractedLicenseInfo

public SPDXNonStandardLicense addNewExtractedLicenseInfo(String licenseText)
                                                  throws InvalidSPDXAnalysisException

Adds a new non-standard license containing the text provided. Forms the license ID from the next License ID available

Parameters:

licenseText -

Returns:

the newly created NonStandardLicense

Throws:

InvalidSPDXAnalysisException

addNewExtractedLicenseInfo

public void addNewExtractedLicenseInfo(SPDXNonStandardLicense license)
                                throws InvalidSPDXAnalysisException

Adds the license as a new ExtractedLicenseInfo

Parameters:

license -

Throws:

InvalidSPDXAnalysisException

extractedLicenseExists

protected boolean extractedLicenseExists(String id)
                                  throws InvalidSPDXAnalysisException

Parameters:

id -

Returns:

true if the license ID is already in the model as an extracted license info

Throws:

InvalidSPDXAnalysisException

getNextLicenseRef

public String getNextLicenseRef()

Returns:

next available license ID for an ExtractedLicenseInfo

getSpdxDocUri

public String getSpdxDocUri()

Returns:

the URI of the SPDX Document

getModel

public com.hp.hpl.jena.rdf.model.Model getModel()

Returns:

the model

setModel

public void setModel(com.hp.hpl.jena.rdf.model.Model model)

Parameters:

model - the model to set

createSpdxAnalysis

public void createSpdxAnalysis(String uri)
                        throws InvalidSPDXAnalysisException

Creates a new empty SPDX Document with the current SPDX document version. Note: Any previous SPDX documents will be deleted from the model to preserve the one and only one constraint. Note: Follow-up calls MUST be made to add the required properties for this to be a valid SPDX document

Parameters:

uri - URI for the SPDX Document

Throws:

InvalidSPDXAnalysisException

createSpdxAnalysis

public void createSpdxAnalysis(String uri,
                      String spdxVersion)
                        throws InvalidSPDXAnalysisException

Creates a new empty SPDX Document. Note: Any previous SPDX documents will be deleted from the model to preserve the one and only one constraint. Note: Follow-up calls MUST be made to add the required properties for this to be a valid SPDX document

Parameters:

uri - URI for the SPDX Document

spdxVersion - The version of SPDX analysis to create (impacts the data license for some versions)

Throws:

InvalidSPDXAnalysisException