Uses of Interface
org.spdx.storage.IModelStore

Packages that use IModelStore

Package	Description
org.spdx.library	Package containing useful library functions for reading, writing, and manipulating SPDX documents.
org.spdx.library.model	Copyright (c) 2019 Source Auditor Inc.
org.spdx.library.model.license
org.spdx.library.model.pointer	RDF model classes which implement the proposed W3C Pointer classes.
org.spdx.storage	Contains classes that implement the storage interfaces for reading and writing SPDX document properties.
org.spdx.storage.listedlicense
org.spdx.storage.simple
org.spdx.utility.verificationcode

Uses of IModelStore in org.spdx.library

Methods in org.spdx.library that return IModelStore

Modifier and Type	Method	Description
static IModelStore	DefaultModelStore.getDefaultModelStore()

Methods in org.spdx.library with parameters of type IModelStore

Modifier and Type	Method	Description
static void	Write.applyUpdatesInOneTransaction(String documentUri, IModelStore modelStore, Iterable<? extends IModelStore.ModelUpdate> updates)	Apply a set of model updates in a single transaction.
static void	Write.applyUpdatesInOneTransaction(String documentUri, IModelStore modelStore, IModelStore.ModelUpdate... updates)	Convenience method for applying a small set of updates.
void	ModelCopyManager.copy(IModelStore toStore, String toDocumentUri, String toId, IModelStore fromStore, String fromDocumentUri, String fromId, String type)	Copy an item from one Model Object Store to another
void	ModelCopyManager.copy(IModelStore toStore, String toDocumentUri, String toId, IModelStore fromStore, String fromDocumentUri, String fromId, String type, boolean excludeLicenseDetails)	Copy an item from one Model Object Store to another
TypedValue	ModelCopyManager.copy(IModelStore toStore, String toDocumentUri, IModelStore fromStore, String fromDocumentUri, String sourceId, String type)	Copy an item from one Model Object Store to another using the source ID for the target unless it is anonymous
TypedValue	ModelCopyManager.copy(IModelStore toStore, String toDocumentUri, IModelStore fromStore, String fromDocumentUri, String sourceId, String type, boolean excludeLicenseDetails)	Copy an item from one Model Object Store to another using the source ID for the target unless it is anonymous
static boolean	Read.Document.documentExists(IModelStore modelStore, String documentUri)
static List<SpdxDocument>	Read.Document.get(IModelStore modelStore)	Obtains the SPDX Documents described in the provided model store.
static SpdxDocument	Read.Document.get(IModelStore modelStore, String documentUri)
static Stream<? extends ModelObject>	Read.getAllItems(IModelStore modelStore, String documentUri, String typeFilter)
static Stream<SpdxPackage>	Read.getAllPackages(IModelStore modelStore, String documentUri)
String	ModelCopyManager.getCopiedId(IModelStore fromStore, String fromDocumentUri, String fromId, IModelStore toStore, String toDocumentUri)
String	ModelCopyManager.putCopiedId(IModelStore fromStore, String fromDocumentUri, String fromId, IModelStore toStore, String toDocumentUri, String toId)	Record a copied ID between model stores
static final void	DefaultModelStore.reset(IModelStore newModelStore, String newDefaultDocumentUri, ModelCopyManager newDefaultCopyManager)

Uses of IModelStore in org.spdx.library.model

Methods in org.spdx.library.model that return IModelStore

Modifier and Type	Method	Description
IModelStore	ModelCollection.getModelStore()
IModelStore	ModelObject.getModelStore()

Methods in org.spdx.library.model with parameters of type IModelStore

Modifier and Type	Method	Description
protected static void	ModelObject.addValueToCollection(IModelStore stModelStore, String stDocumentUri, String stId, String propertyName, Object value, ModelCopyManager copyManager)	Add a value to a collection of values associated with a property.
protected static void	ModelObject.clearValueCollection(IModelStore stModelStore, String stDocumentUri, String stId, String propertyName)	Clears a collection of values associated with a property creating the property if it does not exist
ModelObject	ModelObject.clone(IModelStore modelStore)	Clone a new object using a different model store
static Checksum	Checksum.create(IModelStore modelStore, String documentUri, ChecksumAlgorithm algorithm, String value)	Create a checksum with an anonymous ID
static ModelObject	SpdxModelFactory.createModelObject(IModelStore modelStore, String documentUri, String id, String type, ModelCopyManager copyManager)	Create a model object in a model store given the document URI, ID and type
static SpdxDocument	SpdxModelFactory.createSpdxDocument(IModelStore modelStore, String documentUri, ModelCopyManager copyManager)	Create an SPDX document with default values for creator, created, licenseListVersion, data license and specVersion
static String	ExternalSpdxElement.externalDocumentIdToNamespace(String externalDocumentId, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)
static String	ExternalSpdxElement.externalSpdxElementIdToURI(String externalSpdxElementId, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)
static Stream<?>	SpdxModelFactory.getElements(IModelStore store, String documentUri, ModelCopyManager copyManager, Class<?> spdxClass)
static Optional<ExternalDocumentRef>	ExternalDocumentRef.getExternalDocRefByDocNamespace(IModelStore stModelStore, String stDocumentUri, String externalDocUri, ModelCopyManager copyManager)	Obtain an ExternalDocumentRef which maps to the document URI for the external SPDX document.
static ModelObject	SpdxModelFactory.getModelObject(IModelStore modelStore, String documentUri, String id, String type, ModelCopyManager copyManager, boolean create)	Create a model object in a model store given the document URI, ID and type
static Optional<ModelObject>	SpdxModelFactory.getModelObject(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager)
protected static Optional<Object>	ModelObject.getObjectPropertyValue(IModelStore stModelStore, String stDocumentUri, String stId, String propertyName, ModelCopyManager copyManager)	Get an object value for a property
static Object	ModelStorageClassConverter.modelObjectToStoredObject(Object value, String stDocumentUri, IModelStore stModelStore, ModelCopyManager copyManager)	Converts a stored object to it's appropriate model object type
static Optional<Object>	ModelStorageClassConverter.optionalStoredObjectToModelObject(Optional<Object> value, String stDocumentUri, IModelStore stModelStore, ModelCopyManager copyManager)	Converts any typed value or IndividualValue objects to a ModelObject, returning an existing ModelObject if it exists or creates a new ModelObject
protected static void	ModelObject.removeProperty(IModelStore stModelStore, String stDocumentUri, String stId, String propertyName)	Removes a property and its value from the model store if it exists
protected static void	ModelObject.removePropertyValueFromCollection(IModelStore stModelStore, String stDocumentUri, String stId, String propertyName, Object value)	Remove a property value from a collection
protected static void	ModelObject.replacePropertyValueCollection(IModelStore stModelStore, String stDocumentUri, String stId, String propertyName, Collection<?> values, ModelCopyManager copyManager)	Replace the entire value collection for a property.
protected static void	ModelObject.setPropertyValue(IModelStore stModelStore, String stDocumentUri, String stId, String propertyName, Object value, ModelCopyManager copyManager)	Set a property value for a property name, creating the property if necessary
static Object	ModelStorageClassConverter.storedObjectToModelObject(Object value, String documentUri, IModelStore modelStore, ModelCopyManager copyManager)	Converts any typed value or individual value objects to a ModelObject, returning an existing ModelObject if it exists or creates a new ModelObject
Object	SimpleUriValue.toModelObject(IModelStore store, String documentUri, ModelCopyManager copyManager)	inflate the value back to either an Enum (if the URI matches), an ExternalSpdxElement if it matches the pattern of an external SPDX element or returns itself otherwise
static ExternalSpdxElement	ExternalSpdxElement.uriToExternalSpdxElement(String uri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)	Create an ExternalSpdxElement based on a URI of the form externaldocumentnamespace#SPDXRef-[NUM]
static String	ExternalSpdxElement.uriToExternalSpdxElementId(String uri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)	Convert a URI to an ID for an External SPDX Element

Constructors in org.spdx.library.model with parameters of type IModelStore

Modifier	Constructor	Description
	Annotation(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	Checksum(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	ExternalDocumentRef(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	ExternalRef(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	ExternalSpdxElement(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	GenericModelObject(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	GenericSpdxElement(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	GenericSpdxItem(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	ModelCollection(IModelStore modelStore, String documentUri, String id, String propertyName, ModelCopyManager copyManager, Class<?> type)
	ModelObject(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	ModelSet(IModelStore modelStore, String documentUri, String id, String propertyName, ModelCopyManager copyManager, Class<?> type)
	Relationship(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	SpdxConstantElement(IModelStore modelStore, String documentUri, String id)
	SpdxCreatorInformation(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	SpdxDocument(IModelStore modelStore, String documentUri, ModelCopyManager copyManager, boolean create)
	SpdxElement(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	SpdxFile(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	SpdxFileBuilder(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, String name, AnyLicenseInfo concludedLicense, Collection<AnyLicenseInfo> licenseInfosFromFile, String copyrightText, Checksum sha1)	Build a file with the required parameters
	SpdxItem(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	SpdxNoAssertionElement(IModelStore modelStore, String documentUri)
	SpdxNoneElement(IModelStore modelStore, String documentUri)
	SpdxPackage(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	SpdxPackageBuilder(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, String name, AnyLicenseInfo concludedLicense, String copyrightText, AnyLicenseInfo licenseDeclared)	Build an SpdxPackage with the required parameters if isFilesAnalyzed is false - note isFilesAnalyzed must be explicitly set to false
	SpdxPackageVerificationCode(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	SpdxSnippet(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	SpdxSnippetBuilder(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, String name, AnyLicenseInfo concludedLicense, Collection<AnyLicenseInfo> licenseInfosFromFile, String copyrightText, SpdxFile snippetFromFile, int startByte, int endByte)	Build a snippet with the required parameters

Uses of IModelStore in org.spdx.library.model.license

Methods in org.spdx.library.model.license that return IModelStore

Modifier and Type	Method	Description
IModelStore	ListedLicenses.getLicenseModelStore()

Methods in org.spdx.library.model.license with parameters of type IModelStore

Modifier and Type	Method	Description
static String	ExternalExtractedLicenseInfo.externalExtractedLicenseIdToURI(String externalExtractedLicenseId, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)
static AnyLicenseInfo	LicenseInfoFactory.parseSPDXLicenseString(String licenseString, IModelStore store, String documentUri, ModelCopyManager copyManager)	Parses a license string and converts it into a SPDXLicenseInfo object Syntax - A license set must start and end with a parenthesis "(" A conjunctive license set will have and AND after the first licenseInfo term A disjunctive license set will have an OR after the first licenseInfo term If there is no And or Or, then it is converted to a simple license type A space or tab must be used between license ID's and the keywords AND and OR A licenseID must NOT be "AND" or "OR"
static ExternalExtractedLicenseInfo	ExternalExtractedLicenseInfo.uriToExternalExtractedLicense(String externalLicenseUri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)
static String	ExternalExtractedLicenseInfo.uriToExternalExtractedLicenseId(String uri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)	Convert a URI to an ID for an External Extracted License

Constructors in org.spdx.library.model.license with parameters of type IModelStore

Modifier	Constructor	Description
	AbstractExtractedLicenseInfo(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)	Create a new ExtractedLicenseInfo object
	ConjunctiveLicenseSet(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	CrossRef(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	CrossRefBuilder(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, String url)	Create a CrossRef with the required parameters
	DisjunctiveLicenseSet(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	ExternalExtractedLicenseInfo(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	ExtractedLicenseInfo(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)	Create a new ExtractedLicenseInfo object
	LicenseException(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)	Create a new LicenseException object
	ListedLicenseException(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	OrLaterOperator(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	SpdxListedLicense(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)	Create a new SPDX Listed License object
	SpdxNoAssertionLicense(IModelStore modelStore, String documentUri)
	SpdxNoneLicense(IModelStore modelStore, String documentUri)
	WithExceptionOperator(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)

Uses of IModelStore in org.spdx.library.model.pointer

Constructors in org.spdx.library.model.pointer with parameters of type IModelStore

Modifier	Constructor	Description
	ByteOffsetPointer(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	CompoundPointer(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	LineCharPointer(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	SinglePointer(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)
	StartEndPointer(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)

Uses of IModelStore in org.spdx.storage

Subinterfaces of IModelStore in org.spdx.storage

Modifier and Type	Interface	Description
interface	ISerializableModelStore	A model store that can be serialized and de-serialized to and from a Stream

Uses of IModelStore in org.spdx.storage.listedlicense

Subinterfaces of IModelStore in org.spdx.storage.listedlicense

Modifier and Type	Interface	Description
interface	IListedLicenseStore

Classes in org.spdx.storage.listedlicense that implement IModelStore

Modifier and Type	Class	Description
class	SpdxListedLicenseLocalStore
class	SpdxListedLicenseModelStore	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.
class	SpdxListedLicenseWebStore

Uses of IModelStore in org.spdx.storage.simple

Classes in org.spdx.storage.simple that implement IModelStore

Modifier and Type	Class	Description
class	ExtendedSpdxStore	A simple abstract SPDX store that stores everything in an underlying model store which is initialized in the constructor.
class	InMemSpdxStore

Methods in org.spdx.storage.simple with parameters of type IModelStore

Modifier and Type	Method	Description
void	StoredTypedItem.copyValuesFrom(String fromDocumentUri, IModelStore store)	Copy all values for this item from another store

Constructors in org.spdx.storage.simple with parameters of type IModelStore

Modifier	Constructor	Description
	ExtendedSpdxStore(IModelStore baseStore)

Uses of IModelStore in org.spdx.utility.verificationcode

Methods in org.spdx.utility.verificationcode with parameters of type IModelStore

Modifier and Type	Method	Description
SpdxPackageVerificationCode	VerificationCodeGenerator.generatePackageVerificationCode(File sourceDirectory, File[] skippedFiles, IModelStore modelStore, String documentUri)	Generate the SPDX Package Verification Code from a directory of files included in the archive
SpdxPackageVerificationCode	VerificationCodeGenerator.generatePackageVerificationCode(File sourceDirectory, IModelStore modelStore, String documentUri)
protected SpdxPackageVerificationCode	VerificationCodeGenerator.generatePackageVerificationCode(List<String> fileChecksums, String[] skippedFilePaths, IModelStore modelStore, String documentUri)
SpdxPackageVerificationCode	VerificationCodeGenerator.generatePackageVerificationCode(SpdxFile[] spdxFiles, String[] skippedFilePaths, IModelStore modelStore, String documentUri)	Generate the SPDX Package Verification Code from an array of SPDXFiles