org.spdx.rdfparser.referencetype

Class ReferenceType

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.referencetype.ReferenceType

All Implemented Interfaces:

Cloneable, Comparable<ReferenceType>, IRdfModel

public class ReferenceType
extends RdfModelObject
implements Comparable<ReferenceType>

Type of external reference Note that there are very few required fields for this class in that the external reference type does not need to be provided in the SPDX document for the document to be valid.

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
ReferenceType(IModelContainer modelContainer, org.apache.jena.graph.Node node)
ReferenceType(URI uri, String contextualExample, URL documentation, URL externalReferenceSite) Create a reference type from basic values

Method Summary

Modifier and Type	Method and Description
ReferenceType	clone()
int	compareTo(ReferenceType 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
String	getContextualExample()
URL	getDocumentation()
URL	getExternalReferenceSite()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
URI	getReferenceTypeUri()
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	setContextualExample(String contextualExample)
void	setDocumentation(URL documentation)
void	setExternalReferenceSite(URL externalReferenceSite)
void	setReferenceTypeUri(URI referenceTypeUri)
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, 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

ReferenceType

public ReferenceType(URI uri,
                     String contextualExample,
                     URL documentation,
                     URL externalReferenceSite)
              throws InvalidSPDXAnalysisException

Create a reference type from basic values

Parameters:

uri - Unique resource identifier for the reference type resource

contextualExample - Example for the reference type

documentation - URL pointing to documentation

externalReferenceSite - URL pointing to the reference site

Throws:

InvalidSPDXAnalysisException

ReferenceType

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

Parameters:

modelContainer -

object -

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:

getContextualExample

public String getContextualExample()
                            throws InvalidSPDXAnalysisException

Returns:

the contextualExample

Throws:

InvalidSPDXAnalysisException

setContextualExample

public void setContextualExample(String contextualExample)
                          throws InvalidSPDXAnalysisException

Parameters:

contextualExample - the contextualExample to set

Throws:

InvalidSPDXAnalysisException

getDocumentation

public URL getDocumentation()
                     throws InvalidSPDXAnalysisException

Returns:

the documentation

Throws:

InvalidSPDXAnalysisException

setDocumentation

public void setDocumentation(URL documentation)
                      throws InvalidSPDXAnalysisException

Parameters:

documentation - the documentation to set

Throws:

InvalidSPDXAnalysisException

getExternalReferenceSite

public URL getExternalReferenceSite()
                             throws InvalidSPDXAnalysisException

Returns:

the externalReferenceSite

Throws:

InvalidSPDXAnalysisException

setExternalReferenceSite

public void setExternalReferenceSite(URL externalReferenceSite)
                              throws InvalidSPDXAnalysisException

Parameters:

externalReferenceSite - the externalReferenceSite to set

Throws:

InvalidSPDXAnalysisException

getReferenceTypeUri

public URI getReferenceTypeUri()

Returns:

the referenceTypeUri

setReferenceTypeUri

public void setReferenceTypeUri(URI referenceTypeUri)

Parameters:

referenceTypeUri - the referenceTypeUri to set

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(ReferenceType o)

Specified by:

compareTo in interface Comparable<ReferenceType>

toString

public String toString()

Overrides:

toString in class Object

clone

public ReferenceType clone()

Overrides:

clone in class Object