SimilarityCalculation (SuperUtilities API)

java.lang.Object
- java.lang.Enum<SimilarityCalculation>
- - com.nuix.superutilities.misc.SimilarityCalculation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SimilarityCalculation>
```
public enum SimilarityCalculation
extends java.lang.Enum<SimilarityCalculation>
```
Used by TermExpander to determine how fuzzy similarity should be calculated to expand a given fuzzy term into matched terms.

Enum Constant Summary

Enum Constants
Enum Constant Description

JaroWinkler

LuceneLevenshstein

NGram

Nuix

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static SimilarityCalculation`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static SimilarityCalculation[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - Nuix
```
public static final SimilarityCalculation Nuix
```
  - LuceneLevenshstein
```
public static final SimilarityCalculation LuceneLevenshstein
```
  - JaroWinkler
```
public static final SimilarityCalculation JaroWinkler
```
  - NGram
```
public static final SimilarityCalculation NGram
```
- Method Detail
  - values
```
public static SimilarityCalculation[] 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 (SimilarityCalculation c : SimilarityCalculation.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SimilarityCalculation valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null