org.spdx.rdfparser.license

Class ListedLicenses

java.lang.Object

org.spdx.rdfparser.license.ListedLicenses

All Implemented Interfaces:

IModelContainer

public class ListedLicenses
extends Object
implements IModelContainer

Singleton class which holds the listed licenses

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LICENSE_LIST_VERSION
static String	LISTED_LICENSE_URI_PREFIX

Method Summary

Modifier and Type	Method and Description
boolean	addCheckNodeObject(org.apache.jena.graph.Node node, IRdfModel rdfModelObject) Add a node object to the container.
void	addSpdxElementRef(String elementRef) Notifies the model container that a new element ref is in use.
org.apache.jena.rdf.model.Resource	createResource(org.apache.jena.rdf.model.Resource duplicate, String uri, org.apache.jena.rdf.model.Resource type, IRdfModel modelObject) Create a resource in the model
String	documentNamespaceToId(String externalNamespace) Translate an external document namespace URI to an external document ID
String	externalDocumentIdToNamespace(String docId) Translate an external document ID to the external document's namespace
String	getDocumentNamespace()
AnyLicenseInfo	getLicenseFromStdLicModel(IModelContainer modelContainer, org.apache.jena.graph.Node node) Get or create a standard license in the model container copying any relevant information from the standard model to the model in the modelContainer
protected SpdxListedLicense	getLicenseFromUri(String uri) Get a listed license based on a URI.
String	getLicenseListVersion()
SpdxListedLicense	getListedLicenseById(String licenseId)
static ListedLicenses	getListedLicenses()
org.apache.jena.rdf.model.Model	getModel()
String	getNextSpdxElementRef()
String[]	getSpdxListedLicenseIds()
boolean	isSpdxListedLicenseID(String licenseID)
static ListedLicenses	resetListedLicenses() Resets all of the cached license information and reloads the license IDs NOTE: This method should be used with caution, it will negatively impact performance.
boolean	spdxElementRefExists(String elementRef) Returns true if the element reference already exists in the model

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LICENSE_LIST_VERSION

public static final String DEFAULT_LICENSE_LIST_VERSION

See Also:

Constant Field Values

LISTED_LICENSE_URI_PREFIX

public static final String LISTED_LICENSE_URI_PREFIX

See Also:

Constant Field Values

Method Detail

getListedLicenses

public static ListedLicenses getListedLicenses()

resetListedLicenses

public static ListedLicenses resetListedLicenses()

Resets all of the cached license information and reloads the license IDs NOTE: This method should be used with caution, it will negatively impact performance.

Returns:

getModel

public org.apache.jena.rdf.model.Model getModel()

Specified by:

getModel in interface IModelContainer

Returns:

the RDF model

getLicenseFromUri

protected SpdxListedLicense getLicenseFromUri(String uri)
                                       throws InvalidSPDXAnalysisException

Get a listed license based on a URI. The URI can be a file or a web resource. The license information is copied into the listedLicenseModel and the license is placed into the cache.

Parameters:

uri -

Returns:

Throws:

InvalidSPDXAnalysisException

isSpdxListedLicenseID

public boolean isSpdxListedLicenseID(String licenseID)

Parameters:

licenseID -

Returns:

true if the licenseID belongs to an SPDX listed license

Throws:

InvalidSPDXAnalysisException

getSpdxListedLicenseIds

public String[] getSpdxListedLicenseIds()

Returns:

Array of all SPDX listed license IDs

getLicenseListVersion

public String getLicenseListVersion()

Returns:

The version of the loaded license list in the form M.N, where M is the major release and N is the minor release. If no license list is loaded, returns .

getListedLicenseById

public SpdxListedLicense getListedLicenseById(String licenseId)
                                       throws InvalidSPDXAnalysisException

Parameters:

licenseId - SPDX Listed License ID

Returns:

SPDX listed license

Throws:

InvalidSPDXAnalysisException

getLicenseFromStdLicModel

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

Get or create a standard license in the model container copying any relevant information from the standard model to the model in the modelContainer

Parameters:

modelContainer -

node -

Returns:

Throws:

InvalidSPDXAnalysisException

getDocumentNamespace

public String getDocumentNamespace()

Specified by:

getDocumentNamespace in interface IModelContainer

Returns:

Namespace for document

getNextSpdxElementRef

public String getNextSpdxElementRef()

Specified by:

getNextSpdxElementRef in interface IModelContainer

Returns:

The next available SPDX element reference ID. The ID is unique within a given model.

spdxElementRefExists

public boolean spdxElementRefExists(String elementRef)

Description copied from interface: IModelContainer

Returns true if the element reference already exists in the model

Specified by:

spdxElementRefExists in interface IModelContainer

Returns:

addSpdxElementRef

public void addSpdxElementRef(String elementRef)

Description copied from interface: IModelContainer

Notifies the model container that a new element ref is in use. This must be called for all new element references to prevent duplication of elements.

Specified by:

addSpdxElementRef in interface IModelContainer

documentNamespaceToId

public String documentNamespaceToId(String externalNamespace)

Description copied from interface: IModelContainer

Translate an external document namespace URI to an external document ID

Specified by:

documentNamespaceToId in interface IModelContainer

Returns:

externalDocumentIdToNamespace

public String externalDocumentIdToNamespace(String docId)

Description copied from interface: IModelContainer

Translate an external document ID to the external document's namespace

Specified by:

externalDocumentIdToNamespace in interface IModelContainer

Returns:

createResource

public org.apache.jena.rdf.model.Resource createResource(org.apache.jena.rdf.model.Resource duplicate,
                                                         String uri,
                                                         org.apache.jena.rdf.model.Resource type,
                                                         IRdfModel modelObject)

Description copied from interface: IModelContainer

Create a resource in the model

Specified by:

createResource in interface IModelContainer

Parameters:

duplicate - A duplicate resource who's node and resource should be returned

uri - If not null, the URI for the resource - if null, an anonomous resource will be used

type - Type of the resource

modelObject - the object representing this node

Returns:

addCheckNodeObject

public boolean addCheckNodeObject(org.apache.jena.graph.Node node,
                                  IRdfModel rdfModelObject)

Description copied from interface: IModelContainer

Add a node object to the container. This is for containers which keep track of which object are related to which nodes

Specified by:

addCheckNodeObject in interface IModelContainer

Returns:

true if there are multiple objects for this node