com.tplan.robot.util

Class TextSearchResult

java.lang.Object

com.tplan.robot.util.TextSearchResult

All Implemented Interfaces:

Comparable

public class TextSearchResult
extends Object
implements Comparable

Helper class representing a single match resulting from a text search for a substring (pattern). It is identified by the index (position) in the source text, the matching string (which is equal to the pattern for exact searches) and the distance (for fuzzy searches using the Levenshtein distance).

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors

Constructor and Description
TextSearchResult(int index, int distance, String match) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) Compare the instance to another one.
int	getDistance() Get the Levenshtein distance between the match and the pattern.
int	getIndex() Get the matching string start index.
Rectangle	getLocation() Get the matching string location.
String	getMatch() Get the matching string.
void	setLocation(Rectangle location) Set the matching string location.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextSearchResult

public TextSearchResult(int index,
                        int distance,
                        String match)

Constructor.

Parameters:

index - the match position (index) in the source text where 0 (zero) marks the text beginning.

distance - the Levenshtein distance between the match and the pattern. For exact searches produced through String.indexOf(java.lang.String) use the value of 0 to indicate that the match string is exactly the same as the pattern.

match - the matching string. It is equal to the pattern for the distance of 0.

Method Detail

compareTo

public int compareTo(Object o)

Compare the instance to another one. It allows to sort a list of matches by the distance to get the result which matches the pattern the best (has the lowest distance). If the two objects have the same distance they are sorted by the index in ascending order.

Specified by:

compareTo in interface Comparable

Parameters:

o - an object to compare to.

Returns:

the distance of this object minus the argument distance. If the result is zero the method returns the object position (index) minus the argument one.

getIndex

public int getIndex()

Get the matching string start index.

Returns:

the start index of the matching string.

getDistance

public int getDistance()

Get the Levenshtein distance between the match and the pattern.

Returns:

the distance.

getMatch

public String getMatch()

Get the matching string. It is equal to the pattern if the distance is 0.

Returns:

the matching string.

getLocation

public Rectangle getLocation()

Get the matching string location. This is an optional parameter used for results from OCR.

Returns:

the matching string location.

setLocation

public void setLocation(Rectangle location)

Set the matching string location. This is an optional parameter used for results from OCR.

Parameters:

location - the matching string location.