nameElementSimilarityDb

esc.similarity.nameElementSimilarityDb

Object providing methods for known similarity name element pairs.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def getKnownSimilarity(nameElementA: String, nameElementB: String): (Boolean, Double)

Return if a similarity is know or not and the similarity value. Similarity of a no knowing combination is -99.999.

Return if a similarity is know or not and the similarity value. Similarity of a no knowing combination is -99.999.

Value parameters

nameElementA

The name element a) for the comparison. Name element, e.g. john, not a full name.

nameElementB

The name element b) for the comparison. Name element, e.g. john, not a full name.

Attributes

Returns

Return a Tuple with Boolean if is the similarity known or not (true/false) and the similarity value. If not know, the value is -99.999.

def getMatchList(nameElement: String, matchLevel: Double): List[String]

Return a list with matching name elements for a given name element. MatchLevel is an equal or bigger value of similarity. For matchLevel it is recommended to use the value of SimilarityConfig.nameElementSimilarityForHit. This is also used as the default.

Return a list with matching name elements for a given name element. MatchLevel is an equal or bigger value of similarity. For matchLevel it is recommended to use the value of SimilarityConfig.nameElementSimilarityForHit. This is also used as the default.

Value parameters

matchLevel

The similarity value from which you speak from a hit. E.g. 0.9. Use the value from SimilarityConfig.nameElementSimilarityForHit for consistence.

nameElement

The name element for which you asked for known hits.

Attributes

Returns

Return a list of String with found known matches.