Package org.spdx.library.model

Class SpdxDocument

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.SpdxElement

org.spdx.library.model.SpdxDocument

public class SpdxDocument
extends SpdxElement

An SpdxDocument is a summary of the contents, provenance, ownership and licensing analysis of a specific software package. This is, effectively, the top level of SPDX information.

Author:

Gary O'Neall

Field Summary

Fields inherited from class org.spdx.library.model.ModelObject

strict

Constructor Summary

Constructors

Constructor	Description
SpdxDocument(String documentUri)	Obtains or creates an SPDX document using the default document store
SpdxDocument(IModelStore modelStore, String documentUri, ModelCopyManager copyManager, boolean create)

Method Summary

Modifier and Type	Method	Description
protected List<String>	_verify(Set<String> verifiedIds, String verifySpecVersion)	Implementation of the specific verifications for this model object
boolean	addExtractedLicenseInfos(ExtractedLicenseInfo licenseInfo)	Add a license info to the collection of extracted license infos
SpdxCreatorInformation	getCreationInfo()
AnyLicenseInfo	getDataLicense()
Collection<SpdxElement>	getDocumentDescribes()
Collection<ExternalDocumentRef>	getExternalDocumentRefs()
Collection<ExtractedLicenseInfo>	getExtractedLicenseInfos()
protected String	getNamePropertyName()
String	getSpecVersion()
String	getType()
void	setCreationInfo(SpdxCreatorInformation creationInfo)
void	setDataLicense(AnyLicenseInfo dataLicense)
SpdxDocument	setDocumentDescribes(List<SpdxItem> documentDescribes)	clear and reset document describes to the paramater collection
SpdxDocument	setExternalDocumentRefs(Collection<ExternalDocumentRef> externalDocumentRefs)	Clear the externalDocumentRefs and add all elements from externalDocumentRefs
SpdxDocument	setExtractedLicenseInfos(List<ExtractedLicenseInfo> extractedLicenseInfos)	Clear the extractedLicenseInfos and add all elements from extractedLicenseInfos
void	setSpecVersion(String specVersion)

Methods inherited from class org.spdx.library.model.SpdxElement

addAnnotation, addNameToWarnings, addRelationship, getAnnotations, getComment, getName, getRelationships, removeAnnotation, removeRelationship, setAnnotations, setComment, setName, setRelationships

Methods inherited from class org.spdx.library.model.ModelObject

addPropertyValueToCollection, addValueToCollection, clearValueCollection, clearValueCollection, clone, copyFrom, createAnnotation, createByteOffsetPointer, createChecksum, createConjunctiveLicenseSet, createCreationInfo, createCrossRef, createDisjunctiveLicenseSet, createExternalDocumentRef, createExternalRef, createLineCharPointer, createPackage, createPackageVerificationCode, createRelationship, createSpdxFile, createSpdxSnippet, createStartEndPointer, enterCriticalSection, equals, equivalent, equivalent, getAnyLicenseInfoPropertyValue, getBooleanPropertyValue, getCopyManager, getDocumentUri, getElementPropertyValue, getEnumPropertyValue, getId, getIntegerPropertyValue, getModelStore, getObjectPropertyValue, getObjectPropertyValue, getObjectPropertyValueCollection, getObjectPropertyValueSet, getPropertyValueNames, getStringCollection, getStringPropertyValue, hashCode, idToIdType, isCollectionMembersAssignableTo, isStrict, leaveCriticalSection, removeProperty, removeProperty, removePropertyValueFromCollection, removePropertyValueFromCollection, replacePropertyValueCollection, setCopyManager, setPropertyValue, setPropertyValue, setStrict, toString, toTypedValue, updateAddPropertyValueToCollection, updateClearValueCollection, updatePropertyValue, updateRemoveProperty, updateRemovePropertyValueFromCollection, verify, verify, verify, verifyCollection

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SpdxDocument

public SpdxDocument(IModelStore modelStore, String documentUri, ModelCopyManager copyManager, boolean create) throws InvalidSPDXAnalysisException

Parameters:

modelStore - Storage for the model objects

documentUri - SPDX Document URI for the document associated with this model

copyManager - if non-null, allows for copying of any properties set which use other model stores or document URI's

create - - if true, the object will be created in the store if it is not already present

Throws:

InvalidSPDXAnalysisException

SpdxDocument

public SpdxDocument(String documentUri) throws InvalidSPDXAnalysisException

Obtains or creates an SPDX document using the default document store

Parameters:

documentUri -

Throws:

InvalidSPDXAnalysisException

Method Details

getType

public String getType()

Specified by:

getType in class ModelObject

Returns:

The class name for this object. Class names are defined in the constants file

getNamePropertyName

protected String getNamePropertyName()

Overrides:

getNamePropertyName in class SpdxElement

Returns:

the property name used for the Name property. Override this function if using a subproperty of SPDX Name

getDocumentDescribes

public Collection<SpdxElement> getDocumentDescribes() throws InvalidSPDXAnalysisException

Returns:

collection of items described by this SPDX document

Throws:

InvalidSPDXAnalysisException

setDocumentDescribes

public SpdxDocument setDocumentDescribes(List<SpdxItem> documentDescribes)

clear and reset document describes to the paramater collection

Parameters:

documentDescribes - collection of items described by this SPDX document

Returns:

this to chain setters

getCreationInfo

@Nullable public SpdxCreatorInformation getCreationInfo() throws InvalidSPDXAnalysisException

Returns:

the creationInfo, null if no creationInfo in the SPDX document

Throws:

InvalidSPDXAnalysisException

setCreationInfo

public void setCreationInfo(SpdxCreatorInformation creationInfo) throws InvalidSPDXAnalysisException

Parameters:

creationInfo - the creationInfo to set

Throws:

InvalidSPDXAnalysisException

getDataLicense

public AnyLicenseInfo getDataLicense() throws InvalidSPDXAnalysisException

Returns:

the dataLicense

Throws:

InvalidSPDXAnalysisException

setDataLicense

public void setDataLicense(AnyLicenseInfo dataLicense) throws InvalidSPDXAnalysisException

Parameters:

dataLicense - the dataLicense to set

Throws:

InvalidSPDXAnalysisException

getExternalDocumentRefs

public Collection<ExternalDocumentRef> getExternalDocumentRefs() throws InvalidSPDXAnalysisException

Returns:

the externalDocumentRefs

Throws:

InvalidSPDXAnalysisException

getExtractedLicenseInfos

public Collection<ExtractedLicenseInfo> getExtractedLicenseInfos() throws InvalidSPDXAnalysisException

Returns:

the extractedLicenseInfos

Throws:

InvalidSPDXAnalysisException

addExtractedLicenseInfos

public boolean addExtractedLicenseInfos(ExtractedLicenseInfo licenseInfo)

Add a license info to the collection of extracted license infos

Parameters:

licenseInfo -

Returns:

setExtractedLicenseInfos

public SpdxDocument setExtractedLicenseInfos(List<ExtractedLicenseInfo> extractedLicenseInfos)

Clear the extractedLicenseInfos and add all elements from extractedLicenseInfos

Parameters:

extractedLicenseInfos -

Returns:

this to enable chaining of sets

getSpecVersion

public String getSpecVersion() throws InvalidSPDXAnalysisException

Returns:

the specVersion

Throws:

InvalidSPDXAnalysisException

setSpecVersion

public void setSpecVersion(String specVersion) throws InvalidSPDXAnalysisException

Parameters:

specVersion - the specVersion to set

Throws:

InvalidSPDXAnalysisException

_verify

protected List<String> _verify(Set<String> verifiedIds, String verifySpecVersion)

Description copied from class: ModelObject

Implementation of the specific verifications for this model object

Overrides:

_verify in class SpdxElement

Parameters:

verifiedIds - list of all Element Id's which have already been verified - prevents infinite recursion

verifySpecVersion - Version of the SPDX spec to verify against

Returns:

Any verification errors or warnings associated with this object

setExternalDocumentRefs

public SpdxDocument setExternalDocumentRefs(Collection<ExternalDocumentRef> externalDocumentRefs)

Clear the externalDocumentRefs and add all elements from externalDocumentRefs

Parameters:

externalDocumentRefs -

Returns:

this to enable chaining of sets