package commons
- Alphabetic
- Public
- Protected
Type Members
- case class FinderMatch(id: String, externalId: String, foundName: String, matchResult: Match) extends Product with Serializable
Class that provides the match information of a Finder result.
Class that provides the match information of a Finder result.
- id
The id of the found person.
- externalId
The external id of the found person.
- foundName
The original name of the found person.
- matchResult
The matchResult object of the match.
- case class IndexOrganisation(id: String, externalId: String, fullName: String, datesOfFounding: List[String], countries: List[String], label: String = "") extends Product with Serializable
Class represents an organisation to index.
Class represents an organisation to index.
- id
The id of the organisation.
- externalId
The external id of the organisation.
- fullName
The full name (inclusive legal form) of the organisation.
- datesOfFounding
List of dates. Not null, empty allowed. Format see supported date formats by the DateNormalizer.
- countries
List of countries. Not null, empty allowed. Format: ISO-2, name in en, de, fr, it.
- label
Optional string for a category. You can use it as a filter by searching an organisation.
- case class IndexPerson(id: String, externalId: String, fullName: String, datesOfBirth: List[String], countries: List[String], label: String = "") extends Product with Serializable
Class represents a person to index.
Class represents a person to index.
- id
The id of the person.
- externalId
The external id of the person.
- fullName
The full name of the person. More than one name? See Indexer class for the req. options.
- datesOfBirth
List of dates. Not null, empty allowed. Format see supported date formats by the DateNormalizer.
- countries
List of countries. Not null, empty allowed. Format: ISO-2, name in en, de, fr, it.
- label
Optional string for a category. You can use it as a filter by searching an organisation.
- case class Match(nofHits: Int, nofHitsWeighted: Double, cov: Double, covWeighted: Double, similarity: Double, matchPairs: List[(String, String)]) extends Product with Serializable
Class that provides various key figures for a comparison.
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.
- nofHits
Number of hits, matching name elements.
- nofHitsWeighted
Number of hits, matching name elements, but weighted. Some matches has a lower weight than 1.
- cov
Coverage. Number of hits in relation to the longer name.
- covWeighted
Coverage. Number of hits weighted in relation to the longer name, also weighted number of name elements.
- similarity
Depending on the ratio of the length - nofHits the similarity is calculated as follows: covW + ((1-covW)/x
- matchPairs
A list that contains all pairs of name elements that were recognized as hits.
- case class NormalizedDate(year: Int, month: Int, day: Int, dateType: Byte) extends Product with Serializable
This class represent a normalized date.
This class represent a normalized date.
- year
Number of the year.
- month
Number of the month in the year (1-12)
- day
Number of the day in the month (1-[28|29|30|31])
- dateType
Defines which components are available from the date: 0 = all, 1 = year/month, 2 = year only, 99 = nothing.
- case class NormalizedName(normNames: Vector[Vector[(String, Double, Byte)]], sourceName: String) extends Product with Serializable
Representing a normalized name.
Representing a normalized name. For person- and organisation names.
Use the NameNormalizer class to get a valid instance of this class.
- 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.