org.spdx.rdfparser.model

Class ExternalDocumentRef

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.ExternalDocumentRef

All Implemented Interfaces:

Cloneable, Comparable<ExternalDocumentRef>, IRdfModel

public class ExternalDocumentRef
extends RdfModelObject
implements Comparable<ExternalDocumentRef>

Information about an external SPDX document reference including the checksum. This allows for verification of the external references. Since an SPDX document must be in its own container, there are a few special considerations for this class: - model, node, and resource are associated with the document making an external reference, it does not include the actual document being referenced - This class can be used with only the URI for the external document being provided. It does not require the entire document to be passed in. The spdxDocument itself is optional.

Author:

Gary O'Neall

Field Summary

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

model, modelContainer, node, refreshOnGet, resource

Constructor Summary

Constructors

Constructor and Description
ExternalDocumentRef(IModelContainer modelContainer, com.hp.hpl.jena.graph.Node node)
ExternalDocumentRef(SpdxDocument externalDocument, Checksum checksum, String externalDocumentId)
ExternalDocumentRef(String spdxDocumentUri, Checksum checksum, String externalDocumentId)

Method Summary

Methods

Modifier and Type	Method and Description
ExternalDocumentRef	clone()
int	compareTo(ExternalDocumentRef o)
boolean	equivalent(IRdfModel compare) Returns true if the compare object contains properties which would be equal if they were contained in the same RDF Model
Checksum	getChecksum()
String	getExternalDocumentId() a string containing letters, numbers, “.”, “-” or “+” which uniquely identifies an external document within this document.
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
SpdxDocument	getSpdxDocument()
String	getSpdxDocumentNamespace()
com.hp.hpl.jena.rdf.model.Resource	getType(com.hp.hpl.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	setChecksum(Checksum checksum)
void	setExternalDocumentId(String externalDocumentId)
void	setSpdxDocument(SpdxDocument spdxDocument)
void	setSpdxDocumentNamespace(String spdxDocumentNamespace)
List<String>	verify()

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

addPropertyUriValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, arraysEquivalent, createResource, createResource, equals, equivalentConsideringNull, findAnnotationPropertyValues, findAnyLicenseInfoPropertyValue, findAnyLicenseInfoPropertyValues, findChecksumPropertyValue, findCreationInfoPropertyValue, findDuplicateResource, findElementPropertyValue, findExternalDocRefPropertyValues, findExternalDocRefPropertyValues, findMultipleChecksumPropertyValues, findMultipleDoapPropertyValues, findMultipleElementPropertyValues, findMultiplePropertyValues, findRelationshipPropertyValues, findReviewPropertyValues, findSinglePropertyValue, findUriPropertyValue, findUriPropertyValues, findVerificationCodePropertyValue, getNode, hashCode, isRefreshOnGet, removePropertyValue, resourcesEqual, setMultipleObjectsForSameNode, setPropertyUriValue, setPropertyUriValues, 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, toString, wait, wait, wait

Constructor Detail

ExternalDocumentRef

public ExternalDocumentRef(IModelContainer modelContainer,
                   com.hp.hpl.jena.graph.Node node)
                    throws InvalidSPDXAnalysisException

Parameters:

modelContainer -

node -

Throws:

InvalidSPDXAnalysisException

ExternalDocumentRef

public ExternalDocumentRef(String spdxDocumentUri,
                   Checksum checksum,
                   String externalDocumentId)

Parameters:

spdxDocumentUri - Unique URI for the external SPDX document

checksum - Sha1 checksum for the external document

ExternalDocumentRef

public ExternalDocumentRef(SpdxDocument externalDocument,
                   Checksum checksum,
                   String externalDocumentId)

Parameters:

externalDocument - SPDX Document being referenced

checksum - Sha1 checksum of the external document

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

Specified by:

getPropertiesFromModel in class RdfModelObject

Throws:

InvalidSPDXAnalysisException

verify

public List<String> verify()

Specified by:

verify in interface IRdfModel

Returns:

List of validation errors for any non SPDX compliant properties.

getUri

public String getUri(IModelContainer modelContainer)

Description copied from class: RdfModelObject

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

Specified by:

getUri in class RdfModelObject

Returns:

getType

public com.hp.hpl.jena.rdf.model.Resource getType(com.hp.hpl.jena.rdf.model.Model model)

Specified by:

getType in class RdfModelObject

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

Specified by:

populateModel in class RdfModelObject

Throws:

InvalidSPDXAnalysisException

getChecksum

public Checksum getChecksum()
                     throws InvalidSPDXAnalysisException

Returns:

the checksum

Throws:

InvalidSPDXAnalysisException

setChecksum

public void setChecksum(Checksum checksum)
                 throws InvalidSPDXAnalysisException

Parameters:

checksum - the checksum to set

Throws:

InvalidSPDXAnalysisException

getSpdxDocumentNamespace

public String getSpdxDocumentNamespace()

Returns:

the spdxDocumentNamespace

setSpdxDocumentNamespace

public void setSpdxDocumentNamespace(String spdxDocumentNamespace)
                              throws InvalidSPDXAnalysisException

Parameters:

spdxDocumentNamespace - the spdxDocumentNamespace to set

Throws:

InvalidSPDXAnalysisException

getSpdxDocument

public SpdxDocument getSpdxDocument()

Returns:

the spdxDocument

setSpdxDocument

public void setSpdxDocument(SpdxDocument spdxDocument)
                     throws InvalidSPDXAnalysisException

Parameters:

spdxDocument - the spdxDocument to set

Throws:

InvalidSPDXAnalysisException

equivalent

public boolean equivalent(IRdfModel compare)

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

Returns:

clone

public ExternalDocumentRef clone()

Overrides:

clone in class Object

getExternalDocumentId

public String getExternalDocumentId()

a string containing letters, numbers, “.”, “-” or “+” which uniquely identifies an external document within this document.

Returns:

setExternalDocumentId

public void setExternalDocumentId(String externalDocumentId)

Parameters:

externalDocumentId -

compareTo

public int compareTo(ExternalDocumentRef o)

Specified by:

compareTo in interface Comparable<ExternalDocumentRef>