Apache Commons Text 1.15.0 · org.apache.commons.text.similarity.LevenshteinResults

Modifier and Type	Field and Description
private final Integer	deleteCount Delete character count.
private final Integer	distance Edit distance.
private final Integer	insertCount Insert character count.
private final Integer	substituteCount Substitute character count.

Access	Constructor and Description
public	LevenshteinResults(final Integer distance between two character sequences. distance, final Integer insert character count. insertCount, final Integer delete character count. deleteCount, final Integer substitute character count. substituteCount) Constructs the results for a detailed Levenshtein distance.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Integer	Returns: delete character count. getDeleteCount() Gets the number of character deletion needed to change one character sequence to other.
public Integer	Returns: distance between two character sequence. getDistance() Gets the distance between two character sequences.
public Integer	Returns: insert character count. getInsertCount() Gets the number of insertion needed to change one character sequence into another.
public Integer	Returns: substitute character count. getSubstituteCount() Gets the number of character substitution needed to change one character sequence into another.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

deleteCount	back to summary
private final Integer deleteCount Delete character count.

distance	back to summary
private final Integer distance Edit distance.

insertCount	back to summary
private final Integer insertCount Insert character count.

substituteCount	back to summary
private final Integer substituteCount Substitute character count.

LevenshteinResults	back to summary
public LevenshteinResults(final Integer distance, final Integer insertCount, final Integer deleteCount, final Integer substituteCount) Constructs the results for a detailed Levenshtein distance. Parameters distance:Integer distance between two character sequences. insertCount:Integer insert character count. deleteCount:Integer delete character count. substituteCount:Integer substitute character count.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getDeleteCount	back to summary
public Integer getDeleteCount() Gets the number of character deletion needed to change one character sequence to other. Returns:Integer delete character count.

getDeleteCount

back to summary

public Integer getDeleteCount()

Gets the number of character deletion needed to change one character sequence to other.

Returns:Integer: delete character count.

getDistance	back to summary
public Integer getDistance() Gets the distance between two character sequences. Returns:Integer distance between two character sequence.

getDistance

back to summary

public Integer getDistance()

Gets the distance between two character sequences.

Returns:Integer: distance between two character sequence.

getInsertCount	back to summary
public Integer getInsertCount() Gets the number of insertion needed to change one character sequence into another. Returns:Integer insert character count.

getInsertCount

back to summary

public Integer getInsertCount()

Gets the number of insertion needed to change one character sequence into another.

Returns:Integer: insert character count.

getSubstituteCount	back to summary
public Integer getSubstituteCount() Gets the number of character substitution needed to change one character sequence into another. Returns:Integer substitute character count.

getSubstituteCount

back to summary

public Integer getSubstituteCount()

Gets the number of character substitution needed to change one character sequence into another.

Returns:Integer: substitute character count.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class LevenshteinResults

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail