Packages

c

esc.index

Finder

class Finder extends AnyRef

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).

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Finder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Finder(indexSearcher: IndexSearcher, similarityConfig: SimilarityConfig = new SimilarityConfig(), adrCheckStopWords: List[String] = List[String](), adrCheckHitWords: List[String] = List[String]())

    indexSearcher

    Lucene IndexSearcher.

    similarityConfig

    Optional.Similarity configuration.

    adrCheckStopWords

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

    adrCheckHitWords

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val addressNormalizer: AddressNormalizer
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def findByAddress(address: String, label: String = ""): List[FinderMatch]
  10. 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. 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.

    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.

  11. 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. 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.

    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. Information: No similarity value is provided with this method.

  12. 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, ISO-3 codes or names in en, de, fr and it (not recommended) 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.

  13. 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, ISO-3 codes or names in en, de, fr and it (not recommended) 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. information: No similarity value is provided with this method.

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def getDocCount(): Int

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

  16. def getLoadTime(): Date

    Return the Date on which the object was created.

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

  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. val indexSearcher: IndexSearcher
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val loadTimestamp: Date
  21. val nameNormalizer: NameNormalizer
  22. val nameSimilarity: NameSimilarity
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. val similarityConfig: SimilarityConfig
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped