Class JsonLDStore

java.lang.Object

org.spdx.storage.simple.ExtendedSpdxStore

org.spdx.v3jsonldstore.JsonLDStore

All Implemented Interfaces:

AutoCloseable, IModelStore, ISerializableModelStore

public class JsonLDStore
extends ExtendedSpdxStore
implements ISerializableModelStore

Serializable store which reads and writes the SPDX Spec version 3 JSON-LD format See the SPDX specification for details on the JSON-LD serialization: https://github.com/spdx/spdx-spec/blob/develop/docs/serializations.md For more information on SPDX document mapping to JSON-LD, see: https://github.com/spdx/spdx-3-model/blob/develop/serialization/jsonld.md

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
JsonLDStore(IModelStore baseStore)	Constructs a JsonLDStore with the specified base store
JsonLDStore(IModelStore baseStore, boolean pretty)	Constructs a JsonLDStore with the specified base store and pretty format option

Method Summary

Modifier and Type	Method	Description
org.spdx.library.model.v3_0_1.core.SpdxDocument	deSerialize(InputStream stream, boolean overwrite)
boolean	getPretty()	Check the pretty format option for JSON LD output
void	serialize(OutputStream stream)
void	serialize(OutputStream stream, CoreModelObject objectToSerialize)
void	setPretty(boolean pretty)	Sets the pretty format option for JSON LD output
void	setUseExternalListedElements(boolean useExternalListedElements)	Sets whether to use external listed elements

Methods inherited from class org.spdx.storage.simple.ExtendedSpdxStore

addValueToCollection, clear, clearValueCollection, close, collectionContains, collectionSize, create, delete, enterCriticalSection, exists, getAllItems, getCaseSensitiveId, getIdType, getNextId, getPropertyValueDescriptors, getTypedValue, getValue, isAnon, isCollectionMembersAssignableTo, isCollectionProperty, isPropertyValueAssignableTo, leaveCriticalSection, listValues, removeProperty, removeValueFromCollection, setValue

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

Methods inherited from interface org.spdx.storage.IModelStore

addValueToCollection, clearValueCollection, collectionContains, collectionSize, create, delete, enterCriticalSection, exists, getAllItems, getCaseSensisitiveId, getCaseSensitiveId, getIdType, getNextId, getPropertyValueDescriptors, getTypedValue, getValue, isAnon, isCollectionMembersAssignableTo, isCollectionProperty, isPropertyValueAssignableTo, leaveCriticalSection, listValues, removeProperty, removeValueFromCollection, setValue

Constructor Details

JsonLDStore

public JsonLDStore(IModelStore baseStore,
 boolean pretty)

Constructs a JsonLDStore with the specified base store and pretty format option

Parameters:

baseStore - underlying store to use

pretty - if true, use less compact prettier JSON LD format on output

JsonLDStore

public JsonLDStore(IModelStore baseStore)

Constructs a JsonLDStore with the specified base store

Parameters:

baseStore - underlying store to use

Method Details

getPretty

public boolean getPretty()

Check the pretty format option for JSON LD output

Returns:

if true, use less compact prettier JSON LD format on output

setPretty

public void setPretty(boolean pretty)

Sets the pretty format option for JSON LD output

Parameters:

pretty - if true, use less compact prettier JSON LD format on output

serialize

public void serialize(OutputStream stream)
               throws InvalidSPDXAnalysisException,
IOException

Specified by:

serialize in interface ISerializableModelStore

Throws:

InvalidSPDXAnalysisException

IOException

serialize

public void serialize(OutputStream stream,
 @Nullable
 CoreModelObject objectToSerialize)
               throws InvalidSPDXAnalysisException,
IOException

Specified by:

serialize in interface ISerializableModelStore

Throws:

InvalidSPDXAnalysisException

IOException

deSerialize

public org.spdx.library.model.v3_0_1.core.SpdxDocument deSerialize(InputStream stream,
 boolean overwrite)
                                                            throws InvalidSPDXAnalysisException,
IOException

Specified by:

deSerialize in interface ISerializableModelStore

Throws:

InvalidSPDXAnalysisException

IOException

setUseExternalListedElements

public void setUseExternalListedElements(boolean useExternalListedElements)

Sets whether to use external listed elements

Parameters:

useExternalListedElements - if true, don't serialize any listed licenses or exceptions - treat them as external