Packages

c

esc.index

Indexer

class Indexer extends AnyRef

Class that provides the necessary functions to index individuals and organizations. As a help you can create an instance of the class using the IndexFactory.

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

Instance Constructors

  1. new Indexer(indexWriter: IndexWriter, similarityConfig: SimilarityConfig = new SimilarityConfig())

    indexWriter

    Lucene IndexWriter.

    similarityConfig

    Optional. A SimilarityConfiguration.

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

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

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def close(): Boolean

    Close the index.

  9. def commit(): Boolean

    Commit the changes to the index.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. val indexWriter: IndexWriter
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. 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.

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

  22. val similarityConfig: SimilarityConfig
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. 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.

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

  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped