org.spdx.compare

Class SpdxComparer

java.lang.Object

org.spdx.compare.SpdxComparer

public class SpdxComparer
extends Object

Performs a comparison between two or more SPDX documents and holds the results of the comparison The main function to perform the comparison is compare(spdxdoc1, spdxdoc2) For reviewers, the comparison results are separated into unique reviewers for a give document which can be obtained by the method getUniqueReviewers(index1, index2). The uniqueness is determined by the reviewer name. If two documents contain reviewers with the same name but different dates or comments, the reviews are considered to be the same review with different data. The differences for these reviews can be obtained through the method getReviewerDifferences(index1, index2) For files, the comparison results are separated into unique files based on the file names which can be obtained by the method getUniqueFiles(index1, index2). If two documents contain files with the same name, but different data, the differences for these files can be obtained through the method getFileDifferences(index1, index2) Multi-threading considerations: This class is "mostly" threadsafe in that the calls to perform the comparison are synchronized and a flag is used to throw an error for any calls to getters when a compare is in progress. There is a small theoretical window in the getters where the compare operation is started in the middle of a get operation.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpdxComparer.SPDXReviewDifference Contains the results of a comparison between two SPDXReviews where the reviewer name is the same but there is a difference in the reviewer comment or the reviewer date

Constructor Summary

Constructors

Constructor and Description
SpdxComparer()

Method Summary

Modifier and Type	Method and Description
static boolean	arraysEqual(Object[] a1, Object[] a2) Compare two object arrays
protected SpdxFile[]	collectAllFiles(SpdxDocument spdxDocument) Collect all of the files present in the SPDX document including files within documents and files embedded in packages
protected SpdxPackage[]	collectAllPackages(SpdxDocument spdxDocument) Collect all of the packages present in the SPDX document including packages embedded in other relationships within documents
void	compare(SpdxDocument[] spdxDocuments) Compares multiple SPDX documents
void	compare(SpdxDocument spdxDoc1, SpdxDocument spdxDoc2) Compares 2 SPDX documents
boolean	compareLicense(int doc1, AnyLicenseInfo license1, int doc2, AnyLicenseInfo license2) Compares two licenses from two different SPDX documents taking into account the extracted license infos who's ID's may be different between the two documents Note: The ExtracedLicenseIDMap must be initialized before this method is invoked
static int	compareStrings(String stringA, String stringB) Compares two strings including trimming the string and taking into account they may be null.
static boolean	elementsEquivalent(RdfModelObject[] elementsA, RdfModelObject[] elementsB) Returns true if two arrays of SPDX elements contain equivalent elements
static boolean	elementsEquivalent(RdfModelObject elementA, RdfModelObject elementB)
static Annotation[]	findUniqueAnnotations(Annotation[] annotationsA, Annotation[] annotationsB) Find any SPDX annotations which are in annotationsA but not in annotationsB
static Checksum[]	findUniqueChecksums(Checksum[] checksumsA, Checksum[] checksumsB) Find any SPDX checksums which are in elementsA but not in elementsB
static ExternalDocumentRef[]	findUniqueExternalDocumentRefs(ExternalDocumentRef[] externalDocRefsA, ExternalDocumentRef[] externalDocRefsB) Find unique relationships that are present in relationshipsA but not relationshipsB
static Relationship[]	findUniqueRelationships(Relationship[] relationshipsA, Relationship[] relationshipsB) Find unique relationships that are present in relationshipsA but not relationshipsB
SpdxLicenseDifference[]	getExtractedLicenseDifferences(int docIndexA, int docIndexB) Retrieves any licenses which where the text matches in both documents but other fields are different
SpdxFileDifference[]	getFileDifferences(int docindex1, int docindex2) Returns any file differences found between the first and second SPDX documents as specified by the document index
int	getNumSpdxDocs()
SpdxPackageComparer[]	getPackageComparers()
SpdxPackageComparer[]	getPackageDifferences()
SpdxComparer.SPDXReviewDifference[]	getReviewerDifferences(int docindex1, int docindex2) Get all reviewer differences between two documents.
SpdxSnippetComparer[]	getSnippetComparers()
SpdxDocument	getSpdxDoc(int docIndex)
SpdxDocument[]	getSpdxDocuments()
String[]	getUniqueCreators(int doc1index, int doc2index) Returns any creators which are in the SPDX document 1 which are not in document 2
Annotation[]	getUniqueDocumentAnnotations(int docindex1, int docindex2) Return any document annotations which are in spdx document index 1 but not in spdx document index 2
Relationship[]	getUniqueDocumentRelationship(int docindex1, int docindex2) Return any document annotations which are in spdx document index 1 but not in spdx document index 2
ExternalDocumentRef[]	getUniqueExternalDocumentRefs(int docindex1, int docindex2) Return any external document references which are in spdx document index 1 but not in spdx document index 2
ExtractedLicenseInfo[]	getUniqueExtractedLicenses(int docIndexA, int docIndexB) Retrieves any unique extracted licenses fromt the first SPDX document index relative to the second - unique is determined by the license text matching
SpdxFile[]	getUniqueFiles(int docindex1, int docindex2) Return any files which are in spdx document index 1 but not in spdx document index 2
SpdxPackage[]	getUniquePackages(int docindex1, int docindex2) Return any files which are in spdx document index 1 but not in spdx document index 2
SPDXReview[]	getUniqueReviewers(int docindex1, int docindex2) Get all unique reviewers in SPDX document at index 1 relative to reviewers in SPDX Document at index 2
boolean	isCreatorInformationEqual()
boolean	isDataLicenseEqual()
boolean	isDifferenceFound()
boolean	isDocumentAnnotationsEquals()
boolean	isDocumentCommentsEqual()
boolean	isDocumentContentsEquals()
boolean	isDocumentRelationshipsEquals()
boolean	isExternalDcoumentRefsEquals()
boolean	isExtractedLicensingInfosEqual()
boolean	isfilesEquals()
boolean	isLicenseListVersionEqual()
boolean	isPackagesEquals()
boolean	isReviewersEqual()
boolean	isSnippetsEqual()
boolean	isSpdxVersionEqual()
static boolean	objectsEqual(Object o1, Object o2) returns true if the two objects are equal considering nulls
static boolean	stringsEqual(String stringA, String stringB) Compares two strings returning true if they are equal considering null values and trimming the strings.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpdxComparer

public SpdxComparer()

Method Detail

compare

public void compare(SpdxDocument spdxDoc1,
                    SpdxDocument spdxDoc2)
             throws InvalidSPDXAnalysisException,
                    SpdxCompareException

Compares 2 SPDX documents

Parameters:

spdxDoc1 -

spdxDoc2 -

Throws:

InvalidSPDXAnalysisException

SpdxCompareException

compare

public void compare(SpdxDocument[] spdxDocuments)
             throws InvalidSPDXAnalysisException,
                    SpdxCompareException

Compares multiple SPDX documents

Parameters:

spdxDocuments -

Throws:

SpdxCompareException

InvalidSPDXAnalysisException

collectAllPackages

protected SpdxPackage[] collectAllPackages(SpdxDocument spdxDocument)
                                    throws InvalidSPDXAnalysisException

Collect all of the packages present in the SPDX document including packages embedded in other relationships within documents

Parameters:

spdxDocument -

Returns:

Throws:

InvalidSPDXAnalysisException

collectAllFiles

protected SpdxFile[] collectAllFiles(SpdxDocument spdxDocument)
                              throws InvalidSPDXAnalysisException

Collect all of the files present in the SPDX document including files within documents and files embedded in packages

Parameters:

spdxDocument -

Returns:

Throws:

InvalidSPDXAnalysisException

compareLicense

public boolean compareLicense(int doc1,
                              AnyLicenseInfo license1,
                              int doc2,
                              AnyLicenseInfo license2)
                       throws SpdxCompareException

Compares two licenses from two different SPDX documents taking into account the extracted license infos who's ID's may be different between the two documents Note: The ExtracedLicenseIDMap must be initialized before this method is invoked

Parameters:

doc1 - Index of the SPDX document for license1

license1 -

doc2 - Index of the SPDX document for license2

license2 -

Returns:

true if the licenses are equivalent

Throws:

SpdxCompareException

objectsEqual

public static boolean objectsEqual(Object o1,
                                   Object o2)

returns true if the two objects are equal considering nulls

Parameters:

o1 -

o2 -

Returns:

elementsEquivalent

public static boolean elementsEquivalent(RdfModelObject elementA,
                                         RdfModelObject elementB)

arraysEqual

public static boolean arraysEqual(Object[] a1,
                                  Object[] a2)

Compare two object arrays

Parameters:

a1 -

a2 -

Returns:

stringsEqual

public static boolean stringsEqual(String stringA,
                                   String stringB)

Compares two strings returning true if they are equal considering null values and trimming the strings. and normalizing linefeeds. Empty strings are treated as the same as null values.

Parameters:

stringA -

stringB -

Returns:

compareStrings

public static int compareStrings(String stringA,
                                 String stringB)

Compares two strings including trimming the string and taking into account they may be null. Null is considered a smaller value

Parameters:

stringA -

stringB -

Returns:

isDifferenceFound

public boolean isDifferenceFound()

Returns:

isSpdxVersionEqual

public boolean isSpdxVersionEqual()
                           throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

getSpdxDoc

public SpdxDocument getSpdxDoc(int docIndex)
                        throws SpdxCompareException

Parameters:

docIndex - Reference to which document number - 0 is the first document parameter in compare

Returns:

Throws:

SpdxCompareException

isDataLicenseEqual

public boolean isDataLicenseEqual()
                           throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isDocumentCommentsEqual

public boolean isDocumentCommentsEqual()
                                throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isReviewersEqual

public boolean isReviewersEqual()
                         throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isExternalDcoumentRefsEquals

public boolean isExternalDcoumentRefsEquals()
                                     throws SpdxCompareException

Throws:

SpdxCompareException

isExtractedLicensingInfosEqual

public boolean isExtractedLicensingInfosEqual()
                                       throws SpdxCompareException

Throws:

SpdxCompareException

getUniqueReviewers

public SPDXReview[] getUniqueReviewers(int docindex1,
                                       int docindex2)
                                throws SpdxCompareException

Get all unique reviewers in SPDX document at index 1 relative to reviewers in SPDX Document at index 2

Parameters:

docindex1 -

docindex2 -

Returns:

Throws:

SpdxCompareException

getReviewerDifferences

public SpdxComparer.SPDXReviewDifference[] getReviewerDifferences(int docindex1,
                                                                  int docindex2)
                                                           throws SpdxCompareException

Get all reviewer differences between two documents. A reviewer difference is where the reviewer name is the same but the reviewer date and/or the reviewer comment is different

Parameters:

docindex1 -

docindex2 -

Returns:

Throws:

SpdxCompareException

getUniqueExtractedLicenses

public ExtractedLicenseInfo[] getUniqueExtractedLicenses(int docIndexA,
                                                         int docIndexB)
                                                  throws SpdxCompareException

Retrieves any unique extracted licenses fromt the first SPDX document index relative to the second - unique is determined by the license text matching

Parameters:

docIndexA -

docIndexB -

Returns:

Throws:

SpdxCompareException

getExtractedLicenseDifferences

public SpdxLicenseDifference[] getExtractedLicenseDifferences(int docIndexA,
                                                              int docIndexB)
                                                       throws SpdxCompareException

Retrieves any licenses which where the text matches in both documents but other fields are different

Parameters:

docIndexA -

docIndexB -

Returns:

Throws:

SpdxCompareException

isCreatorInformationEqual

public boolean isCreatorInformationEqual()
                                  throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

getUniqueCreators

public String[] getUniqueCreators(int doc1index,
                                  int doc2index)
                           throws SpdxCompareException

Returns any creators which are in the SPDX document 1 which are not in document 2

Parameters:

doc1index -

doc2index -

Returns:

Throws:

SpdxCompareException

isfilesEquals

public boolean isfilesEquals()
                      throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackagesEquals

public boolean isPackagesEquals()
                         throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isDocumentAnnotationsEquals

public boolean isDocumentAnnotationsEquals()
                                    throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isDocumentRelationshipsEquals

public boolean isDocumentRelationshipsEquals()
                                      throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

getUniqueFiles

public SpdxFile[] getUniqueFiles(int docindex1,
                                 int docindex2)
                          throws SpdxCompareException

Return any files which are in spdx document index 1 but not in spdx document index 2

Parameters:

docindex1 -

docindex2 -

Returns:

Throws:

SpdxCompareException

getFileDifferences

public SpdxFileDifference[] getFileDifferences(int docindex1,
                                               int docindex2)
                                        throws SpdxCompareException

Returns any file differences found between the first and second SPDX documents as specified by the document index

Parameters:

docindex1 -

docindex2 -

Returns:

Throws:

SpdxCompareException

getUniquePackages

public SpdxPackage[] getUniquePackages(int docindex1,
                                       int docindex2)
                                throws SpdxCompareException

Return any files which are in spdx document index 1 but not in spdx document index 2

Parameters:

docindex1 -

docindex2 -

Returns:

Throws:

SpdxCompareException

getUniqueExternalDocumentRefs

public ExternalDocumentRef[] getUniqueExternalDocumentRefs(int docindex1,
                                                           int docindex2)
                                                    throws SpdxCompareException

Return any external document references which are in spdx document index 1 but not in spdx document index 2

Parameters:

docindex1 -

docindex2 -

Returns:

Throws:

SpdxCompareException

getUniqueDocumentAnnotations

public Annotation[] getUniqueDocumentAnnotations(int docindex1,
                                                 int docindex2)
                                          throws SpdxCompareException

Return any document annotations which are in spdx document index 1 but not in spdx document index 2

Parameters:

docindex1 -

docindex2 -

Returns:

Throws:

SpdxCompareException

getUniqueDocumentRelationship

public Relationship[] getUniqueDocumentRelationship(int docindex1,
                                                    int docindex2)
                                             throws SpdxCompareException

Return any document annotations which are in spdx document index 1 but not in spdx document index 2

Parameters:

docindex1 -

docindex2 -

Returns:

Throws:

SpdxCompareException

getPackageDifferences

public SpdxPackageComparer[] getPackageDifferences()
                                            throws SpdxCompareException

Returns:

Package comparers where there is at least one difference

Throws:

SpdxCompareException

getPackageComparers

public SpdxPackageComparer[] getPackageComparers()

Returns:

all package comparers

getNumSpdxDocs

public int getNumSpdxDocs()

Returns:

isLicenseListVersionEqual

public boolean isLicenseListVersionEqual()
                                  throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

findUniqueChecksums

public static Checksum[] findUniqueChecksums(Checksum[] checksumsA,
                                             Checksum[] checksumsB)

Find any SPDX checksums which are in elementsA but not in elementsB

Parameters:

checksumsA -

checksumsB -

Returns:

findUniqueAnnotations

public static Annotation[] findUniqueAnnotations(Annotation[] annotationsA,
                                                 Annotation[] annotationsB)

Find any SPDX annotations which are in annotationsA but not in annotationsB

Parameters:

annotationsA -

annotationsB -

Returns:

elementsEquivalent

public static boolean elementsEquivalent(RdfModelObject[] elementsA,
                                         RdfModelObject[] elementsB)

Returns true if two arrays of SPDX elements contain equivalent elements

Parameters:

elementsA -

elementsB -

Returns:

findUniqueRelationships

public static Relationship[] findUniqueRelationships(Relationship[] relationshipsA,
                                                     Relationship[] relationshipsB)

Find unique relationships that are present in relationshipsA but not relationshipsB

Parameters:

relationshipsA -

relationshipsB -

Returns:

findUniqueExternalDocumentRefs

public static ExternalDocumentRef[] findUniqueExternalDocumentRefs(ExternalDocumentRef[] externalDocRefsA,
                                                                   ExternalDocumentRef[] externalDocRefsB)
                                                            throws InvalidSPDXAnalysisException

Find unique relationships that are present in relationshipsA but not relationshipsB

Parameters:

externalDocRefsA -

externalDocRefsB -

Returns:

Throws:

InvalidSPDXAnalysisException

getSpdxDocuments

public SpdxDocument[] getSpdxDocuments()

Returns:

isDocumentContentsEquals

public boolean isDocumentContentsEquals()
                                 throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isSnippetsEqual

public boolean isSnippetsEqual()
                        throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

getSnippetComparers

public SpdxSnippetComparer[] getSnippetComparers()

Returns:

all snippet comparers