org.spdx.utility.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	Description
`protected static Map<String,String>`	`NORMALIZE_TOKENS`
`protected static Set<String>`	`PUNCTUATION`
`protected static Set<String>`	`SKIPPABLE_TOKENS`
`protected static Pattern`	`TOKEN_SPLIT_PATTERN`
`protected static String`	`TOKEN_SPLIT_REGEX`

Constructor Summary

Constructors

Constructor Description

LicenseCompareHelper()

Method Summary

Modifier and Type	Method	Description
`static String`	`getFirstLicenseToken(String text)`
`static List<String>`	`getNonOptionalLicenseText(String licenseTemplate, boolean includeVarText)`	Get the text of a license minus any optional text - note: this include the default variable 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`	`isLicensePassBlackList(AnyLicenseInfo license, String... blackList)`	Detect if a license pass black lists
`static boolean`	`isLicensePassWhiteList(AnyLicenseInfo license, String... whiteList)`	Detect if a license pass white lists
`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 Pattern`	`nonOptionalTextToStartPattern(List<String> nonOptionalText, int numberOfWords)`	Creates a regular expression pattern to match the start of a license text
`static String`	`normalizeText(String s)`	Normalize quotes and no-break spaces
`static String`	`removeCommentChars(String s)`	Remove common comment characters from either a template or license text strings
`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 Details
- 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 Set<String> PUNCTUATION
- SKIPPABLE_TOKENS
  
  protected static final Set<String> SKIPPABLE_TOKENS
- NORMALIZE_TOKENS
  
  protected static final Map<String,String> NORMALIZE_TOKENS
Constructor Details
- LicenseCompareHelper
  
  public LicenseCompareHelper()
Method Details
- 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:
- removeCommentChars
  
  public static String removeCommentChars(String s)
  
  Remove common comment characters from either a template or license text strings
  
  Parameters:
  
  s -
  
  Returns:
- normalizeText
  
  public static String normalizeText(String s)
  
  Normalize quotes and no-break spaces
  
  Parameters:
  
  s - String to normalize
  
  Returns:
  
  String normalized for comparison
- 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:
  
  tokenToLocation - location for all of the tokens
  
  licenseText -
  
  Returns:
  
  tokens
- 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, InvalidSPDXAnalysisException
  
  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
  
  InvalidSPDXAnalysisException
- getNonOptionalLicenseText
  
  public static List<String> getNonOptionalLicenseText(String licenseTemplate, boolean includeVarText) throws SpdxCompareException
  
  Get the text of a license minus any optional text - note: this include the default variable text
  
  Parameters:
  
  licenseTemplate - license template containing optional and var tags
  
  includeVarText - if true, include the default variable text; if false remove the variable text
  
  Returns:
  
  list of strings for all non-optional license text.
  
  Throws:
  
  SpdxCompareException
- nonOptionalTextToStartPattern
  
  public static Pattern nonOptionalTextToStartPattern(List<String> nonOptionalText, int numberOfWords)
  
  Creates a regular expression pattern to match the start of a license text
  
  Parameters:
  
  nonOptionalText - List of strings of non-optional text from the license template (see List<String> getNonOptionalLicenseText)
  
  numberOfWords - Number of words to use in the match
  
  Returns:
  
  Pattern which will match the start of the license text
- isTextStandardLicense
  
  public static CompareTemplateOutputHandler.DifferenceDescription isTextStandardLicense(License license, String compareText) throws SpdxCompareException, InvalidSPDXAnalysisException
  
  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
  
  InvalidSPDXAnalysisException
- isTextStandardException
  
  public static CompareTemplateOutputHandler.DifferenceDescription isTextStandardException(LicenseException exception, String compareText) throws SpdxCompareException, InvalidSPDXAnalysisException
  
  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
  
  InvalidSPDXAnalysisException
- 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
- isLicensePassBlackList
  
  public static boolean isLicensePassBlackList(AnyLicenseInfo license, String... blackList) throws InvalidSPDXAnalysisException
  
  Detect if a license pass black lists
  
  Parameters:
  
  license - license
  
  blackList - license black list
  
  Returns:
  
  if the license pass black lists
  
  Throws:
  
  InvalidSPDXAnalysisException
- isLicensePassWhiteList
  
  public static boolean isLicensePassWhiteList(AnyLicenseInfo license, String... whiteList) throws InvalidSPDXAnalysisException
  
  Detect if a license pass white lists
  
  Parameters:
  
  license - license
  
  whiteList - license white list
  
  Returns:
  
  if the license pass white lists
  
  Throws:
  
  InvalidSPDXAnalysisException

Class LicenseCompareHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details