Package org.spdx.library

Class Write

java.lang.Object

org.spdx.library.Write

public class Write
extends Object

Static class to provide write operations to the model. Some design and some implementation borrowed from Yevster's spdxtra project under the Apache 2.0 license http://yevster.github.io/spdxtra/

Author:

Gary O'Neall

Constructor Summary

Constructors

Constructor	Description
Write()

Method Summary

Modifier and Type	Method	Description
static void	applyUpdatesInOneTransaction(String documentUri, IModelStore modelStore, Iterable<? extends IModelStore.ModelUpdate> updates)	Apply a set of model updates in a single transaction.
static void	applyUpdatesInOneTransaction(String documentUri, IModelStore modelStore, IModelStore.ModelUpdate... updates)	Convenience method for applying a small set of updates.
static void	deSerialize(ISerializableModelStore modelStore, String documentUri, InputStream stream)	Deserialize a model store from an input stream.
static void	readFile(ISerializableModelStore modelStore, String documentUri, Path filePath)	Reads a file into a model store

Methods inherited from class java.lang.Object

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

Constructor Details

Write

public Write()

Method Details

applyUpdatesInOneTransaction

public static void applyUpdatesInOneTransaction(String documentUri,
 IModelStore modelStore,
 IModelStore.ModelUpdate... updates)
                                         throws InvalidSPDXAnalysisException,
IOException

Convenience method for applying a small set of updates.

Parameters:

modelStore - Storage for the model objects

updates - Updates to be applied in a single transaction

Throws:

IOException

InvalidSPDXAnalysisException

applyUpdatesInOneTransaction

public static void applyUpdatesInOneTransaction(String documentUri,
 IModelStore modelStore,
 Iterable<? extends IModelStore.ModelUpdate> updates)
                                         throws InvalidSPDXAnalysisException,
IOException

Apply a set of model updates in a single transaction. Updates can be gather from the SpdxModelFactory or the model objects themselves from the update methods

Parameters:

modelStore - Storage for the model objects

updates - Updates to be applied in a single transaction

Throws:

InvalidSPDXAnalysisException

IOException

deSerialize

public static void deSerialize(ISerializableModelStore modelStore,
 String documentUri,
 InputStream stream)
                        throws InvalidSPDXAnalysisException,
IOException

Deserialize a model store from an input stream. The format of the input stream dependes on the Model Store implementation

Parameters:

modelStore - Storage for the model objects

documentUri - SPDX Document URI for a document associated with this model

stream - Input stream to deserialize the data

Throws:

InvalidSPDXAnalysisException

IOException

readFile

public static void readFile(ISerializableModelStore modelStore,
 String documentUri,
 Path filePath)
                     throws InvalidSPDXAnalysisException,
IOException

Reads a file into a model store

Parameters:

modelStore -

documentUri -

filePath -

Throws:

InvalidSPDXAnalysisException

IOException