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
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

Methods

Modifier and Type	Method and Description
void	compare(SPDXDocument[] compareDocs) Compares multiple SPDX documents
void	compare(SPDXDocument doc1, SPDXDocument doc2) Compares 2 SPDX documents
boolean	compareLicense(int doc1, SPDXLicenseInfo license1, int doc2, SPDXLicenseInfo 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.
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()
SpdxComparer.SPDXReviewDifference[]	getReviewerDifferences(int docindex1, int docindex2) Get all reviewer differences between two documents.
SPDXDocument	getSpdxDoc(int docIndex)
String[]	getUniqueCreators(int doc1index, int doc2index) Returns any creators which are in the SPDX document 1 which are not in document 2
SPDXNonStandardLicense[]	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
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	isCopyrightTextsEqual()
boolean	isCreatorInformationEqual()
boolean	isDataLicenseEqual()
boolean	isDifferenceFound()
boolean	isDocumentCommentsEqual()
boolean	isExtractedLicensingInfosEqual()
boolean	isfilesEquals()
boolean	isLicenseCommentsEqual()
boolean	isLicenseListVersionEqual()
boolean	isPackageChecksumsEqual()
boolean	isPackageConcludedLicensesEqual()
boolean	isPackageDeclaredLicensesEqual()
boolean	isPackageDescriptionsEqual()
boolean	isPackageDownloadLocationsEqual()
boolean	isPackageEqual()
boolean	isPackageFileNamesEqual()
boolean	ispackageHomePagesEqual()
boolean	isPackageLicenseInfoFromFilesEqual()
boolean	isPackageNamesEqual()
boolean	isPackageOriginatorsEqual()
boolean	isPackageSummariesEqual()
boolean	isPackageSuppliersEqual()
boolean	isPackageVerificationCodesEqual()
boolean	isPackageVersionsEqual()
boolean	isReviewersEqual()
boolean	isSourceInformationEqual()
boolean	isSpdxVersionEqual()
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 doc1,
           SPDXDocument doc2)
             throws InvalidSPDXAnalysisException,
                    SpdxCompareException

Compares 2 SPDX documents

Parameters:

doc1 -

doc2 -

Throws:

InvalidSPDXAnalysisException

SpdxCompareException

compare

public void compare(SPDXDocument[] compareDocs)
             throws InvalidSPDXAnalysisException,
                    SpdxCompareException

Compares multiple SPDX documents

Parameters:

compareDocs -

Throws:

SpdxCompareException

InvalidSPDXAnalysisException

compareLicense

public boolean compareLicense(int doc1,
                     SPDXLicenseInfo license1,
                     int doc2,
                     SPDXLicenseInfo 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

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. 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

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 SPDXNonStandardLicense[] 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

isPackageEqual

public boolean isPackageEqual()
                       throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageNamesEqual

public boolean isPackageNamesEqual()
                            throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageVersionsEqual

public boolean isPackageVersionsEqual()
                               throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageLicenseInfoFromFilesEqual

public boolean isPackageLicenseInfoFromFilesEqual()
                                           throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageFileNamesEqual

public boolean isPackageFileNamesEqual()
                                throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageSuppliersEqual

public boolean isPackageSuppliersEqual()
                                throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageOriginatorsEqual

public boolean isPackageOriginatorsEqual()
                                  throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageDownloadLocationsEqual

public boolean isPackageDownloadLocationsEqual()
                                        throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageVerificationCodesEqual

public boolean isPackageVerificationCodesEqual()
                                        throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageChecksumsEqual

public boolean isPackageChecksumsEqual()
                                throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isSourceInformationEqual

public boolean isSourceInformationEqual()
                                 throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageDeclaredLicensesEqual

public boolean isPackageDeclaredLicensesEqual()
                                       throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageConcludedLicensesEqual

public boolean isPackageConcludedLicensesEqual()
                                        throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isLicenseCommentsEqual

public boolean isLicenseCommentsEqual()
                               throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isCopyrightTextsEqual

public boolean isCopyrightTextsEqual()
                              throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageSummariesEqual

public boolean isPackageSummariesEqual()
                                throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isPackageDescriptionsEqual

public boolean isPackageDescriptionsEqual()
                                   throws SpdxCompareException

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

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

getNumSpdxDocs

public int getNumSpdxDocs()

Returns:

ispackageHomePagesEqual

public boolean ispackageHomePagesEqual()
                                throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

isLicenseListVersionEqual

public boolean isLicenseListVersionEqual()
                                  throws SpdxCompareException

Returns:

Throws:

SpdxCompareException