class Indexer extends AnyRef
Class that provides the necessary functions to index individuals and organisations. As a help you can create an instance of the class using the IndexFactory (recommended).
- Alphabetic
- By Inheritance
- Indexer
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Indexer(indexWriter: IndexWriter, similarityConfig: SimilarityConfig = new SimilarityConfig())
- indexWriter
Lucene IndexWriter.
- similarityConfig
Optional. A SimilarityConfiguration.
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
- def addOrganisation(organisation: IndexOrganisation): Boolean
Add an organisation to the index.
Add an organisation to the index. If an organisation has several names (e.g. alternative spellings, abbreviations etc.), the organisation must be added several times. You can add the same id several times. But this is not recommended! You get problems when updating the person by id. Recommended solution: Add different ids (e.g. with post-fix) and use the externalId as your unique id. You can configure (SimilarityConfig) whether the best match is selected/grouped by id oder externalId.
- organisation
The organisation object for adding to the index.
- def addPerson(person: IndexPerson): Boolean
Add a person to the index.
Add a person to the index. If a person has several names (e.g. alternative spellings, abbreviations or artist names etc.), the person must be added several times. You can add the same id several times. But this is not recommended! You get problems when updating the person by id. Recommended solution: Add different ids (e.g. with post-fix) and use the externalId as your unique id. You can configure (SimilarityConfig) whether the best match is selected/grouped by id oder externalId.
- person
The person object for adding to the index.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def close(): Boolean
Close the index.
- def commit(): Boolean
Commit the changes to the index.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val indexWriter: IndexWriter
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def removeOrganisation(organisationId: String): Boolean
Removes an organisation from the index.
Removes an organisation from the index.
- organisationId
The id of the organisation (the IndexOrganisation.id attribute when added).
- def removePerson(personId: String): Boolean
Removes a person from the index.
Removes a person from the index.
- personId
The id of the person (the IndexPerson.id attribute when added).
- val similarityConfig: SimilarityConfig
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def updateOrganisation(organisation: IndexOrganisation): Boolean
Update an organisation.
Update an organisation.
- organisation
IndexOrganisation with the new values. The id is relevant for selection the person to update.
- def updatePerson(person: IndexPerson): Boolean
Update a person.
Update a person.
- person
IndexPerson with the new values. The id is relevant for selection the person to update.
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)