Package org.spdx.library

Class Read

java.lang.Object

org.spdx.library.Read

public class Read
extends Object

Supports reading SPDX documents from an existing ModelStore 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Read.Document

Constructor Summary

Constructors

Constructor	Description
Read()

Method Summary

Modifier and Type	Method	Description
static Stream<? extends ModelObject>	getAllItems(IModelStore modelStore, String documentUri, String typeFilter)
static Stream<SpdxPackage>	getAllPackages(IModelStore modelStore, String documentUri)
static void	serialize(ISerializableModelStore modelStore, String documentUri, OutputStream stream)	Serializes an SPDX document stored in the modelStore.
static void	writeToFile(ISerializableModelStore modelStore, String documentUri, Path filePath)	Write the SPDX document stored in the modelStore to a file

Methods inherited from class java.lang.Object

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

Constructor Details

Read

public Read()

Method Details

serialize

public static void serialize(ISerializableModelStore modelStore, String documentUri, OutputStream stream) throws InvalidSPDXAnalysisException, IOException

Serializes an SPDX document stored in the modelStore. The specific format of the serialization will depend on the modelStore.

Parameters:

modelStore - Storage for the model objects

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

stream - Output stream for serialization

Throws:

InvalidSPDXAnalysisException

IOException

writeToFile

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

Write the SPDX document stored in the modelStore to a file

Parameters:

modelStore - Storage for the model objects

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

filePath - File path to output the file

Throws:

InvalidSPDXAnalysisException

IOException

getAllItems

public static Stream<? extends ModelObject> getAllItems(IModelStore modelStore, String documentUri, String typeFilter) throws InvalidSPDXAnalysisException

Parameters:

modelStore - Storage for the model objects

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

getAllPackages

public static Stream<SpdxPackage> getAllPackages(IModelStore modelStore, String documentUri) throws InvalidSPDXAnalysisException

Parameters:

modelStore - Storage for the model objects

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

Returns:

All packages stored for the document in the model store

Throws:

InvalidSPDXAnalysisException