com.groupdocs.search.options

Class SimilarityLevel

java.lang.Object

com.groupdocs.search.options.FuzzyAlgorithm

com.groupdocs.search.options.SimilarityLevel

public class SimilarityLevel
extends FuzzyAlgorithm

Represents an algorithm of the fuzzy search that specifies the similarity level. The similarity level algorithm calculates the maximum number of mistakes for a word as inversely proportional to the word length.

Learn more

• Fuzzy search

The example demonstrates a typical usage of the class.

 
 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.getFuzzySearch().setEnabled(true); // Enabling the fuzzy search
 options.getFuzzySearch().setFuzzyAlgorithm(new SimilarityLevel(0.8)); // Creating the fuzzy search algorithm
 // This function specifies 0 as the maximum number of mistakes for words from 1 to 4 characters.
 // It specifies 1 as the maximum number of mistakes for words from 5 to 9 characters.
 // It specifies 2 as the maximum number of mistakes for words from 10 to 14 characters. And so on.
 SearchResult result = index.search(query, options); // Search in index
 
 

Field Summary

Fields inherited from class com.groupdocs.search.options.FuzzyAlgorithm

core

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimilarityLevel() Initializes a new instance of the SimilarityLevel class.
	SimilarityLevel(double value) Initializes a new instance of the SimilarityLevel class.
	SimilarityLevel(Object data) Initializes a new instance of the SimilarityLevel class.

Method Summary

Modifier and Type	Method and Description
int	getMaxMistakeCount(int termLength) Gets the maximum allowed number of mistakes for the specified term length.
double	getSimilarityLevel(int termLength) Gets the similarity level value for the specified term length.

Methods inherited from class com.groupdocs.search.options.FuzzyAlgorithm

getCore

Methods inherited from class java.lang.Object

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

Constructor Detail

SimilarityLevel

protected SimilarityLevel()

Initializes a new instance of the SimilarityLevel class.

SimilarityLevel

public SimilarityLevel(double value)

Initializes a new instance of the SimilarityLevel class.

Parameters:

value - The similarity level value.

SimilarityLevel

public SimilarityLevel(Object data)

Initializes a new instance of the SimilarityLevel class.

Parameters:

data - The serialized data.

Method Detail

getMaxMistakeCount

public int getMaxMistakeCount(int termLength)

Gets the maximum allowed number of mistakes for the specified term length.

Specified by:

getMaxMistakeCount in class FuzzyAlgorithm

Parameters:

termLength - The term length.

Returns:

The maximum allowed number of mistakes.

getSimilarityLevel

public double getSimilarityLevel(int termLength)

Gets the similarity level value for the specified term length.

Specified by:

getSimilarityLevel in class FuzzyAlgorithm

Parameters:

termLength - The term length.

Returns:

The similarity level value.