Finder

esc.index.Finder
class Finder(val indexSearcher: IndexSearcher, val similarityConfig: SimilarityConfig, adrCheckStopWords: List[String], adrCheckHitWords: List[String])

Class that provides the necessary functions to find individuals and organisations. As a help you can create an instance of the class using the IndexFactory (recommended).

Value parameters

adrCheckHitWords

Optional. A list with words which should be result in a hit, even they occurs only one time for address search.

adrCheckStopWords

Optional. A list with words which sould be ignored for address search.

indexSearcher

Lucene IndexSearcher.

similarityConfig

Optional.Similarity configuration.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def findByAddress(address: String, label: String): List[FinderMatch]
def findOrganisation(fullName: String, datesOfFounding: List[String], countries: List[String], label: String): List[FinderMatch]

Method to find an organisation by name with countries and dates of founding as filter. Optional you can use label as an additional filter (if is indexed).

Method to find an organisation by name with countries and dates of founding as filter. Optional you can use label as an additional filter (if is indexed).

Value parameters

countries

A list with known countries. E.g. domicile, citizenship, country of birth etc. ISO-2, ISO-3 codes or names in en, de, fr and it (not recommended) are supported. Must not be null, empty list is allowed.

datesOfFounding

A list with known dates of founding. See DataNormalizer for supported string formats. Must not be null, empty list is allowed.

fullName

The full name of the organisation, incl. the legal form.

label

Optional. You can provide a label as search filter - if you have used them for indexing.

Attributes

Returns

Returns a list of FinderMatch with the match details. If no matches are found an empty list is returned.

def findOrganisationByIR(nameQuery: String, datesOfFounding: List[String], countries: List[String], label: String): List[FinderMatch]

Method to find an organisation by lucene query string.

Method to find an organisation by lucene query string.

Value parameters

countries

A list with known countries. E.g. domicile, citizenship, country of birth etc. ISO-2, ISO-3 codes or names in en, de, fr and it (not recommended) are supported. Must not be null, empty list is allowed.

datesOfFounding

A list with known dates of founding. See DataNormalizer for supported string formats. Must not be null, empty list is allowed.

label

Optional. You can provide a label as search filter - if you have used them for indexing.

nameQuery

The lucene query string for searching the name part (*, +, -).

Attributes

Returns

Returns a list of FinderMatch with the match details. If no matches are found an empty list is returned. Information: No similarity value is provided with this method.

def findPerson(fullName: String, datesOfBirth: List[String], countries: List[String], label: String): List[FinderMatch]

Method to find a person by name with countries and dates of birth as filter. Optional you can use label as an additional filter (if is indexed).

Method to find a person by name with countries and dates of birth as filter. Optional you can use label as an additional filter (if is indexed).

Value parameters

countries

A list with known countries. E.g. domicile, citizenship, country of birth etc. ISO-2, ISO-3 codes or names in en, de, fr and it (not recommended) are supported. Must not be null, empty list is allowed.

datesOfBirth

A list with known dates of birth. See DataNormalizer for supported string formats. Must not be null, empty list is allowed.

fullName

The full name of the person, e.g. with middle- or maiden namen. But without title etc.

label

Optional. You can provide a label as search filter - if you have used them for indexing.

Attributes

Returns

Returns a list of FinderMatch with the match details. If no matches are found an empty list is returned.

def findPersonByIR(nameQuery: String, datesOfBirth: List[String], countries: List[String], label: String): List[FinderMatch]

Method to search a person using a lucene query string for the name part.

Method to search a person using a lucene query string for the name part.

Value parameters

countries

A list with known countries. E.g. domicile, citizenship, country of birth etc. ISO-2, ISO-3 codes or names in en, de, fr and it (not recommended) are supported. Must not be null, empty list is allowed.

datesOfBirth

A list with known dates of birth. See DataNormalizer for supported string formats. Must not be null, empty list is allowed.

label

Optional. You can provide a label as search filter - if you have used them for indexing.

nameQuery

The lucene query string for searching the name (*,+, -).

Attributes

Returns

Returns a list of FinderMatch with the match details. If no matches are found an empty list is returned. information: No similarity value is provided with this method.

def getDocCount(): Int

Return the number of documents in the index (persons and organisations).

Return the number of documents in the index (persons and organisations).

Attributes

def getLoadTime(): Date

Return the Date on which the object was created. Equivalent to the loading time of the index data.

Return the Date on which the object was created. Equivalent to the loading time of the index data.

Attributes