org.spdx.compare

Class LicenseCompareHelper

java.lang.Object

org.spdx.compare.LicenseCompareHelper

public class LicenseCompareHelper
extends Object

Primarily a static class of helper functions for comparing two SPDX licenses

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,String>	EQUIV_TOKENS
protected static Set<String>	SKIPPABLE_TOKENS
protected static String	TOKEN_DELIM

Constructor Summary

Constructors

Constructor and Description
LicenseCompareHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isLicenseEqual(AnyLicenseInfo license1, AnyLicenseInfo license2, Map<String,String> xlationMap) Compares two licenses from potentially two different documents which may have different license ID's for the same license
static boolean	isLicenseTextEquivalent(String licenseTextA, String licenseTextB) Returns true if two sets of license text is considered a match per the SPDX License matching guidelines documented at spdx.org (currently http://spdx.org/wiki/spdx-license-list-match-guidelines) There are 2 unimplemented features - bullets/numbering is not considered and comments with no whitespace between text is not skipped
static boolean	isTextStandardLicense(SpdxListedLicense license, String compareText) Compares license text to the license text of an SPDX Standard License
static String[]	matchingStandardLicenseIds(String licenseText) Returns a list of SPDX Standard License ID's that match the text provided using the SPDX matching guidelines.

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_DELIM

protected static final String TOKEN_DELIM

See Also:

Constant Field Values

SKIPPABLE_TOKENS

protected static final Set<String> SKIPPABLE_TOKENS

EQUIV_TOKENS

protected static final Map<String,String> EQUIV_TOKENS

Constructor Detail

LicenseCompareHelper

public LicenseCompareHelper()

Method Detail

isLicenseTextEquivalent

public static boolean isLicenseTextEquivalent(String licenseTextA,
                              String licenseTextB)

Returns true if two sets of license text is considered a match per the SPDX License matching guidelines documented at spdx.org (currently http://spdx.org/wiki/spdx-license-list-match-guidelines) There are 2 unimplemented features - bullets/numbering is not considered and comments with no whitespace between text is not skipped

Parameters:

licenseTextA -

licenseTextB -

Returns:

isLicenseEqual

public static boolean isLicenseEqual(AnyLicenseInfo license1,
                     AnyLicenseInfo license2,
                     Map<String,String> xlationMap)
                              throws SpdxCompareException

Compares two licenses from potentially two different documents which may have different license ID's for the same license

Parameters:

license1 -

license2 -

xlationMap - Mapping the license ID's from license 1 to license 2

Returns:

Throws:

SpdxCompareException

isTextStandardLicense

public static boolean isTextStandardLicense(SpdxListedLicense license,
                            String compareText)
                                     throws SpdxCompareException

Compares license text to the license text of an SPDX Standard License

Parameters:

license - SPDX Standard License to compare

compareText - Text to compare to the standard license

Returns:

True if the license text is the same per the license matching guidelines

Throws:

SpdxCompareException

matchingStandardLicenseIds

public static String[] matchingStandardLicenseIds(String licenseText)
                                           throws InvalidSPDXAnalysisException,
                                                  SpdxCompareException

Returns a list of SPDX Standard License ID's that match the text provided using the SPDX matching guidelines.

Parameters:

licenseText - Text to compare to the standard license texts

Returns:

Array of SPDX standard license IDs that match

Throws:

InvalidSPDXAnalysisException - If an error occurs accessing the standard licenses

SpdxCompareException - If an error occurs in the comparison