org.spdx.rdfparser.model

Class SpdxDocument

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.SpdxElement

org.spdx.rdfparser.model.SpdxDocument

All Implemented Interfaces:

Cloneable, IRdfModel

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. Documents always have a model

Author:

Gary O'Neall

Field Summary

Fields inherited from class org.spdx.rdfparser.model.SpdxElement

annotations, comment, name, relationships

Fields inherited from class org.spdx.rdfparser.model.RdfModelObject

model, modelContainer, node, refreshOnGet, resource

Constructor Summary

Constructors

Constructor and Description
SpdxDocument(SpdxDocumentContainer documentContainer, org.apache.jena.graph.Node node)

Method Summary

Modifier and Type	Method and Description
void	addExtractedLicenseInfos(ExtractedLicenseInfo license)
boolean	equivalent(IRdfModel o) Returns true if the compare object contains properties which would be equal if they were contained in the same RDF Model
boolean	equivalent(IRdfModel o, boolean testRelationships) Test for equivalent
SPDXCreatorInformation	getCreationInfo()
SPDXCreatorInformation	getCreatorInfo() Deprecated.
AnyLicenseInfo	getDataLicense()
String	getDocumentComment() Deprecated.
SpdxDocumentContainer	getDocumentContainer()
SpdxItem[]	getDocumentDescribes()
String	getDocumentNamespace()
String	getDocumentUri()
ExternalDocumentRef[]	getExternalDocumentRefs()
ExtractedLicenseInfo[]	getExtractedLicenseInfos()
protected String	getNamePropertyName()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
SPDXReview[]	getReviewers() Deprecated.
SpdxPackage	getSpdxPackage() Deprecated.
String	getSpdxVersion() Deprecated.
String	getSpecVersion()
org.apache.jena.rdf.model.Resource	getType(org.apache.jena.rdf.model.Model model)
String	getUri(IModelContainer modelContainer) Get the URI for this RDF object.
void	populateModel() Populate the RDF model from the Java properties
void	setCreationInfo(SPDXCreatorInformation creationInfo)
void	setDataLicense(AnyLicenseInfo dataLicense)
void	setExternalDocumentRefs(ExternalDocumentRef[] externalDocumentRefs)
void	setExtractedLicenseInfos(ExtractedLicenseInfo[] extractedLicenseInfos)
void	setReviewers(SPDXReview[] reviewers) Deprecated.
void	setSpecVersion(String specVersion)
List<String>	verify()

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

addAnnotation, addNameToWarnings, addRelationship, arraysEquivalent, arraysEquivalent, clone, clone, cloneAnnotations, cloneRelationships, equivalentConsideringNull, equivalentConsideringNull, getAnnotations, getComment, getId, getName, getRelationships, setAnnotations, setComment, setId, setName, setRelationships, toString

Methods inherited from class org.spdx.rdfparser.model.RdfModelObject

addPropertyUriValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, createResource, createResource, equals, findAnnotationPropertyValues, findAnyLicenseInfoPropertyValue, findAnyLicenseInfoPropertyValues, findChecksumPropertyValue, findCreationInfoPropertyValue, findDuplicateResource, findElementPropertyValue, findExternalDocRefPropertyValues, findExternalDocRefPropertyValues, findExternalRefPropertyValues, findIntPropertyValue, findMultipleChecksumPropertyValues, findMultipleDoapPropertyValues, findMultipleElementPropertyValues, findMultiplePropertyValues, findReferenceTypePropertyValue, findRelationshipPropertyValues, findReviewPropertyValues, findSinglePointerPropertyValue, findSinglePropertyValue, findStartEndPointerPropertyValues, findUriPropertyValue, findUriPropertyValues, findVerificationCodePropertyValue, getNode, hashCode, isRefreshOnGet, removePropertyValue, resourcesEqual, setMultipleObjectsForSameNode, setPropertyUriValue, setPropertyUriValues, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setSingleObjectForSameNode

Methods inherited from class java.lang.Object

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

Constructor Detail

SpdxDocument

public SpdxDocument(SpdxDocumentContainer documentContainer,
                    org.apache.jena.graph.Node node)
             throws InvalidSPDXAnalysisException

Parameters:

documentContainer -

node -

Throws:

InvalidSPDXAnalysisException

Method Detail

getPropertiesFromModel

public void getPropertiesFromModel()
                            throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Fetch all of the properties from the model and populate the local Java properties

Overrides:

getPropertiesFromModel in class SpdxElement

Throws:

InvalidSPDXAnalysisException

getDocumentDescribes

public SpdxItem[] getDocumentDescribes()
                                throws InvalidSPDXAnalysisException

Returns:

all SPDX items connected directly to this document. Does not include children SPDX items (e.g. files within packages).

Throws:

InvalidSPDXAnalysisException

getUri

public String getUri(IModelContainer modelContainer)
              throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Get the URI for this RDF object. Null if this is for an anonomous node.

Overrides:

getUri in class SpdxElement

Returns:

Throws:

InvalidSPDXAnalysisException

getDocumentUri

public String getDocumentUri()
                      throws InvalidSPDXAnalysisException

Returns:

The unique Document Namespace

Throws:

InvalidSPDXAnalysisException

getDocumentNamespace

public String getDocumentNamespace()
                            throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getType

public org.apache.jena.rdf.model.Resource getType(org.apache.jena.rdf.model.Model model)

Overrides:

getType in class SpdxElement

Returns:

the RDF class name for the object

populateModel

public void populateModel()
                   throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Populate the RDF model from the Java properties

Overrides:

populateModel in class SpdxElement

Throws:

InvalidSPDXAnalysisException

getDocumentContainer

public SpdxDocumentContainer getDocumentContainer()

Returns:

the documentContainer

getCreationInfo

public SPDXCreatorInformation getCreationInfo()
                                       throws InvalidSPDXAnalysisException

Returns:

the creationInfo

Throws:

InvalidSPDXAnalysisException

setCreationInfo

public void setCreationInfo(SPDXCreatorInformation creationInfo)

Parameters:

creationInfo - the creationInfo to set

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 ExternalDocumentRef[] getExternalDocumentRefs()
                                              throws InvalidSPDXAnalysisException

Returns:

the externalDocumentRefs

Throws:

InvalidSPDXAnalysisException

setExternalDocumentRefs

public void setExternalDocumentRefs(ExternalDocumentRef[] externalDocumentRefs)
                             throws InvalidSPDXAnalysisException

Parameters:

externalDocumentRefs - the externalDocumentRefs to set

Throws:

InvalidSPDXAnalysisException

getExtractedLicenseInfos

public ExtractedLicenseInfo[] getExtractedLicenseInfos()
                                                throws InvalidSPDXAnalysisException

Returns:

the extractedLicenseInfos

Throws:

InvalidSPDXAnalysisException

setExtractedLicenseInfos

public void setExtractedLicenseInfos(ExtractedLicenseInfo[] extractedLicenseInfos)
                              throws InvalidSPDXAnalysisException

Parameters:

extractedLicenseInfos - the extractedLicenseInfos to set

Throws:

InvalidSPDXAnalysisException

getSpecVersion

public String getSpecVersion()

Returns:

the specVersion

getReviewers

@Deprecated
public SPDXReview[] getReviewers()
                                       throws InvalidSPDXAnalysisException

Deprecated.

Returns:

the reviewers

Throws:

InvalidSPDXAnalysisException

setReviewers

@Deprecated
public void setReviewers(SPDXReview[] reviewers)

Deprecated.

Parameters:

reviewers - the reviewers to set

setSpecVersion

public void setSpecVersion(String specVersion)

Parameters:

specVersion - the specVersion to set

verify

public List<String> verify()

Specified by:

verify in interface IRdfModel

Overrides:

verify in class SpdxElement

Returns:

List of validation errors for any non SPDX compliant properties.

equivalent

public boolean equivalent(IRdfModel o)

Description copied from interface: IRdfModel

Returns true if the compare object contains properties which would be equal if they were contained in the same RDF Model

Specified by:

equivalent in interface IRdfModel

Overrides:

equivalent in class SpdxElement

Returns:

equivalent

public boolean equivalent(IRdfModel o,
                          boolean testRelationships)

Description copied from class: SpdxElement

Test for equivalent

Overrides:

equivalent in class SpdxElement

testRelationships - If true, test relationships

Returns:

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

getSpdxVersion

@Deprecated
public String getSpdxVersion()

Deprecated.

This method has been replaced by getSpecVersion to match the specification property name

Returns:

getCreatorInfo

@Deprecated
public SPDXCreatorInformation getCreatorInfo()
                                                   throws InvalidSPDXAnalysisException

Deprecated.

This method has been replaced by getCreationInfo to match the specification property name

Returns:

Throws:

InvalidSPDXAnalysisException

getDocumentComment

@Deprecated
public String getDocumentComment()

Deprecated.

This method has been replaced by getComment to match the specification property name

Returns:

getSpdxPackage

@Deprecated
public SpdxPackage getSpdxPackage()
                                        throws InvalidSPDXAnalysisException

Deprecated.

This method has been replaced by getSpdxItems This method will fail unless there is one and only 1 SPDX document

Returns:

Throws:

InvalidSPDXAnalysisException

addExtractedLicenseInfos

public void addExtractedLicenseInfos(ExtractedLicenseInfo license)
                              throws InvalidSPDXAnalysisException

Parameters:

license - license to be added to the extracted licensing infos

Throws:

InvalidSPDXAnalysisException