Uses of Class
org.spdx.rdfparser.model.SpdxDocument

Packages that use SpdxDocument

Package	Description
org.spdx.compare
org.spdx.html
org.spdx.merge
org.spdx.rdfparser
org.spdx.rdfparser.model	Model for the SPDX 2.0+ specification.
org.spdx.spdxspreadsheet
org.spdx.tag
org.spdx.tools

Uses of SpdxDocument in org.spdx.compare

Fields in org.spdx.compare with type parameters of type SpdxDocument

Modifier and Type	Field and Description
protected Map<SpdxDocument,SpdxItem>	SpdxItemComparer.documentItem Map of SPDX document to Items
protected Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>>	SpdxItemComparer.extractedLicenseIdMap Mapping of all extracted license info ID's between all SPDX documents included in the comparer
protected Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>>	SpdxItemComparer.extractedLicenseIdMap Mapping of all extracted license info ID's between all SPDX documents included in the comparer

Methods in org.spdx.compare that return SpdxDocument

Modifier and Type	Method and Description
SpdxDocument	SpdxComparer.getSpdxDoc(int docIndex)
SpdxDocument[]	SpdxComparer.getSpdxDocuments()

Methods in org.spdx.compare with parameters of type SpdxDocument

Modifier and Type	Method and Description
void	SpdxFileComparer.addDocumentFile(SpdxDocument spdxDocument, SpdxFile spdxFile) Add a file to the comparer and compare to the existing files
void	SpdxItemComparer.addDocumentItem(SpdxDocument spdxDocument, SpdxItem spdxItem) Add a new item to the comparer and compare the contents of the item to all items which have been previously added
void	SpdxPackageComparer.addDocumentPackage(SpdxDocument spdxDocument, SpdxPackage spdxPackage) Add a package to the comparer and performs the comparison to any existing documents
void	SpdxSnippetComparer.addDocumentSnippet(SpdxDocument spdxDocument, SpdxSnippet snippet) Add a snippet to the comparer and performs the comparison to any existing documents
protected SpdxFile[]	SpdxComparer.collectAllFiles(SpdxDocument spdxDocument) Collect all of the files present in the SPDX document including files within documents and files embedded in packages
protected SpdxPackage[]	SpdxComparer.collectAllPackages(SpdxDocument spdxDocument) Collect all of the packages present in the SPDX document including packages embedded in other relationships within documents
void	SpdxComparer.compare(SpdxDocument[] spdxDocuments) Compares multiple SPDX documents
void	SpdxComparer.compare(SpdxDocument spdxDoc1, SpdxDocument spdxDoc2) Compares 2 SPDX documents
SpdxPackage	SpdxPackageComparer.getDocPackage(SpdxDocument document) Return the package associated with the document
SpdxSnippet	SpdxSnippetComparer.getDocSnippet(SpdxDocument spdxDocument)
SpdxExternalRefDifference[]	SpdxPackageComparer.getExternalRefDifferences(SpdxDocument docA, SpdxDocument docB)
SpdxFile	SpdxFileComparer.getFile(SpdxDocument spdxDocument)
SpdxFileDifference	SpdxFileComparer.getFileDifference(SpdxDocument docA, SpdxDocument docB) Return a file difference for the file contained in two different documents
SpdxFileDifference[]	SpdxPackageComparer.getFileDifferences(SpdxDocument docA, SpdxDocument docB) Get any fileDifferences which are in docA but not in docB
SpdxItem	SpdxItemComparer.getItem(SpdxDocument doc) Get the item contained by the document doc
SpdxFileDifference	SpdxSnippetComparer.getSnippetFromFileDifference(SpdxDocument docA, SpdxDocument docB) Get any file difference for the Spdx Snippet From File between the two SPDX documents If the fileName is different, the they are considered unique files and the getUniqueSnippetFromFile should be called to obtain the unique file
Annotation[]	SpdxItemComparer.getUniqueAnnotations(SpdxDocument docA, SpdxDocument docB) Get annotations that are in docA but not in docB
DoapProject[]	SpdxFileComparer.getUniqueArtifactOf(SpdxDocument docA, SpdxDocument docB) Return all artifactOfs which are in the file contained in docA but not in file contained in docB
Checksum[]	SpdxPackageComparer.getUniqueChecksums(SpdxDocument docA, SpdxDocument docB) Get the checksums which are present in document A but not in document B
Checksum[]	SpdxFileComparer.getUniqueChecksums(SpdxDocument docA, SpdxDocument docB) Get the checksums which are present in the file contained document A but not in document B
ExternalRef[]	SpdxPackageComparer.getUniqueExternalRefs(SpdxDocument docA, SpdxDocument docB)
SpdxFile[]	SpdxPackageComparer.getUniqueFiles(SpdxDocument docA, SpdxDocument docB) Return any unique files by name which are in docA but not in docB
Relationship[]	SpdxItemComparer.getUniqueRelationship(SpdxDocument docA, SpdxDocument docB) Get relationships that are in docA but not in docB
AnyLicenseInfo[]	SpdxItemComparer.getUniqueSeenLicenses(SpdxDocument docA, SpdxDocument docB) Get any licenses found in docA but not in docB
SpdxFile	SpdxSnippetComparer.getUniqueSnippetFromFile(SpdxDocument docA, SpdxDocument docB) Get an SpdxFile that only exists in docA but not docB

Constructor parameters in org.spdx.compare with type arguments of type SpdxDocument

Constructor and Description
SpdxFileComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxFileComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxItemComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxItemComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxPackageComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxPackageComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxSnippetComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxSnippetComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)

Uses of SpdxDocument in org.spdx.html

Methods in org.spdx.html with parameters of type SpdxDocument

Modifier and Type	Method and Description
static Map<String,Object>	MustacheMap.buildDocFileMustacheMap(SpdxDocument doc, SpdxFile[] files, Map<String,String> spdxIdToUrl, Map<String,List<SpdxSnippet>> fileIdToSnippets)
static Map<String,Object>	MustacheMap.buildDocMustachMap(SpdxDocument doc, Map<String,String> spdxIdToUrl)
static Map<String,Object>	MustacheMap.buildExtractedLicMustachMap(SpdxDocument doc, Map<String,String> spdxIdToUrl)
static Map<String,Object>	MustacheMap.buildSnippetMustachMap(SpdxDocument doc, Map<String,String> spdxIdToUrl)

Constructors in org.spdx.html with parameters of type SpdxDocument

Constructor and Description
CreatorInfoContext(SpdxDocument doc2)

Uses of SpdxDocument in org.spdx.merge

Methods in org.spdx.merge with parameters of type SpdxDocument

Modifier and Type	Method and Description
AnyLicenseInfo[]	SpdxPackageInfoMerger.checkLicenseFromFile(SpdxDocument doc, SpdxPackage temp) A method to check license from file information through mapLicenseInfo function.
boolean	SpdxLicenseMapper.docInNonStdLicIdMap(SpdxDocument spdxDoc)
Map<AnyLicenseInfo,AnyLicenseInfo>	SpdxLicenseMapper.foundInterMap(SpdxDocument spdxDoc)
AnyLicenseInfo	SpdxLicenseMapper.mapLicenseInfo(SpdxDocument spdxDoc, AnyLicenseInfo license) a method gets a sub SPDX document and licenses from declared licenses in document package.
AnyLicenseInfo	SpdxLicenseMapper.mapNonStdLicInMap(SpdxDocument spdxDoc, AnyLicenseInfo license) a method gets a sub SPDX document and one of its license (non-standard license).
void	SpdxLicenseMapper.mappingExistingNonStdLic(SpdxDocument output, ExtractedLicenseInfo outputDocLicense, SpdxDocument subDocs, ExtractedLicenseInfo subLicense) Maps a subDoc nonstandard license to an existing output document nonstandard license
ExtractedLicenseInfo	SpdxLicenseMapper.mappingNewNonStdLic(SpdxDocument outputDoc, SpdxDocument subDoc, ExtractedLicenseInfo subNonStdLicInfo) Creates a new non-standard license in the outputDoc and creates a mapping between the output document non-standard license and the subDoc non standard license This particular non-standard license is unique to the outputDoc document.
SpdxFile[]	SpdxFileInfoMerger.mergeFileInfo(SpdxDocument[] subDocs)
ExtractedLicenseInfo[]	SpdxLicenseInfoMerger.mergeNonStdLic(SpdxDocument[] subDocs)
SpdxFile	SpdxLicenseMapper.replaceNonStdLicInFile(SpdxDocument spdxDoc, SpdxFile subFileInfo) a method gets a sub SPDX document and its file information.
String	SpdxPackageInfoMerger.translateSubDelcaredLicsIntoComments(SpdxDocument[] subDocs) Deprecated.

Constructors in org.spdx.merge with parameters of type SpdxDocument

Constructor and Description
SpdxFileInfoMerger(SpdxDocument master, SpdxLicenseMapper mapper)
SpdxItemInfoMerger(SpdxItem itemInfoResult2, SpdxDocument[] mergeDocs)
SpdxLicenseInfoMerger(SpdxDocument outputDoc, SpdxLicenseMapper mapper)
SpdxPackageInfoMerger(List<SpdxPackage> masterPackagesInfo, SpdxDocument[] subDocs, SpdxLicenseMapper mapper)

Uses of SpdxDocument in org.spdx.rdfparser

Methods in org.spdx.rdfparser that return SpdxDocument

Modifier and Type	Method and Description
static SpdxDocument	SPDXDocumentFactory.createSpdxDocument(InputStream input, String baseUri, String fileType)
static SpdxDocument	SPDXDocumentFactory.createSpdxDocument(org.apache.jena.rdf.model.Model model) Create a new SPDX Document populating the data from the existing model
static SpdxDocument	SPDXDocumentFactory.createSpdxDocument(String fileNameOrUrl) Create an SPDX Document from a file
SpdxDocument	SpdxDocumentContainer.getSpdxDocument()

Uses of SpdxDocument in org.spdx.rdfparser.model

Methods in org.spdx.rdfparser.model that return SpdxDocument

Modifier and Type	Method and Description
SpdxDocument	ExternalDocumentRef.getSpdxDocument()

Methods in org.spdx.rdfparser.model with parameters of type SpdxDocument

Modifier and Type	Method and Description
void	ExternalDocumentRef.setSpdxDocument(SpdxDocument spdxDocument)

Constructors in org.spdx.rdfparser.model with parameters of type SpdxDocument

Constructor and Description
ExternalDocumentRef(SpdxDocument externalDocument, Checksum checksum, String externalDocumentId)

Uses of SpdxDocument in org.spdx.spdxspreadsheet

Methods in org.spdx.spdxspreadsheet with parameters of type SpdxDocument

Modifier and Type	Method and Description
void	OriginsSheetV2d0.addDocument(SpdxDocument doc)
void	OriginsSheetV1d2.addDocument(SpdxDocument doc)
void	OriginsSheetV1d1.addDocument(SpdxDocument doc)
void	OriginsSheetV0d9d4.addDocument(SpdxDocument doc)
abstract void	DocumentInfoSheet.addDocument(SpdxDocument doc) Add all origin information from the document

Uses of SpdxDocument in org.spdx.tag

Methods in org.spdx.tag with parameters of type SpdxDocument

Modifier and Type	Method and Description
static void	CommonCode.printDoc(SpdxDocument doc, PrintWriter out, Properties constants)

Uses of SpdxDocument in org.spdx.tools

Methods in org.spdx.tools that return SpdxDocument

Modifier and Type	Method and Description
static SpdxDocument	SpreadsheetToRDF.copySpreadsheetToSPDXAnalysis(SPDXSpreadsheet ss)
protected static SpdxDocument	CompareSpdxDocs.openRdfOrTagDoc(String spdxDocFileName, List<String> warnings)

Methods in org.spdx.tools with parameters of type SpdxDocument

Modifier and Type	Method and Description
static void	RdfToSpreadsheet.copyRdfXmlToSpreadsheet(SpdxDocument doc, SPDXSpreadsheet ss)
static void	RdfToHtml.rdfToHtml(SpdxDocument doc, File docHtmlFile, File licenseHtmlFile, File snippetHtmlFile, File docFilesHtmlFile)
static void	RdfToHtml.rdfToHtml(SpdxDocument doc, File templateDir, File docHtmlFile, File licenseHtmlFile, File snippetHtmlFile, File docFilesHtmlFile)