Package org.spdx.rdfparser.license

Class CrossRef

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.license.CrossRef

All Implemented Interfaces:

Cloneable, IRdfModel

public class CrossRef
extends RdfModelObject

Cross reference details for the a URL reference

Author:

Gary O'Neall

Field Summary

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

model, modelContainer, node, refreshOnGet, resource

Constructor Summary

Constructors

Constructor	Description
CrossRef(String url)	All null details
CrossRef(String url, Boolean isValid, Boolean isLive, Boolean isWayBackLink, String match, String timestamp, Integer order)
CrossRef(IModelContainer modelContainer, org.apache.jena.graph.Node node)

Method Summary

Modifier and Type	Method	Description
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	getMatch()
Integer	getOrder()
void	getPropertiesFromModel()	Fetch all of the properties from the model and populate the local Java properties
String	getTimestamp()
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.
String	getUrl()
Boolean	isLive()
Boolean	isValid()
Boolean	isWayBackLink()
void	populateModel()	Populate the RDF model from the Java properties
void	setDetails(Boolean isValid, Boolean isLive, Boolean isWayBackLink, String match, String timestamp)	Convenience method for setting details related to the URL checking
void	setIsLive(Boolean isLive)
void	setIsValid(Boolean isValid)
void	setIsWayBackLink(Boolean isWayBackLink)
void	setMatch(String match)
void	setOrder(Integer order)
void	setTimestamp(String timestamp)
void	setUrl(String url)
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, findMultipleCrossRefPropertyValues, 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, SetPropertyValue, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setSingleObjectForSameNode

Methods inherited from class java.lang.Object

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

Constructor Details

CrossRef

public CrossRef(String url, @Nullable Boolean isValid, @Nullable Boolean isLive, @Nullable Boolean isWayBackLink, @Nullable String match, @Nullable String timestamp, @Nullable Integer order)

Parameters:

url - SeeAlso URL which relates to a license

isValid - true if the URL is a valid URL

isLive - true if the web page is accessible on the public internet

isWayBackLink - true if the URL is a Wayback machine link

match - true if the website contains license text which matches the cross reference

timestamp - datetime when the Cross ref detailed information was generated

order - the order in which this cross ref should be displayed - 0 being displayed first

CrossRef

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

Parameters:

modelContainer -

node -

Throws:

InvalidSPDXAnalysisException

CrossRef

public CrossRef(String url)

All null details

Method Details

verify

public List<String> verify()

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

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

getMatch

public String getMatch()

Returns:

the match

setMatch

public void setMatch(String match)

Parameters:

match - the match to set

getUrl

public String getUrl()

Returns:

the url

setUrl

public void setUrl(String url)

Parameters:

url - the url to set

isValid

public Boolean isValid() throws InvalidSPDXAnalysisException

Returns:

the isValid

Throws:

InvalidSPDXAnalysisException

setIsValid

public void setIsValid(Boolean isValid)

Parameters:

isValid - the isValid to set

isLive

public Boolean isLive() throws InvalidSPDXAnalysisException

Returns:

the isLive

Throws:

InvalidSPDXAnalysisException

setIsLive

public void setIsLive(Boolean isLive)

Parameters:

isLive - the isLive to set

getTimestamp

public String getTimestamp()

Returns:

the timestamp

setTimestamp

public void setTimestamp(String timestamp)

Parameters:

timestamp - the timestamp to set

isWayBackLink

public Boolean isWayBackLink() throws InvalidSPDXAnalysisException

Returns:

the isWayBackLink

Throws:

InvalidSPDXAnalysisException

setIsWayBackLink

public void setIsWayBackLink(Boolean isWayBackLink)

Parameters:

isWayBackLink - the isWayBackLink to set

getOrder

public Integer getOrder() throws InvalidSPDXAnalysisException

Returns:

the order

Throws:

InvalidSPDXAnalysisException

setOrder

public void setOrder(Integer order)

Parameters:

order - the order to set

setDetails

public void setDetails(Boolean isValid, Boolean isLive, Boolean isWayBackLink, String match, String timestamp)

Convenience method for setting details related to the URL checking

Parameters:

isValid -

isLive -

isWayBackLink -

match -

timestamp -

toString

public String toString()

Overrides:

toString in class Object