Enum ComparisonType

    • Enum Constant Detail

      • CONTAINS

        public static final ComparisonType CONTAINS
        Simple substring comparison
      • DAMERAU_LEVENSHTEIN

        public static final ComparisonType DAMERAU_LEVENSHTEIN
        String comparison using the Damerau-Levenshtein algorithm
      • EXACT_MATCH

        public static final ComparisonType EXACT_MATCH
        Simple string comparision
      • JARO

        public static final ComparisonType JARO
        String comparison using the Jaro algorithm
      • JARO_WINKLER

        public static final ComparisonType JARO_WINKLER
        String comparison using the Jaro-Winkler algorithm
      • LEVENSHTEIN

        public static final ComparisonType LEVENSHTEIN
        String comparison using Levenshtein distance
      • QGRAM

        public static final ComparisonType QGRAM
        String comparison using Q-grams
      • POSITIONAL_QGRAM

        public static final ComparisonType POSITIONAL_QGRAM
        String comparison using position Q-grams
      • SHORTHAND

        public static final ComparisonType SHORTHAND
        String comparision based on shorthand
    • Method Detail

      • values

        public static ComparisonType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ComparisonType c : ComparisonType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ComparisonType valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • hasProperties

        public boolean hasProperties()
        Indicates whether the comparison requires additional properties.
        Returns:
        true if additional properties are required, false otherwise
      • getDisplayName

        public String getDisplayName()
        Gets a user-friendly name of the comparison type.
        Returns:
        the name of the comparison for display purposes
      • getAbbreviation

        public String getAbbreviation()
        Gets the abbreviation used for the comparison type.
        Returns:
        the short-form identifier for the comparison
      • getPropertyDefinitions

        public PropertyDefinition[] getPropertyDefinitions()
        Gets the definitions for the comparison's required properties.
        Returns:
        the property definitions. If there are no required properties, null.