Package me.xdrop.fuzzywuzzy

Class Extractor

java.lang.Object

me.xdrop.fuzzywuzzy.Extractor

public class Extractor
extends Object

Constructor Summary

Constructors

Constructor	Description
Extractor()
Extractor(int cutoff)

Method Summary

Modifier and Type	Method	Description
ExtractedResult	extractOne(String query, Collection<String> choices, Applicable func)	Find the single best match above a score in a list of choices.
<T> BoundExtractedResult<T>	extractOne(String query, Collection<T> choices, ToStringFunction<T> toStringFunction, Applicable func)	Find the single best match above a score in a list of choices.
List<ExtractedResult>	extractTop(String query, Collection<String> choices, Applicable func)	Creates a sorted list of ExtractedResult which contain the top @param limit most similar choices
List<ExtractedResult>	extractTop(String query, Collection<String> choices, Applicable func, int limit)	Creates a sorted list of ExtractedResult which contain the top @param limit most similar choices
<T> List<BoundExtractedResult<T>>	extractTop(String query, Collection<T> choices, ToStringFunction<T> toStringFunction, Applicable func)	Creates a sorted list of ExtractedResult which contain the top @param limit most similar choices
<T> List<BoundExtractedResult<T>>	extractTop(String query, Collection<T> choices, ToStringFunction<T> toStringFunction, Applicable func, int limit)	Creates a sorted list of ExtractedResult which contain the top @param limit most similar choices
List<ExtractedResult>	extractWithoutOrder(String query, Collection<String> choices, Applicable func)	Returns the list of choices with their associated scores of similarity in a list of ExtractedResult
<T> List<BoundExtractedResult<T>>	extractWithoutOrder(String query, Collection<T> choices, ToStringFunction<T> toStringFunction, Applicable func)	Returns the list of choices with their associated scores of similarity in a list of ExtractedResult
int	getCutoff()
void	setCutoff(int cutoff)
Extractor	with(int cutoff)

Methods inherited from class java.lang.Object

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

Constructor Detail

Extractor

public Extractor()

Extractor

public Extractor(int cutoff)

Method Detail

with

public Extractor with(int cutoff)

extractWithoutOrder

public List<ExtractedResult> extractWithoutOrder(String query,
                                                 Collection<String> choices,
                                                 Applicable func)

Returns the list of choices with their associated scores of similarity in a list of ExtractedResult

Parameters:

query - The query string

choices - The list of choices

func - The function to apply

Returns:

The list of results

extractWithoutOrder

public <T> List<BoundExtractedResult<T>> extractWithoutOrder(String query,
                                                             Collection<T> choices,
                                                             ToStringFunction<T> toStringFunction,
                                                             Applicable func)

Returns the list of choices with their associated scores of similarity in a list of ExtractedResult

Parameters:

query - The query string

choices - The list of choices

toStringFunction - The ToStringFunction to be applied to all choices.

func - The function to apply

Returns:

The list of results

extractOne

public ExtractedResult extractOne(String query,
                                  Collection<String> choices,
                                  Applicable func)

Find the single best match above a score in a list of choices.

Parameters:

query - A string to match against

choices - A list of choices

func - Scoring function

Returns:

An object containing the best match and it's score

extractOne

public <T> BoundExtractedResult<T> extractOne(String query,
                                              Collection<T> choices,
                                              ToStringFunction<T> toStringFunction,
                                              Applicable func)

Find the single best match above a score in a list of choices.

Parameters:

query - A string to match against

choices - A list of choices

toStringFunction - The ToStringFunction to be applied to all choices.

func - Scoring function

Returns:

An object containing the best match and it's score

extractTop

public List<ExtractedResult> extractTop(String query,
                                        Collection<String> choices,
                                        Applicable func)

Creates a sorted list of ExtractedResult which contain the top @param limit most similar choices

Parameters:

query - The query string

choices - A list of choices

func - The scoring function

Returns:

A list of the results

extractTop

public <T> List<BoundExtractedResult<T>> extractTop(String query,
                                                    Collection<T> choices,
                                                    ToStringFunction<T> toStringFunction,
                                                    Applicable func)

Creates a sorted list of ExtractedResult which contain the top @param limit most similar choices

Parameters:

query - The query string

choices - A list of choices

toStringFunction - The ToStringFunction to be applied to all choices.

func - The scoring function

Returns:

A list of the results

extractTop

public List<ExtractedResult> extractTop(String query,
                                        Collection<String> choices,
                                        Applicable func,
                                        int limit)

Creates a sorted list of ExtractedResult which contain the top @param limit most similar choices

Parameters:

query - The query string

choices - A list of choices

limit - Limits the number of results and speeds up the search (k-top heap sort) is used

Returns:

A list of the results

extractTop

public <T> List<BoundExtractedResult<T>> extractTop(String query,
                                                    Collection<T> choices,
                                                    ToStringFunction<T> toStringFunction,
                                                    Applicable func,
                                                    int limit)

Creates a sorted list of ExtractedResult which contain the top @param limit most similar choices

Parameters:

query - The query string

choices - A list of choices

toStringFunction - The ToStringFunction to be applied to all choices.

limit - Limits the number of results and speeds up the search (k-top heap sort) is used

Returns:

A list of the results

getCutoff

public int getCutoff()

setCutoff

public void setCutoff(int cutoff)