EntityService

Abstract Value Members

abstract def blacklist(ids: List[Long])(index: String): Boolean

Marks the entities associated with the given ids as blacklisted.
Marks the entities associated with the given ids as blacklisted.
Blacklisted entities don't appear in any result set.
ids
the entity ids to blacklist.
index
the data source index or database name to query.
returns
true, if all entities are successfully marked as blacklisted. False if at least one entity is not correct marked.
abstract def changeName(id: Long, newName: String)(index: String): Boolean

Changes the name of the entity corresponding to the given entity id.
Changes the name of the entity corresponding to the given entity id.
id
the entity id to change.
newName
the new name to apply.
index
the data source index or database name to query.
returns
true, if the operation was successful. False otherwise.
abstract def changeType(id: Long, newType: String)(index: String): Boolean

Changes the type of the entity corresponding to the given entity id.
Changes the type of the entity corresponding to the given entity id.
id
the entity id to change.
newType
the new type to apply.
index
the data source index or database name to query.
returns
true, if the operation was successful. False otherwise.
abstract def getBlacklisted()(index: String): List[Entity]

Returns all blacklisted entities for the underlying collection.
Returns all blacklisted entities for the underlying collection.
index
the data source index or database name to query.
returns
a list of models.Entity, where each entity is marked as blacklisted.
abstract def getByIds(ids: List[Long])(index: String): List[Entity]

Returns a list of models.Entity matching the given entity ids.
Returns a list of models.Entity matching the given entity ids.
ids
a list of entity ids.
index
the data source index or database name to query.
returns
a list of models.Entity corresponding to the given ids or scala.Nil if no matching entity is found.
abstract def getEntityFragments(docId: Long)(index: String): List[(Entity, Fragment)]

Returns all entity occurrences for the given document including their position in the document.
Returns all entity occurrences for the given document including their position in the document.
docId
the document id.
index
the data source index or database name to query.
returns
a list of tuple consisting of an entity and its position in the document.
abstract def getMerged()(index: String): Map[Entity, List[Entity]]

Returns all merged entities for the underlying collection.
Returns all merged entities for the underlying collection.
index
the data source index or database name to query.
returns
a map linking from the focal entity to its duplicates.
abstract def getTypes()(index: String): List[String]

Returns a list of distinct entity types in the underlying collection.
abstract def merge(focalId: Long, duplicates: List[Long])(index: String): Boolean

Merges multiple nodes in a given focal node.
Merges multiple nodes in a given focal node.
The duplicates don't appear in any result set anymore. Further, any entity-related search using the focal node as instance also queries for its duplicates i.e. searching for "Angela Merkel" will also search for "Angela" or "Dr. Merkel".
focalId
the central entity id.
duplicates
entity ids referring to similar textual mentions of the focal id.
index
the data source index or database name to query.
returns
true, if the operation was successful. False otherwise.
abstract def undoBlacklist(ids: List[Long])(index: String): Boolean

Removes the blacklisted mark from the entities associated with the given ids.
Removes the blacklisted mark from the entities associated with the given ids.
After executing this operation, the respective entities do appear in result sets again.
ids
the entity ids to remove the blacklist mark from.
index
the data source index or database name to query.
returns
true, if the blacklist mark is successfully removed from all entities. False if at least one blacklist mark for an entity is not correct removed.
abstract def undoMerge(focalIds: List[Long])(index: String): Boolean

Withdraws models.services.EntityService#merge for the given entity id.
Withdraws models.services.EntityService#merge for the given entity id.
focalIds
the central entity ids.
index
the data source index or database name to query.
returns
true, if the removal was successful. False otherwise.

Concrete 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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package services

trait EntityService extends AnyRef

Abstract Value Members

abstract def blacklist(ids: List[Long])(index: String): Boolean

abstract def changeName(id: Long, newName: String)(index: String): Boolean

abstract def changeType(id: Long, newType: String)(index: String): Boolean

abstract def getBlacklisted()(index: String): List[Entity]

abstract def getByIds(ids: List[Long])(index: String): List[Entity]

abstract def getEntityFragments(docId: Long)(index: String): List[(Entity, Fragment)]

abstract def getMerged()(index: String): Map[Entity, List[Entity]]

abstract def getTypes()(index: String): List[String]

abstract def merge(focalId: Long, duplicates: List[Long])(index: String): Boolean

abstract def undoBlacklist(ids: List[Long])(index: String): Boolean

abstract def undoMerge(focalIds: List[Long])(index: String): Boolean

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped