NameSimilarity

esc.similarity.NameSimilarity
class NameSimilarity(val similarityConfig: SimilarityConfig)

This class provides methods to calculate the similarity of two normalized names.

Value parameters

similarityConfig

Optional. A SimilarityConfiguration.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def explainNameSimilarity(normalizedNameA: NormalizedName, normalizedNameB: NormalizedName, personNameType: String): MatchExplanation

Returns comprehensive information on a hit. Not as performant and therefore not suitable for batch processing. Use this function if a user cannot understand the hit and needs more detailed information.

Returns comprehensive information on a hit. Not as performant and therefore not suitable for batch processing. Use this function if a user cannot understand the hit and needs more detailed information.

Attributes

def explainOrganisationNameSimilarity(nameA: String, nameB: String): MatchExplanation

Returns comprehensive information on a organisation hit. Not as performant and therefore not suitable for batch processing. Use this function if a user cannot understand the hit and needs more detailed information. You can use toCompactJson method on MatchExplanation to get a json string of the object.

Returns comprehensive information on a organisation hit. Not as performant and therefore not suitable for batch processing. Use this function if a user cannot understand the hit and needs more detailed information. You can use toCompactJson method on MatchExplanation to get a json string of the object.

Attributes

def explainPersonNameSimilarity(nameA: String, nameB: String): MatchExplanation

Returns comprehensive information on a personname hit. Not as performant and therefore not suitable for batch processing. Use this function if a user cannot understand the hit and needs more detailed information. You can use toCompactJson method on MatchExplanation to get a json string of the object.

Returns comprehensive information on a personname hit. Not as performant and therefore not suitable for batch processing. Use this function if a user cannot understand the hit and needs more detailed information. You can use toCompactJson method on MatchExplanation to get a json string of the object.

Attributes

def getNameSimilarity(normNameA: NormalizedName, normNameB: NormalizedName): Match

Main method to calculate the similarity of two normalized names. It returns a Match object that provides various key figures to match. Attention: Make sure that you only compare the same name types (person or organization). Maybe it's better to use the specific method (person or organisation).

Main method to calculate the similarity of two normalized names. It returns a Match object that provides various key figures to match. Attention: Make sure that you only compare the same name types (person or organization). Maybe it's better to use the specific method (person or organisation).

Value parameters

normNameA

NormalizedName a

normNameB

NormalizedName b

Attributes

Returns

Return a Match object with the relevant key figures of the match.

def getOrganisationNameSimilarity(nameA: String, nameB: String): Match

Standard method to calculate the similarity of two organisation names. It returns a Match object that provides various key figures to match.

Standard method to calculate the similarity of two organisation names. It returns a Match object that provides various key figures to match.

Value parameters

nameA

Name a) as a full name.

nameB

Name b) as a full name.

Attributes

def getPersonNameSimilarity(nameA: String, nameB: String): Match

Standard method to calculate the simialrity of two person names. It returns a Match object that provides various key figures to match.

Standard method to calculate the simialrity of two person names. It returns a Match object that provides various key figures to match.

Value parameters

nameA

Name a) as a full name.

nameB

Name b) as a full name.

Attributes

Returns

Retun a Match object with the relevant match key figures.

Concrete fields