org.spdx.storage.listedlicense.SpdxListedLicenseModelStore

All Implemented Interfaces:: AutoCloseable, IModelStore, IListedLicenseStore

Direct Known Subclasses:: SpdxListedLicenseLocalStore, SpdxListedLicenseWebStore

public abstract class SpdxListedLicenseModelStore
extends Object
implements IListedLicenseStore

Read-only model store for the SPDX listed licenses License and exception ID's can be case insensitive License information is stored in a LicenseJson file with the ID being Listed License ID License Exception information is stored in an ExceptionJson file with the ID being the Listed Exception ID CrossRef information is stored within the LicenseJson file. Id's are anonymous and generated.

Author:: Gary O'Neall

Nested Class Summary

Nested classes/interfaces inherited from interface org.spdx.storage.IModelStore
IModelStore.IdType, IModelStore.IModelStoreLock, IModelStore.ModelUpdate
Constructor Summary

Constructors

Constructor Description

SpdxListedLicenseModelStore()

Method Summary

Modifier and Type	Method	Description
`boolean`	`addValueToCollection(String documentUri, String id, String propertyName, Object value)`	Adds a value to a property collection creating the propertyName if it does not exist
`void`	`clearValueCollection(String documentUri, String id, String propertyName)`	Sets the value collection for the property to an empty collection creating the propertyName if it does not exist
`boolean`	`collectionContains(String documentUri, String id, String propertyName, Object value)`
`int`	`collectionSize(String documentUri, String id, String propertyName)`
`void`	`create(String documentUri, String id, String type)`	Create a new object with ID
`void`	`delete(String documentUri, String id)`	Deletes an item from the document
`IModelStore.IModelStoreLock`	`enterCriticalSection(String documentUri, boolean readLockRequested)`	Enter a critical section.
`boolean`	`exists(String documentUri, String id)`
`Stream<TypedValue>`	`getAllItems(String documentUri, String typeFilter)`
`Optional<String>`	`getCaseSensisitiveId(String documentUri, String caseInsensisitiveId)`	In SPDX 2.2 license refs are allowed to be matched case insensitive.
`List<String>`	`getDocumentUris()`
`IModelStore.IdType`	`getIdType(String id)`
`String`	`getLicenseListVersion()`
`String`	`getNextId(IModelStore.IdType idType, String documentUri)`	Generate a unique ID for use within the document
`List<String>`	`getPropertyValueNames(String documentUri, String id)`
`List<String>`	`getSpdxListedExceptionIds()`
`List<String>`	`getSpdxListedLicenseIds()`
`Optional<TypedValue>`	`getTypedValue(String documentUri, String id)`
`Optional<Object>`	`getValue(String documentUri, String id, String propertyName)`
`boolean`	`isCollectionMembersAssignableTo(String documentUri, String id, String propertyName, Class<?> clazz)`
`boolean`	`isCollectionProperty(String documentUri, String id, String propertyName)`
`boolean`	`isPropertyValueAssignableTo(String documentUri, String id, String propertyName, Class<?> clazz)`
`boolean`	`isSpdxListedExceptionId(String listedLicenseDocumentUri, String exceptionId)`
`boolean`	`isSpdxListedLicenseId(String listedLicenseDocumentUri, String licenseId)`
`void`	`leaveCriticalSection(IModelStore.IModelStoreLock lock)`	Leave a critical section.
`Optional<String>`	`listedExceptionIdCaseSensitive(String exceptionId)`
`Optional<String>`	`listedLicenseIdCaseSensitive(String licenseId)`
`Iterator<Object>`	`listValues(String documentUri, String id, String propertyName)`
`void`	`removeProperty(String documentUri, String id, String propertyName)`	Removes a property from the document for the given ID if the property exists.
`boolean`	`removeValueFromCollection(String documentUri, String id, String propertyName, Object value)`	Removes a value from a collection of values associated with a property
`void`	`setValue(String documentUri, String id, String propertyName, Object value)`	Sets a property value for a String or Boolean type of value creating the propertyName if it does not exist

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Details
- SpdxListedLicenseModelStore
  
  public SpdxListedLicenseModelStore() throws InvalidSPDXAnalysisException
  
  Throws:
  
  InvalidSPDXAnalysisException
Method Details
- exists
  
  public boolean exists(String documentUri, String id)
  
  Specified by:
  
  exists in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  Returns:
  
  true if the id already exists for the document
- create
  
  public void create(String documentUri, String id, String type) throws InvalidSPDXAnalysisException
  
  Description copied from interface: IModelStore
  
  Create a new object with ID
  
  Specified by:
  
  create in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  type - SPDX model type as defined in the CLASS constants in SpdxConstants
  
  Throws:
  
  InvalidSPDXAnalysisException
- getPropertyValueNames
  
  public List<String> getPropertyValueNames(String documentUri, String id) throws InvalidSPDXAnalysisException
  
  Specified by:
  
  getPropertyValueNames in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  Returns:
  
  Property names for all properties having a value for a given id within a document
  
  Throws:
  
  InvalidSPDXAnalysisException
- setValue
  
  public void setValue(String documentUri, String id, String propertyName, Object value) throws InvalidSPDXAnalysisException
  
  Description copied from interface: IModelStore
  
  Sets a property value for a String or Boolean type of value creating the propertyName if it does not exist
  
  Specified by:
  
  setValue in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  propertyName - Name of the property
  
  value - value to set
  
  Throws:
  
  InvalidSPDXAnalysisException
- clearValueCollection
  
  public void clearValueCollection(String documentUri, String id, String propertyName) throws InvalidSPDXAnalysisException
  
  Description copied from interface: IModelStore
  
  Sets the value collection for the property to an empty collection creating the propertyName if it does not exist
  
  Specified by:
  
  clearValueCollection in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  propertyName - Name of the property
  
  Throws:
  
  InvalidSPDXAnalysisException
- addValueToCollection
  
  public boolean addValueToCollection(String documentUri, String id, String propertyName, Object value) throws InvalidSPDXAnalysisException
  
  Description copied from interface: IModelStore
  
  Adds a value to a property collection creating the propertyName if it does not exist
  
  Specified by:
  
  addValueToCollection in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  propertyName - Name of the property
  
  value - value to add
  
  Returns:
  
  true if the collection was modified
  
  Throws:
  
  InvalidSPDXAnalysisException
- removeValueFromCollection
  
  public boolean removeValueFromCollection(String documentUri, String id, String propertyName, Object value) throws InvalidSPDXAnalysisException
  
  Description copied from interface: IModelStore
  
  Removes a value from a collection of values associated with a property
  
  Specified by:
  
  removeValueFromCollection in interface IModelStore
  
  Parameters:
  
  documentUri - Unique document URI
  
  id - ID of the item to associate the property with
  
  propertyName - name of the property
  
  value - Value to be removed
  
  Returns:
  
  Throws:
  
  InvalidSPDXAnalysisException
- listValues
  
  public Iterator<Object> listValues(String documentUri, String id, String propertyName) throws InvalidSPDXAnalysisException
  
  Specified by:
  
  listValues in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  propertyName - Name of the property
  
  Returns:
  
  Iterator over the list of values associated with the id, propertyName and document
  
  Throws:
  
  InvalidSPDXAnalysisException
- getValue
  
  public Optional<Object> getValue(String documentUri, String id, String propertyName) throws InvalidSPDXAnalysisException
  
  Specified by:
  
  getValue in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  propertyName - Name of the property
  
  Returns:
  
  the single value associated with the id, propertyName and document
  
  Throws:
  
  InvalidSPDXAnalysisException
- getNextId
  
  public String getNextId(IModelStore.IdType idType, String documentUri) throws InvalidSPDXAnalysisException
  
  Description copied from interface: IModelStore
  
  Generate a unique ID for use within the document
  
  Specified by:
  
  getNextId in interface IModelStore
  
  Parameters:
  
  idType - Type of ID
  
  documentUri - the SPDX Document URI
  
  Returns:
  
  next available unique ID for the specific idType
  
  Throws:
  
  InvalidSPDXAnalysisException
- getSpdxListedLicenseIds
  
  public List<String> getSpdxListedLicenseIds()
  
  Specified by:
  
  getSpdxListedLicenseIds in interface IListedLicenseStore
  
  Returns:
  
  List of all SPDX listed license IDs
- getLicenseListVersion
  
  public String getLicenseListVersion()
  
  Specified by:
  
  getLicenseListVersion in interface IListedLicenseStore
  
  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.
- getSpdxListedExceptionIds
  
  public List<String> getSpdxListedExceptionIds()
  
  Specified by:
  
  getSpdxListedExceptionIds in interface IListedLicenseStore
  
  Returns:
  
  list of SPDX exception IDs
- isSpdxListedLicenseId
  
  public boolean isSpdxListedLicenseId(String listedLicenseDocumentUri, String licenseId)
  
  Specified by:
  
  isSpdxListedLicenseId in interface IListedLicenseStore
  
  Parameters:
  
  listedLicenseDocumentUri -
  
  licenseId -
  
  Returns:
  
  true if the licenseId belongs to an SPDX listed license
- isSpdxListedExceptionId
  
  public boolean isSpdxListedExceptionId(String listedLicenseDocumentUri, String exceptionId)
  
  Specified by:
  
  isSpdxListedExceptionId in interface IListedLicenseStore
  
  Parameters:
  
  listedLicenseDocumentUri -
  
  exceptionId -
  
  Returns:
  
  true if the exceptionId belongs to an SPDX listed exception
- getTypedValue
  
  public Optional<TypedValue> getTypedValue(String documentUri, String id) throws InvalidSPDXAnalysisException
  
  Specified by:
  
  getTypedValue in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  Returns:
  
  type TypedValue containing the type of the ModelObject related to the ID
  
  Throws:
  
  InvalidSPDXAnalysisException
- removeProperty
  
  public void removeProperty(String documentUri, String id, String propertyName) throws InvalidSPDXAnalysisException
  
  Description copied from interface: IModelStore
  
  Removes a property from the document for the given ID if the property exists. Does not raise any exception if the propertyName does not exist
  
  Specified by:
  
  removeProperty in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  propertyName - Name of the property
  
  Throws:
  
  InvalidSPDXAnalysisException
- getDocumentUris
  
  public List<String> getDocumentUris()
  
  Specified by:
  
  getDocumentUris in interface IModelStore
  
  Returns:
  
  a list of all Document URI's stored in the model store
- getAllItems
  
  public Stream<TypedValue> getAllItems(String documentUri, @Nullable String typeFilter) throws InvalidSPDXAnalysisException
  
  Specified by:
  
  getAllItems in interface IModelStore
  
  Parameters:
  
  documentUri - SPDX Document URI for a document associated with this model
  
  typeFilter - Optional parameter to specify the type of objects to be retrieved
  
  Returns:
  
  Stream of all items store within the document
  
  Throws:
  
  InvalidSPDXAnalysisException
- collectionSize
  
  public int collectionSize(String documentUri, String id, String propertyName) throws InvalidSPDXAnalysisException
  
  Specified by:
  
  collectionSize in interface IModelStore
  
  Parameters:
  
  documentUri - Unique document URI
  
  id - ID of the item to associate the property with
  
  propertyName - name of the property
  
  Returns:
  
  size of a collection associated with a property. 0 if the property does not exist.
  
  Throws:
  
  InvalidSPDXAnalysisException
- collectionContains
  
  public boolean collectionContains(String documentUri, String id, String propertyName, Object value) throws InvalidSPDXAnalysisException
  
  Specified by:
  
  collectionContains in interface IModelStore
  
  Parameters:
  
  documentUri - Unique document URI
  
  id - ID of the item to associate the property with
  
  propertyName - name of the property
  
  Returns:
  
  true if the collection associated with a property contains the value
  
  Throws:
  
  InvalidSPDXAnalysisException
- isCollectionMembersAssignableTo
  
  public boolean isCollectionMembersAssignableTo(String documentUri, String id, String propertyName, Class<?> clazz) throws InvalidSPDXAnalysisException
  
  Specified by:
  
  isCollectionMembersAssignableTo in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  propertyName - Name of the property
  
  clazz - Class to test compatibility with
  
  Returns:
  
  true if all members of a collection associated with the id and propertyName can be assigned to the clazz
  
  Throws:
  
  InvalidSPDXAnalysisException
- isPropertyValueAssignableTo
  
  public boolean isPropertyValueAssignableTo(String documentUri, String id, String propertyName, Class<?> clazz) throws InvalidSPDXAnalysisException
  
  Specified by:
  
  isPropertyValueAssignableTo in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  propertyName - Name of the property
  
  clazz - Class to test compatibility with
  
  Returns:
  
  true if the value associated with the id and propertyName can be assigned to the clazz
  
  Throws:
  
  InvalidSPDXAnalysisException
- isCollectionProperty
  
  public boolean isCollectionProperty(String documentUri, String id, String propertyName) throws InvalidSPDXAnalysisException
  
  Specified by:
  
  isCollectionProperty in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  propertyName - Name of the property
  
  Returns:
  
  true if the propertyName represents multiple values
  
  Throws:
  
  InvalidSPDXAnalysisException
- getIdType
  
  public IModelStore.IdType getIdType(String id)
  
  Specified by:
  
  getIdType in interface IModelStore
  
  Returns:
  
  The type of ID based on the string format
- enterCriticalSection
  
  public IModelStore.IModelStoreLock enterCriticalSection(String documentUri, boolean readLockRequested)
  
  Description copied from interface: IModelStore
  
  Enter a critical section. leaveCriticialSection must be called.
  
  Specified by:
  
  enterCriticalSection in interface IModelStore
  
  readLockRequested - true implies a read lock, false implies write lock.
- leaveCriticalSection
  
  public void leaveCriticalSection(IModelStore.IModelStoreLock lock)
  
  Description copied from interface: IModelStore
  
  Leave a critical section. Releases the lock form the matching enterCriticalSection
  
  Specified by:
  
  leaveCriticalSection in interface IModelStore
- listedLicenseIdCaseSensitive
  
  public Optional<String> listedLicenseIdCaseSensitive(String licenseId)
  
  Specified by:
  
  listedLicenseIdCaseSensitive in interface IListedLicenseStore
  
  Parameters:
  
  licenseId - case insensitive license ID
  
  Returns:
  
  the case sensitive license ID
- listedExceptionIdCaseSensitive
  
  public Optional<String> listedExceptionIdCaseSensitive(String exceptionId)
  
  Specified by:
  
  listedExceptionIdCaseSensitive in interface IListedLicenseStore
  
  Parameters:
  
  exceptionId - case insensitive exception ID
  
  Returns:
  
  case sensitive ID
- getCaseSensisitiveId
  
  public Optional<String> getCaseSensisitiveId(String documentUri, String caseInsensisitiveId)
  
  Description copied from interface: IModelStore
  
  In SPDX 2.2 license refs are allowed to be matched case insensitive. This function will return the case sensitivie ID (e.g. if you have LicenseRef-ABC, calling this function with licenseref-abc will return LicenseRef-ABC
  
  Specified by:
  
  getCaseSensisitiveId in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  Returns:
  
  the case sensitive ID if it exists
- delete
  
  public void delete(String documentUri, String id) throws InvalidSPDXAnalysisException
  
  Description copied from interface: IModelStore
  
  Deletes an item from the document
  
  Specified by:
  
  delete in interface IModelStore
  
  Parameters:
  
  documentUri - the SPDX Document URI
  
  id - unique ID within the SPDX document
  
  Throws:
  
  InvalidSPDXAnalysisException

Class SpdxListedLicenseModelStore

Nested Class Summary

Nested classes/interfaces inherited from interface org.spdx.storage.IModelStore

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Constructor Details

Method Details