org.spdx.rdfparser.model

Class ExternalRef

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.ExternalRef

All Implemented Interfaces:

Cloneable, Comparable<ExternalRef>, IRdfModel

public class ExternalRef
extends RdfModelObject
implements Comparable<ExternalRef>

An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalRef.ReferenceCategory

Field Summary

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

model, modelContainer, node, refreshOnGet, resource

Constructor Summary

Constructors

Constructor and Description
ExternalRef(ExternalRef.ReferenceCategory referenceCategory, ReferenceType referenceType, String referenceLocator, String comment)
ExternalRef(IModelContainer modelContainer, org.apache.jena.graph.Node node)

Method Summary

Modifier and Type	Method and Description
ExternalRef	clone()
int	compareTo(ExternalRef 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
org.apache.jena.rdf.model.Resource	findDuplicateResource(IModelContainer modelContainer, String uri) Search the model to see if there is a duplicate resource either based on the URI or based on other information.
String	getComment()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
ExternalRef.ReferenceCategory	getReferenceCategory()
String	getReferenceLocator()
ReferenceType	getReferenceType()
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	setComment(String comment)
void	setReferenceCategory(ExternalRef.ReferenceCategory referenceCategory)
void	setReferenceLocator(String referenceLocator)
void	setReferenceType(ReferenceType referenceType)
String	toString()
List<String>	verify()

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

addPropertyUriValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, arraysEquivalent, createResource, createResource, equals, equivalentConsideringNull, findAnnotationPropertyValues, findAnyLicenseInfoPropertyValue, findAnyLicenseInfoPropertyValues, findChecksumPropertyValue, findCreationInfoPropertyValue, 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

ExternalRef

public ExternalRef(ExternalRef.ReferenceCategory referenceCategory,
                   ReferenceType referenceType,
                   String referenceLocator,
                   String comment)

Parameters:

referenceCategory - Category for the external reference

referenceType - Reference type as defined in the SPDX appendix

referenceLocator - unique string with no spaces necessary to access the packagespecific information, metadata, or content within the target location. The format of the locator is subject to constraints defined by the referenceType

ExternalRef

public ExternalRef(IModelContainer modelContainer,
                   org.apache.jena.graph.Node node)
            throws InvalidSPDXAnalysisException

Parameters:

modelContainer - Container for the RDF model

node - Node for this external references

Throws:

InvalidSPDXAnalysisException

Method Detail

verify

public List<String> verify()

Specified by:

verify in interface IRdfModel

Returns:

List of validation errors for any non SPDX compliant properties.

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:

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

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.

Specified by:

getUri in class RdfModelObject

Returns:

Throws:

InvalidSPDXAnalysisException

getType

public org.apache.jena.rdf.model.Resource getType(org.apache.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

compareTo

public int compareTo(ExternalRef o)

Specified by:

compareTo in interface Comparable<ExternalRef>

clone

public ExternalRef clone()

Overrides:

clone in class Object

getComment

public String getComment()

Returns:

the comment

setComment

public void setComment(String comment)

getReferenceCategory

public ExternalRef.ReferenceCategory getReferenceCategory()

Returns:

the referenceCategory

setReferenceCategory

public void setReferenceCategory(ExternalRef.ReferenceCategory referenceCategory)
                          throws InvalidSPDXAnalysisException

Parameters:

referenceCategory - the referenceCategory to set

Throws:

InvalidSPDXAnalysisException

getReferenceType

public ReferenceType getReferenceType()
                               throws InvalidSPDXAnalysisException

Returns:

the referenceType

Throws:

InvalidSPDXAnalysisException

setReferenceType

public void setReferenceType(ReferenceType referenceType)
                      throws InvalidSPDXAnalysisException

Parameters:

referenceType - the referenceType to set

Throws:

InvalidSPDXAnalysisException

getReferenceLocator

public String getReferenceLocator()

Returns:

the referenceLocator

setReferenceLocator

public void setReferenceLocator(String referenceLocator)

Parameters:

referenceLocator - the referenceLocator to set

findDuplicateResource

public org.apache.jena.rdf.model.Resource findDuplicateResource(IModelContainer modelContainer,
                                                                String uri)
                                                         throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Search the model to see if there is a duplicate resource either based on the URI or based on other information. Subclasses may choose to override this method to prevent duplicate resource from being created with the same properties.

Overrides:

findDuplicateResource in class RdfModelObject

Returns:

Any duplicate resource found. Null if no duplicate resource was found.

Throws:

InvalidSPDXAnalysisException

toString

public String toString()

Overrides:

toString in class Object