class Finder extends AnyRef
Class that provides the necessary functions to find individuals and organizations. As a help you can create an instance of the class using the IndexFactory.
- Alphabetic
- By Inheritance
- Finder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Finder(indexSearcher: IndexSearcher, similarityConfig: SimilarityConfig = new SimilarityConfig())
- indexSearcher
Lucene IndexSearcher.
- similarityConfig
Optional.Similarity configuration.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- 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.
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).
- fullName
The full name of the organisation, incl. the legal form.
- datesOfFounding
A list with known dates of founding. See DataNormalizer for supported string formats. Must not be null, empty list is allowed.
- countries
A list with known countries. Most likeley the domicile(s). ISO-2 codes an names in en, de, fr and it are supported. 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.
- 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.
- nameQuery
The lucene query string for searching the name part.
- datesOfFounding
A list with known dates of founding. See DataNormalizer for supported string formats. Must not be null, empty list is allowed.
- countries
A list with known countries. Most likeley the domicile(s). ISO-2 codes an names in en, de, fr and it are supported. 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.
- returns
Returns a list of FinderMatch with the match details. If no matches are found an empty list is returned.
- 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.
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).
- fullName
The full name of the person, e.g. with middle- or maiden namen. But without title etc.
- datesOfBirth
A list with known dates of birth. See DataNormalizer for supported string formats. Must not be null, empty list is allowed.
- countries
A list with known countries. E.g. domicile, citizenship, country of birth etc. ISO-2 codes an names in en, de, fr and it are supported. 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.
- 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.
- nameQuery
The lucene query string for searching the name.
- datesOfBirth
A list with known dates of birth. See DataNormalizer for supported string formats. Must not be null, empty list is allowed.
- countries
A list with known countries. E.g. domicile, citizenship, country of birth etc. ISO-2 codes an names in en, de, fr and it are supported. 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.
- returns
Returns a list of FinderMatch with the match details. If no matches are found an empty list is returned.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val indexSearcher: IndexSearcher
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val nameNormalizer: NameNormalizer
- val nameSimilarity: NameSimilarity
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val similarityConfig: SimilarityConfig
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()