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>	NORMALIZE_TOKENS
protected static com.google.common.collect.ImmutableSet<String>	PUNCTUATION
protected static com.google.common.collect.ImmutableSet<String>	SKIPPABLE_TOKENS
protected static Pattern	TOKEN_SPLIT_PATTERN
protected static String	TOKEN_SPLIT_REGEX

Constructor Summary

Constructors

Constructor and Description
LicenseCompareHelper()

Method Summary

Modifier and Type	Method and Description
static String	getFirstLicenseToken(String text)
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	isSingleTokenString(String text)
static CompareTemplateOutputHandler.DifferenceDescription	isTextStandardException(LicenseException exception, String compareText) Compares exception text to the exception text of an SPDX Standard exception
static CompareTemplateOutputHandler.DifferenceDescription	isTextStandardLicense(License license, String compareText) Compares license text to the license text of an SPDX Standard License
static String	locateOriginalText(String fullLicenseText, int startToken, int endToken, Map<Integer,LineColumn> tokenToLocation, String[] tokens) Locate the original text starting with the start token and ending with the end token
static String[]	matchingStandardLicenseIds(String licenseText) Returns a list of SPDX Standard License ID's that match the text provided using the SPDX matching guidelines.
static String[]	tokenizeLicenseText(String licenseText, Map<Integer,LineColumn> tokenToLocation) Tokenizes the license text, normalizes quotes, lowercases and converts multi-words for better equiv.

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_SPLIT_REGEX

protected static final String TOKEN_SPLIT_REGEX

See Also:

Constant Field Values

TOKEN_SPLIT_PATTERN

protected static final Pattern TOKEN_SPLIT_PATTERN

PUNCTUATION

protected static final com.google.common.collect.ImmutableSet<String> PUNCTUATION

SKIPPABLE_TOKENS

protected static final com.google.common.collect.ImmutableSet<String> SKIPPABLE_TOKENS

NORMALIZE_TOKENS

protected static final Map<String,String> NORMALIZE_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:

locateOriginalText

public static String locateOriginalText(String fullLicenseText,
                                        int startToken,
                                        int endToken,
                                        Map<Integer,LineColumn> tokenToLocation,
                                        String[] tokens)

Locate the original text starting with the start token and ending with the end token

Parameters:

fullLicenseText -

startToken -

endToken -

tokenToLocation -

Returns:

tokenizeLicenseText

public static String[] tokenizeLicenseText(String licenseText,
                                           Map<Integer,LineColumn> tokenToLocation)

Tokenizes the license text, normalizes quotes, lowercases and converts multi-words for better equiv. comparisons

Parameters:

tokenLocations - location for all of the tokens

licenseText -

Returns:

Throws:

IOException

getFirstLicenseToken

public static String getFirstLicenseToken(String text)

Parameters:

text -

Returns:

the first token in the license text

isSingleTokenString

public static boolean isSingleTokenString(String text)

Parameters:

text -

Returns:

true if the text contains a single token

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 CompareTemplateOutputHandler.DifferenceDescription isTextStandardLicense(License 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:

any differences found

Throws:

SpdxCompareException

isTextStandardException

public static CompareTemplateOutputHandler.DifferenceDescription isTextStandardException(LicenseException exception,
                                                                                         String compareText)
                                                                                  throws SpdxCompareException

Compares exception text to the exception text of an SPDX Standard exception

Parameters:

exception - SPDX Standard exception to compare

compareText - Text to compare to the standard exceptions

Returns:

any differences found

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