org.spdx.compare.SpdxPackageComparer Maven / Gradle / Ivy

/**
 * Copyright (c) 2015 Source Auditor Inc.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 *
*/
package org.spdx.compare;

import java.util.Arrays;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import org.spdx.rdfparser.InvalidSPDXAnalysisException;
import org.spdx.rdfparser.model.Checksum;
import org.spdx.rdfparser.model.ExternalRef;
import org.spdx.rdfparser.model.SpdxDocument;
import org.spdx.rdfparser.model.SpdxFile;
import org.spdx.rdfparser.model.SpdxItem;
import org.spdx.rdfparser.model.SpdxPackage;

import com.google.common.base.Objects;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;

/**
 * Compares two SPDX package.  The compare(pkgA, pkgB) method will perform the comparison and
 * store the results.  isDifferenceFound() will return true of any 
 * differences were found.
 * @author Gary O'Neall
 *
 */
public class SpdxPackageComparer extends SpdxItemComparer {
	private boolean inProgress = false;
	private boolean differenceFound = false;
	private boolean packageVersionsEquals = true;
	private boolean packageFilenamesEquals = true;
	private boolean packageSuppliersEquals = true;
	private boolean packageDownloadLocationsEquals = true;
	private boolean packageVerificationCodesEquals = true;
	private boolean packageChecksumsEquals = true;
	private boolean packageSourceInfosEquals = true;
	private boolean declaredLicensesEquals = true;
	private boolean packageSummaryEquals = true;
	private boolean packageDescriptionsEquals = true;
	private boolean packageOriginatorsEqual = true;
	private boolean packageHomePagesEquals = true;
	private boolean packageFilesEquals = true;
	private boolean filesAnalyzedEquals = true;
	private boolean externalRefsEquals = true;
	/**
	 * Map of documents to a map of documents with unique checksums
	 */
	private Map> uniqueChecksums = Maps.newHashMap();

	/**
	 * Map of documents to a map of documents with unique files
	 */
	private Map> uniqueFiles = Maps.newHashMap();
	
	/**
	 * Map of all file differences founds between any two spdx document packages
	 */
	private Map> fileDifferences = Maps.newHashMap();
	
	/**
	 * Map of documents to a map of documents with unique external refs
	 */
	private Map> uniqueExternalRefs = Maps.newHashMap();
	
	/**
	 * Map of documents to a map of documents with external refs with differences
	 */
	private Map> externalRefDifferences = Maps.newHashMap();
	private Comparator externalRefTypeNameComparator = new Comparator() {

		@Override
		public int compare(ExternalRef arg0, ExternalRef arg1) {
			if (arg0 == null) {
				if (arg1 == null) {
					return 0;
				} else {
					return -1;
				}
			}
			if (arg1 == null) {
				return 1;
			}
			try {
				if (arg0.getReferenceType() == null) {
					if (arg1.getReferenceType() != null) {
						return -1;
					}
				} else {
					int retval = arg0.getReferenceType().compareTo(arg1.getReferenceType());
					if (retval != 0) {
						return retval;
					}
				}
			} catch (InvalidSPDXAnalysisException e) {
				// just compare the locators
			}
			if (arg0.getReferenceLocator() == null) {
				if (arg1.getReferenceLocator() == null) {
					return 0;
				} else {
					return -1;
				}
			} else {
				return arg0.getReferenceLocator().compareTo(arg1.getReferenceLocator());
			}
		}
	};
	
	/**
	 * @param extractedLicenseIdMap map of all extracted license IDs for any SPDX documents to be added to the comparer
	 */
	public SpdxPackageComparer(Map>> extractedLicenseIdMap) {
		super(extractedLicenseIdMap);
	}
	
	/**
	 * Add a package to the comparer and performs the comparison to any existing documents
	 * @param spdxDocument document containing the package
	 * @param spdxPackage packaged to be added
	 * @param licenseXlationMap A mapping between the license IDs from licenses in fileA to fileB
	 * @throws SpdxCompareException 
	 */
	public void addDocumentPackage(SpdxDocument spdxDocument,
			SpdxPackage spdxPackage) throws SpdxCompareException {
		checkInProgress();
		if (this.name == null) {
			this.name = spdxPackage.getName();
		} else if (!this.name.equals(spdxPackage.getName())) {
			throw(new SpdxCompareException("Names do not match for item being added to comparer: "+
					spdxPackage.getName()+", expecting "+this.name));
		}
		inProgress = true;
		Iterator> iter = this.documentItem.entrySet().iterator();
		SpdxPackage pkg2 = null;
		Map licenseXlationMap = null;
		while (iter.hasNext() && pkg2 == null) {
			Entry entry = iter.next();
			if (entry.getValue() instanceof SpdxPackage) {
				pkg2 = (SpdxPackage)entry.getValue();
				licenseXlationMap = this.extractedLicenseIdMap.get(spdxDocument).get(entry.getKey());
			}
		}
		if (pkg2 != null) {
			if (!SpdxComparer.stringsEqual(spdxPackage.getVersionInfo(), pkg2.getVersionInfo())) {
				this.packageVersionsEquals = false;
				this.differenceFound = true;
			}
			if (!SpdxComparer.stringsEqual(spdxPackage.getPackageFileName(), pkg2.getPackageFileName())) {
				this.packageFilenamesEquals = false;
				this.differenceFound = true;
			}
			if (!SpdxComparer.stringsEqual(spdxPackage.getSupplier(), pkg2.getSupplier())) {
				this.packageSuppliersEquals = false;
				this.differenceFound = true;
			}
			if (!SpdxComparer.stringsEqual(spdxPackage.getOriginator(), pkg2.getOriginator())) {
				this.packageOriginatorsEqual = false;
				this.differenceFound = true;
			}
			if (!SpdxComparer.stringsEqual(spdxPackage.getDownloadLocation(), pkg2.getDownloadLocation())) {
				this.packageDownloadLocationsEquals = false;
				this.differenceFound = true;
			}
			try {
				if (!SpdxComparer.compareVerificationCodes(spdxPackage.getPackageVerificationCode(), pkg2.getPackageVerificationCode())) {
					this.packageVerificationCodesEquals = false;
					this.differenceFound = true;
				}
			} catch (InvalidSPDXAnalysisException e) {
				throw(new SpdxCompareException("SPDX error getting package verification codes: "+e.getMessage(),e));
			}
			try {
				compareNewPackageChecksums(spdxDocument, spdxPackage.getChecksums());
			} catch (InvalidSPDXAnalysisException e) {
				throw(new SpdxCompareException("SPDX error getting package checksums: "+e.getMessage(),e));
			}
			if (!SpdxComparer.stringsEqual(spdxPackage.getSourceInfo(), pkg2.getSourceInfo())) {
				this.packageSourceInfosEquals = false;
				this.differenceFound = true;
			}
			try {
				if (!LicenseCompareHelper.isLicenseEqual(spdxPackage.getLicenseDeclared(), 
						pkg2.getLicenseDeclared(), licenseXlationMap)) {
					this.declaredLicensesEquals = false;
					this.differenceFound = true;
				}
			} catch (InvalidSPDXAnalysisException e) {
				throw(new SpdxCompareException("SPDX error getting declared license: "+e.getMessage(),e));
			}
			if (!SpdxComparer.stringsEqual(spdxPackage.getSummary(), pkg2.getSummary())) {
				this.packageSummaryEquals = false;
				this.differenceFound = true;
			}
			if (!SpdxComparer.stringsEqual(spdxPackage.getDescription(), pkg2.getDescription())) {
				this.packageDescriptionsEquals = false;
				this.differenceFound = true;
			}
			if (!SpdxComparer.stringsEqual(spdxPackage.getHomepage(), pkg2.getHomepage())) {
				this.packageHomePagesEquals = false;
				this.differenceFound = true;
			}
			try {
				if (spdxPackage.isFilesAnalyzed() != pkg2.isFilesAnalyzed()) {
					this.filesAnalyzedEquals = false;
					this.differenceFound = true;
				}
			} catch (InvalidSPDXAnalysisException e) {
				throw(new SpdxCompareException("SPDX error getting filesAnalyzed: "+e.getMessage(),e));
			}
			try {
				compareNewPackageFiles(spdxDocument, spdxPackage.getFiles());
			} catch (InvalidSPDXAnalysisException e) {
				throw(new SpdxCompareException("SPDX error getting package files: "+e.getMessage(),e));
			}
			try {
				compareNewPackageExternalRefs(spdxDocument, spdxPackage.getExternalRefs());
			} catch (InvalidSPDXAnalysisException e) {
				throw(new SpdxCompareException("SPDX error getting package external refs: "+e.getMessage(),e));
			}
		}
		inProgress = false;
		super.addDocumentItem(spdxDocument, spdxPackage);
	}
	
	/**
	 * @param spdxDocument
	 * @param externalRefs
	 * @throws InvalidSPDXAnalysisException 
	 */
	private void compareNewPackageExternalRefs(SpdxDocument spdxDocument,
			ExternalRef[] externalRefs) throws InvalidSPDXAnalysisException {
		Arrays.sort(externalRefs);
		Map docUniqueExternalRefs = this.uniqueExternalRefs.get(spdxDocument);
		if (docUniqueExternalRefs == null) {
			docUniqueExternalRefs = Maps.newHashMap();
			this.uniqueExternalRefs.put(spdxDocument, docUniqueExternalRefs);
		}
		Map docExternalRefDiffs = this.externalRefDifferences.get(spdxDocument);
		if (docExternalRefDiffs == null) {
			docExternalRefDiffs = Maps.newHashMap();
			this.externalRefDifferences.put(spdxDocument, docExternalRefDiffs);
		}
		
		Iterator> iter = this.documentItem.entrySet().iterator();
		while (iter.hasNext()) {
			Entry entry = iter.next();
			if (entry.getValue() instanceof SpdxPackage) {
				ExternalRef[] compareExternalRefs = ((SpdxPackage)entry.getValue()).getExternalRefs();
				Arrays.sort(compareExternalRefs);
				SpdxExternalRefDifference[] externalRefDifferences = findExternalRefDifferences(spdxDocument, entry.getKey(), 
						externalRefs, compareExternalRefs);
				if (externalRefDifferences.length > 0) {
					this.externalRefsEquals = false;
					this.differenceFound = true;
				}
				docExternalRefDiffs.put(entry.getKey(), externalRefDifferences);
				Map compareExternalRefDiffs = this.externalRefDifferences.get(entry.getKey());
				if (compareExternalRefDiffs == null) {
					compareExternalRefDiffs = Maps.newHashMap();
					this.externalRefDifferences.put(entry.getKey(), compareExternalRefDiffs);
				}
				compareExternalRefDiffs.put(spdxDocument, externalRefDifferences);
				
				ExternalRef[] uniqueRefs = findUniqueExternalRefs(externalRefs, compareExternalRefs);
				if (uniqueRefs.length > 0) {
					this.externalRefsEquals = false;
					this.differenceFound = true;
				}
				uniqueExternalRefs.put(entry.getKey(), docUniqueExternalRefs);
				Map compareUniqueRefs = this.uniqueExternalRefs.get(entry.getKey());
				if (compareUniqueRefs == null) {
					compareUniqueRefs = Maps.newHashMap();
					this.uniqueExternalRefs.put(entry.getKey(), compareUniqueRefs);
				}
				uniqueRefs = findUniqueExternalRefs(compareExternalRefs, externalRefs);
				if (uniqueRefs.length > 0) {
					this.externalRefsEquals = false;
					this.differenceFound = true;
				}
				compareUniqueRefs.put(spdxDocument, uniqueRefs);			
			}
		}
	}

	/**
	 * @param compareExternalRefs
	 * @param externalRefs
	 * @return
	 * @throws InvalidSPDXAnalysisException 
	 */
	private ExternalRef[] findUniqueExternalRefs(
			ExternalRef[] externalRefsA, ExternalRef[] externalRefsB) throws InvalidSPDXAnalysisException {
		int bIndex = 0;
		int aIndex = 0;
		List alRetval = Lists.newArrayList();
		while (aIndex < externalRefsA.length) {
			if (bIndex >= externalRefsB.length) {
				alRetval.add(externalRefsA[aIndex]);
				aIndex++;
			} else {
				int compareVal = externalRefTypeNameComparator.compare(externalRefsA[aIndex], externalRefsB[bIndex]);
				if (compareVal == 0) {
					// external Refs are equal
					aIndex++;
					bIndex++;
				} else if (compareVal > 0) {
					// externalRefsA is greater than externalRefsB
					bIndex++;
				} else {
					// externalRefsB is greater tha externalRefsA
					alRetval.add(externalRefsA[aIndex]);
					aIndex++;
				}
			}
		}
		ExternalRef[] retval = alRetval.toArray(new ExternalRef[alRetval.size()]);
		return retval;
	}

	/**
	 * @param spdxDocument
	 * @param key
	 * @param externalRefs
	 * @param compareExternalRefs
	 * @return
	 * @throws InvalidSPDXAnalysisException 
	 */
	private SpdxExternalRefDifference[] findExternalRefDifferences(
			SpdxDocument spdxDocument, SpdxDocument key,
			ExternalRef[] externalRefsA, ExternalRef[] externalRefsB) throws InvalidSPDXAnalysisException {
		List retval = Lists.newArrayList();
		int aIndex = 0;
		int bIndex = 0;
		Arrays.sort(externalRefsA, externalRefTypeNameComparator );
		Arrays.sort(externalRefsB, externalRefTypeNameComparator);
		while (aIndex < externalRefsA.length && bIndex < externalRefsB.length) {
			int compare = externalRefTypeNameComparator.compare(externalRefsA[aIndex], externalRefsB[bIndex]);
			if (compare == 0) {
				if (!Objects.equal(externalRefsA[aIndex].getComment(), externalRefsB[bIndex].getComment()) ||
						!Objects.equal(externalRefsA[aIndex].getReferenceCategory(), externalRefsB[bIndex].getReferenceCategory())) {
					retval.add(new SpdxExternalRefDifference(externalRefsA[aIndex], externalRefsB[bIndex]));
				}
				aIndex++;
				bIndex++;
			} else if (compare > 0) {
				// externalRefsA is greater than externalRefsB
				bIndex++;
			} else {
				// externalRefsB is greater than externalRefsA
				aIndex++;
			}
		}
		return retval.toArray(new SpdxExternalRefDifference[retval.size()]);
	}

	/**
	 * @param spdxDocument
	 * @param files
	 * @throws SpdxCompareException 
	 * @throws InvalidSPDXAnalysisException 
	 */
	private void compareNewPackageFiles(SpdxDocument spdxDocument,
			SpdxFile[] files) throws SpdxCompareException, InvalidSPDXAnalysisException {
		Arrays.sort(files);
		Map docUniqueFiles = this.uniqueFiles.get(spdxDocument);
		if (docUniqueFiles == null) {
			docUniqueFiles = Maps.newHashMap();
			this.uniqueFiles.put(spdxDocument, docUniqueFiles);
		}
		Map docDifferentFiles = this.fileDifferences.get(spdxDocument);
		if (docDifferentFiles == null) {
			docDifferentFiles = Maps.newHashMap();
			this.fileDifferences.put(spdxDocument, docDifferentFiles);
		}
		Iterator> iter = this.documentItem.entrySet().iterator();
		while (iter.hasNext()) {
			Entry entry = iter.next();
			if (entry.getValue() instanceof SpdxPackage) {
				SpdxFile[] compareFiles = ((SpdxPackage)entry.getValue()).getFiles();
				Arrays.sort(compareFiles);
				SpdxFileDifference[] fileDifferences = 
						SpdxComparer.findFileDifferences(spdxDocument, entry.getKey(), files, compareFiles, this.extractedLicenseIdMap);
				if (fileDifferences.length > 0) {
					this.packageFilesEquals = false;
					this.differenceFound = true;
				}
				docDifferentFiles.put(entry.getKey(), fileDifferences);
				Map compareDifferentFiles = this.fileDifferences.get(entry.getKey());
				if (compareDifferentFiles == null) {
					compareDifferentFiles = Maps.newHashMap();
					this.fileDifferences.put(entry.getKey(), compareDifferentFiles);
				}
				compareDifferentFiles.put(spdxDocument, fileDifferences);
				SpdxFile[] uniqueFiles = SpdxComparer.findUniqueFiles(files, compareFiles);
				if (uniqueFiles.length > 0) {
					this.packageFilesEquals = false;
					this.differenceFound = true;
				}
				docUniqueFiles.put(entry.getKey(), uniqueFiles);
				Map compareUniqueFiles = this.uniqueFiles.get(entry.getKey());
				if (compareUniqueFiles == null) {
					compareUniqueFiles = Maps.newHashMap();
					this.uniqueFiles.put(entry.getKey(), compareUniqueFiles);
				}
				uniqueFiles = SpdxComparer.findUniqueFiles(compareFiles, files);
				if (uniqueFiles.length > 0) {
					this.packageFilesEquals = false;
					this.differenceFound = true;
				}
				compareUniqueFiles.put(spdxDocument, uniqueFiles);
			}
		}
	}

	/**
	 * Compare the checks for a new package being added to the existing
	 * package checksums filling in the unique checksums map
	 * @param spdxDocument
	 * @param checksums
	 * @throws SpdxCompareException 
	 */
	private void compareNewPackageChecksums(SpdxDocument spdxDocument,
			Checksum[] checksums) throws SpdxCompareException {
		try {
			Map docUniqueChecksums = Maps.newHashMap();
			this.uniqueChecksums.put(spdxDocument, docUniqueChecksums);
			Iterator> iter = this.documentItem.entrySet().iterator();
			while (iter.hasNext()) {
				Entry entry = iter.next();
				if (entry.getValue() instanceof SpdxPackage) {
					Checksum[] compareChecksums = ((SpdxPackage)entry.getValue()).getChecksums();
					Checksum[] uniqueChecksums = SpdxComparer.findUniqueChecksums(checksums, compareChecksums);
					if (uniqueChecksums.length > 0) {
						this.packageChecksumsEquals = false;
						this.differenceFound = true;
					}
					docUniqueChecksums.put(entry.getKey(), uniqueChecksums);
					Map compareUniqueChecksums = this.uniqueChecksums.get(entry.getKey());
					if (compareUniqueChecksums == null) {
						compareUniqueChecksums = Maps.newHashMap();
						this.uniqueChecksums.put(entry.getKey(), compareUniqueChecksums);
					}
					uniqueChecksums = SpdxComparer.findUniqueChecksums(compareChecksums, checksums);
					if (uniqueChecksums.length > 0) {
						this.packageChecksumsEquals = false;
						this.differenceFound = true;
					}
					compareUniqueChecksums.put(spdxDocument, uniqueChecksums);
				}
			}
		} catch (InvalidSPDXAnalysisException e) {
			throw(new SpdxCompareException("SPDX error getting package checksums: "+e.getMessage(),e));
		}
	}

	/**
	 * @return the inProgress
	 */
	@Override
    public boolean isInProgress() {
		return inProgress;
	}

	/**
	 * @return the differenceFound
	 * @throws SpdxCompareException 
	 */
	@Override
    public boolean isDifferenceFound() throws SpdxCompareException {
		checkInProgress();
		return differenceFound || super.isDifferenceFound();
	} 

	/**
	 * checks to make sure there is not a compare in progress
	 * @throws SpdxCompareException 
	 * 
	 */
	@Override
    protected void checkInProgress() throws SpdxCompareException {
		if (inProgress) {
			throw(new SpdxCompareException("File compare in progress - can not obtain compare results until compare has completed"));
		}
		super.checkInProgress();
	}
	/**
	 * @return the packageVersionsEquals
	 * @throws SpdxCompareException 
	 */
	public boolean isPackageVersionsEquals() throws SpdxCompareException {
		checkInProgress();
		return packageVersionsEquals;
	}

	/**
	 * @return the packageFilenamesEquals
	 */
	public boolean isPackageFilenamesEquals() throws SpdxCompareException {
		checkInProgress();
		return packageFilenamesEquals;
	}

	/**
	 * @return the packageSuppliersEquals
	 */
	public boolean isPackageSuppliersEquals() throws SpdxCompareException {
		checkInProgress();
		return packageSuppliersEquals;
	}

	/**
	 * @return the packageDownloadLocationsEquals
	 */
	public boolean isPackageDownloadLocationsEquals() throws SpdxCompareException {
		checkInProgress();
		return packageDownloadLocationsEquals;
	}

	/**
	 * @return the packageVerificationCodeesEquals
	 */
	public boolean isPackageVerificationCodesEquals() throws SpdxCompareException {
		checkInProgress();
		return packageVerificationCodesEquals;
	}
	
	

	/**
	 * @return the filesAnalyzedEquals
	 * @throws SpdxCompareException 
	 */
	public boolean isFilesAnalyzedEquals() throws SpdxCompareException {
		checkInProgress();
		return filesAnalyzedEquals;
	}

	/**
	 * @return the packageChecksumsEquals
	 */
	public boolean isPackageChecksumsEquals() throws SpdxCompareException {
		checkInProgress();
		return packageChecksumsEquals;
	}

	/**
	 * @return the packageSourceInfosEquals
	 */
	public boolean isPackageSourceInfosEquals() throws SpdxCompareException {
		checkInProgress();
		return packageSourceInfosEquals;
	}

	/**
	 * @return the declaredLicensesEquals
	 */
	public boolean isDeclaredLicensesEquals() throws SpdxCompareException {
		checkInProgress();
		return declaredLicensesEquals;
	}

	/**
	 * @return the packageSummaryEquals
	 */
	public boolean isPackageSummaryEquals() throws SpdxCompareException {
		checkInProgress();
		return packageSummaryEquals;
	}

	/**
	 * @return the packageDescriptionsEquals
	 */
	public boolean isPackageDescriptionsEquals() throws SpdxCompareException {
		checkInProgress();
		return packageDescriptionsEquals;
	}

	/**
	 * @return the packageOriginatorsEqual
	 */
	public boolean isPackageOriginatorsEqual() throws SpdxCompareException {
		checkInProgress();
		return packageOriginatorsEqual;
	}

	/**
	 * @return the packageHomePagesEquals
	 */
	public boolean isPackageHomePagesEquals() throws SpdxCompareException {
		checkInProgress();
		return packageHomePagesEquals;
	}
	

	/**
	 * @return the externalRefsEquals
	 * @throws SpdxCompareException 
	 */
	public boolean isExternalRefsEquals() throws SpdxCompareException {
		checkInProgress();
		return externalRefsEquals;
	}

	/**
	 * Return the package associated with the document
	 * @param document 
	 * @return The document associated with the document
	 */
	public SpdxPackage getDocPackage(SpdxDocument document) throws SpdxCompareException {
		SpdxItem retItem = this.documentItem.get(document);
		if (retItem != null && retItem instanceof SpdxPackage) {
			return (SpdxPackage)retItem;
		} else {
			return null;
		}
	}

	/**
	 * Get the checksums which are present in document A but not in document B
	 * @return the uniqueChecksums
	 */
	public Checksum[] getUniqueChecksums(SpdxDocument docA, SpdxDocument docB) throws SpdxCompareException {
		checkInProgress();
		Map uniqueMap = this.uniqueChecksums.get(docA);
		if (uniqueMap == null) {
			return new Checksum[0];
		}
		Checksum[] retval = uniqueMap.get(docB);
		if (retval == null) {
			return new Checksum[0];
		}
		return retval;
	}
	
	public ExternalRef[] getUniqueExternalRefs(SpdxDocument docA, SpdxDocument docB) throws SpdxCompareException {
		checkInProgress();
		Map uniqueMap = this.uniqueExternalRefs.get(docA);
		if (uniqueMap == null) {
			return new ExternalRef[0];
		}
		ExternalRef[] retval = uniqueMap.get(docB);
		if (retval == null) {
			return new ExternalRef[0];
		} else {
			return retval;
		}
	}
	
	public SpdxExternalRefDifference[] getExternalRefDifferences(SpdxDocument docA, SpdxDocument docB) throws SpdxCompareException {
		checkInProgress();
		Map externalRefDiffMap = this.externalRefDifferences.get(docA);
		if (externalRefDiffMap == null) {
			return new SpdxExternalRefDifference[0];
		}
		SpdxExternalRefDifference[] retval = externalRefDiffMap.get(docB);
		if (retval == null) {
			return new SpdxExternalRefDifference[0];
		} else {
			return retval;
		}
	}

	/**
	 * @return the packageFilesEquals
	 */
	public boolean isPackageFilesEquals() throws SpdxCompareException {
		checkInProgress();
		return packageFilesEquals;
	}

	/**
	 * Get any fileDifferences which are in docA but not in docB
	 * @param docA
	 * @param docB
	 * @return
	 */
	public SpdxFileDifference[] getFileDifferences(SpdxDocument docA, 
			SpdxDocument docB) throws SpdxCompareException {
		checkInProgress();
		Map uniqueMap = this.fileDifferences.get(docA);
		if (uniqueMap == null) {
			return new SpdxFileDifference[0];
		}
		SpdxFileDifference[] retval = uniqueMap.get(docB);
		if (retval == null) {
			return new SpdxFileDifference[0];
		}
		return retval;
	}


	/**
	 * Return any unique files by name which are in docA but not in docB
	 * @param docA
	 * @param docB
	 * @return
	 */
	public SpdxFile[] getUniqueFiles(SpdxDocument docA, SpdxDocument docB) throws SpdxCompareException {
		checkInProgress();
		Map uniqueMap = this.uniqueFiles.get(docA);
		if (uniqueMap == null) {
			return new SpdxFile[0];
		}
		SpdxFile[] retval = uniqueMap.get(docB);
		if (retval == null) {
			return new SpdxFile[0];
		}
		return retval;
	}

	/**
	 * @return
	 */
	public String getPackageName() throws SpdxCompareException {
		checkInProgress();
		return this.name;
	}

	/**
	 * @return
	 * @throws SpdxCompareException 
	 */
	public int getNumPackages() throws SpdxCompareException {
		checkInProgress();
		return this.documentItem.size();
	}
	
}