EntitySimilarityChecker
API
Generated with
EntitySimilarityChecker/esc/esc.commons

esc.commons

package esc.commons

Members list

Type members

Classlikes

object Constants

This object provides static constants needed in the application.

This object provides static constants needed in the application.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Constants.type
case class FinderMatch(id: String, externalId: String, foundName: String, matchResult: Match)

Class that provides the match information of a Finder result.

Class that provides the match information of a Finder result.

Value parameters

externalId

The external id of the found person or organisation.

foundName

The original name of the found person or organisation.

id

The id of the found person or organisation.

matchResult

The MatchResult object of the match itself.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class IndexOrganisation(id: String, externalId: String, fullName: String, datesOfFounding: List[String], countries: List[String], label: String)

Class represents an organisation to index.

Class represents an organisation to index.

Value parameters

countries

List of countries. Not null, empty allowed. Format: ISO-2, ISO-3 or name in en, de, fr or it (not recommended).

datesOfFounding

List of dates. Not null, empty allowed. Format see supported date formats by the DateNormalizer.

externalId

The external id of the organisation.

fullName

The full name (inclusive legal form) of the organisation.

id

The id of the organisation.

label

Optional string for a category. You can use it as a filter by searching an organisation.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class IndexPerson(id: String, externalId: String, fullName: String, datesOfBirth: List[String], countries: List[String], label: String)

Class represents a person to index.

Class represents a person to index.

Value parameters

countries

List of countries. Not null, empty allowed. Format: ISO-2, ISO-3 or name in en, de, fr or it (not recommended).

datesOfBirth

List of dates. Not null, empty allowed. Format see supported date formats by the DateNormalizer.

externalId

The external id of the person.

fullName

The full name of the person. More than one name? See Indexer class for the recommended solution.

id

The id of the person.

label

Optional string for a category. You can use it as a filter by searching an organisation.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Match(nofHits: Int, nofHitsWeighted: Double, cov: Double, covWeighted: Double, similarity: Double, matchPairs: List[(String, String)])

Class that provides various key figures for a comparison. This class would be used by the NameSimilarity class. You can only consume them as a result.

Class that provides various key figures for a comparison. This class would be used by the NameSimilarity class. You can only consume them as a result.

Value parameters

cov

Coverage. Number of hits in relation to the longer name.

covWeighted

Coverage. Number of hits weighted in relation to the longer name, but weighted number of name elements.

matchPairs

A list that contains all pairs of name elements that were recognized as hits.

nofHits

Number of hits, count of matching name elements.

nofHitsWeighted

Number of hits, count of matching name elements, but weighted. Some matches has a lower weight than 1.

similarity

Depending on the ratio of the length - nofHits the similarity is calculated as follows: covW + ((1-covW)/x

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class NormalizedAddress(address: String, addressItems: List[String], countries: List[String])

Representing a normalized address.

Representing a normalized address.

Use the AddressNormalizer class to get a valid instance of this class.

Value parameters

address

The normalized address string.

countries

ISO-2 code of the countries the address is related to.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class NormalizedDate(year: Int, month: Int, day: Int, dateType: Byte)

This class represent a normalized date.

This class represent a normalized date.

Value parameters

dateType

Defines which components are available from the date: 0 = all, 1 = year/month, 2 = year only, 99 = nothing.

day

Number of the day in the month (1-[28|29|30|31])

month

Number of the month in the year (1-12)

year

Number of the year.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class NormalizedName(normNames: Vector[Vector[(String, Double, Byte)]], sourceName: String)

Representing a normalized name. For person- and organisation names.

Representing a normalized name. For person- and organisation names.

Use the NameNormalizer class to get a valid instance of this class.

Value parameters

normNames

String = the name element, Double = the weight of the name element, Byte = the type of the name element: 1 = normal, 2 = legal form, 3 = country

sourceName

The original full name.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Generated with