org.spdx.rdfparser.license

Class SpdxListedLicense

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.license.AnyLicenseInfo

org.spdx.rdfparser.license.SimpleLicensingInfo

org.spdx.rdfparser.license.License

org.spdx.rdfparser.license.SpdxListedLicense

All Implemented Interfaces:

Cloneable, IRdfModel

public class SpdxListedLicense
extends License

Listed license for SPDX as listed at spdx.org/licenses

Author:

Gary O'Neall

Field Summary

Fields inherited from class org.spdx.rdfparser.license.License

deprecated, fsfLibre, licenseText, osiApproved, standardLicenseHeader, standardLicenseTemplate

Fields inherited from class org.spdx.rdfparser.license.SimpleLicensingInfo

comment, licenseId, name, seeAlso

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

model, modelContainer, node, refreshOnGet, resource

Constructor Summary

Constructors

Constructor and Description
SpdxListedLicense(IModelContainer modelContainer, org.apache.jena.graph.Node licenseNode) Constructs an SPDX License from the licenseNode
SpdxListedLicense(String name, String id, String text, String[] sourceUrl, String comments, String standardLicenseHeader, String template, boolean osiApproved)
SpdxListedLicense(String name, String id, String text, String[] sourceUrl, String comments, String standardLicenseHeader, String template, boolean osiApproved, boolean fsfLibre)
SpdxListedLicense(String name, String id, String text, String[] sourceUrl, String comments, String standardLicenseHeader, String template, boolean osiApproved, Boolean fsfLibre, String licenseTextHtml, boolean isDeprecated, String deprecatedVersion)
SpdxListedLicense(String name, String id, String text, String[] sourceUrl, String comments, String standardLicenseHeader, String template, boolean osiApproved, String licenseTextHtml)
SpdxListedLicense(String name, String id, String text, String[] sourceUrl, String comments, String standardLicenseHeader, String template, String licenseHeaderTemplate, boolean osiApproved, Boolean fsfLibre)
SpdxListedLicense(String name, String id, String text, String[] sourceUrl, String comments, String standardLicenseHeader, String template, String licenseHeaderTemplate, boolean osiApproved, boolean fsfLibre, String licenseTextHtml, String licenseHeaderHtml)

Method Summary

Modifier and Type	Method and 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	getDeprecatedVersion()
String	getLicenseHeaderHtml()
String	getLicenseTextHtml()
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	setDeprecatedVersion(String deprecatedVersion)
void	setLicenseHeaderHtml(String licenseHeaderHtml) Set the licenseHeaderTemplateHtml
void	setLicenseTextHtml(String licenseTextHtml) Set the licenseTextHtml
List<String>	verify()

Methods inherited from class org.spdx.rdfparser.license.License

clone, copyFrom, equals, getFsfLibre, getLicenseText, getNotes, getPropertiesFromModel, getStandardLicenseHeader, getStandardLicenseHeaderTemplate, getStandardLicenseTemplate, hashCode, isDeprecated, isFsfLibre, isNotFsfLibre, isOsiApproved, populateModel, setDeprecated, setFsfLibre, setLicenseText, setNotes, setOsiApproved, setStandardLicenseHeader, setStandardLicenseHeaderTemplate, setStandardLicenseTemplate, toString

Methods inherited from class org.spdx.rdfparser.license.SimpleLicensingInfo

findDuplicateResource, getComment, getLicenseId, getName, getSeeAlso, setComment, setLicenseId, setName, setSeeAlso

Methods inherited from class org.spdx.rdfparser.license.AnyLicenseInfo

getResource

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

addPropertyUriValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, arraysEquivalent, createResource, createResource, 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, 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

SpdxListedLicense

public SpdxListedLicense(String name,
                         String id,
                         String text,
                         String[] sourceUrl,
                         String comments,
                         String standardLicenseHeader,
                         String template,
                         boolean osiApproved,
                         Boolean fsfLibre,
                         String licenseTextHtml,
                         boolean isDeprecated,
                         String deprecatedVersion)
                  throws InvalidSPDXAnalysisException

Parameters:

name - License name

id - License ID

text - License text

sourceUrl - Optional URLs that reference this license

comments - Optional comments

standardLicenseHeader - Optional license header

template - Optional template

osiApproved - True if this is an OSI Approved license

fsfLibre - true if FSF describes the license as free / libre, false if FSF describes the license as not free / libre, null if FSF does not reference the license

licenseTextHtml - HTML version for the license text

isDeprecated - True if this license has been designated as deprecated by the SPDX legal team

deprecatedVersion - License list version when this license was first deprecated (null if not deprecated)

Throws:

InvalidSPDXAnalysisException

SpdxListedLicense

public SpdxListedLicense(String name,
                         String id,
                         String text,
                         String[] sourceUrl,
                         String comments,
                         String standardLicenseHeader,
                         String template,
                         boolean osiApproved,
                         String licenseTextHtml)
                  throws InvalidSPDXAnalysisException

Parameters:

name - License name

id - License ID

text - License text

sourceUrl - Optional URLs that reference this license

comments - Optional comments

standardLicenseHeader - Optional license header

template - Optional template

osiApproved - True if this is an OSI Approved license

licenseTextHtml - HTML version for the license text

Throws:

InvalidSPDXAnalysisException

SpdxListedLicense

public SpdxListedLicense(String name,
                         String id,
                         String text,
                         String[] sourceUrl,
                         String comments,
                         String standardLicenseHeader,
                         String template,
                         boolean osiApproved,
                         boolean fsfLibre)
                  throws InvalidSPDXAnalysisException

Parameters:

name - License name

id - License ID

text - License text

sourceUrl - Optional URLs that reference this license

comments - Optional comments

standardLicenseHeader - Optional license header

template - Optional template

osiApproved - True if this is an OSI Approvied license

fsfLibre - True if the license is listed by the Free Software Foundation as free / libre

Throws:

InvalidSPDXAnalysisException

SpdxListedLicense

public SpdxListedLicense(String name,
                         String id,
                         String text,
                         String[] sourceUrl,
                         String comments,
                         String standardLicenseHeader,
                         String template,
                         boolean osiApproved)
                  throws InvalidSPDXAnalysisException

Parameters:

name - License name

id - License ID

text - License text

sourceUrl - Optional URLs that reference this license

comments - Optional comments

standardLicenseHeader - Optional license header

template - Optional template

osiApproved - True if this is an OSI Approvied license

Throws:

InvalidSPDXAnalysisException

SpdxListedLicense

public SpdxListedLicense(IModelContainer modelContainer,
                         org.apache.jena.graph.Node licenseNode)
                  throws InvalidSPDXAnalysisException

Constructs an SPDX License from the licenseNode

Parameters:

modelContainer - container which includes the license

licenseNode - RDF graph node representing the SPDX License

Throws:

InvalidSPDXAnalysisException

SpdxListedLicense

public SpdxListedLicense(String name,
                         String id,
                         String text,
                         String[] sourceUrl,
                         String comments,
                         String standardLicenseHeader,
                         String template,
                         String licenseHeaderTemplate,
                         boolean osiApproved,
                         boolean fsfLibre,
                         String licenseTextHtml,
                         String licenseHeaderHtml)
                  throws InvalidSPDXAnalysisException

Parameters:

name - License name

id - License ID

text - License text

sourceUrl - Optional URLs that reference this license

comments - Optional comments

standardLicenseHeader - Optional license header

template - Optional template

licenseHeaderTemplate - optional template for the standard license header

osiApproved - True if this is an OSI Approved license

fsfLibre - True if the license is listed by the Free Software Foundation as free / libre

licenseTextHtml - HTML version for the license text

licenseHeaderHtml - HTML version for the standard license header

Throws:

InvalidSPDXAnalysisException

SpdxListedLicense

public SpdxListedLicense(String name,
                         String id,
                         String text,
                         String[] sourceUrl,
                         String comments,
                         String standardLicenseHeader,
                         String template,
                         String licenseHeaderTemplate,
                         boolean osiApproved,
                         Boolean fsfLibre)
                  throws InvalidSPDXAnalysisException

Parameters:

name - License name

id - License ID

text - License text

sourceUrl - Optional URLs that reference this license

comments - Optional comments

standardLicenseHeader - Optional license header

template - Optional template

licenseHeaderTemplate - optional template for the standard license header

osiApproved - True if this is an OSI Approved license

fsfLibre - True if the license is listed by the Free Software Foundation as free / libre

Throws:

InvalidSPDXAnalysisException

Method Detail

verify

public List<String> verify()

Specified by:

verify in interface IRdfModel

Overrides:

verify in class License

Returns:

List of validation errors for any non SPDX compliant properties.

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

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 SimpleLicensingInfo

Returns:

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

Overrides:

equivalent in class License

Returns:

getLicenseTextHtml

public String getLicenseTextHtml()
                          throws InvalidLicenseTemplateException

Returns:

HTML fragment containing the License Text

Throws:

InvalidLicenseTemplateException

setLicenseTextHtml

public void setLicenseTextHtml(String licenseTextHtml)

Set the licenseTextHtml

Parameters:

licenseTextHtml - HTML fragment representing the license text

getLicenseHeaderHtml

public String getLicenseHeaderHtml()
                            throws InvalidLicenseTemplateException

Returns:

HTML fragment containing the License standard header text

Throws:

InvalidLicenseTemplateException

setLicenseHeaderHtml

public void setLicenseHeaderHtml(String licenseHeaderHtml)

Set the licenseHeaderTemplateHtml

Parameters:

licenseHeaderHtml - HTML fragment representing the license standard header text

getDeprecatedVersion

public String getDeprecatedVersion()

Returns:

the deprecatedVersion

setDeprecatedVersion

public void setDeprecatedVersion(String deprecatedVersion)

Parameters:

deprecatedVersion - the deprecatedVersion to set