NetworkService

Abstract Value Members

abstract def createNetwork(facets: Facets, nodeFraction: Map[String, Int], exclude: List[Long])(index: String): Network

Returns a co-occurrence network matching the given search query.
Returns a co-occurrence network matching the given search query.
facets
the search query.
nodeFraction
a map linking from entity types to the number of nodes to request for each type.
exclude
a list of entity ids that should be excluded from the result. The result will contain no models.NodeBucket associated with one of the ids given in this list.
index
the data source index or database name to query.
returns
a models.Network consisting of the nodes and relationships of the created co-occurrence network.
abstract def getEdgeKeywords(facets: Facets, source: Long, dest: Long, numTerms: Int)(index: String): List[KeyTerm]

Returns important terms representing the relationship between both nodes based on the underlying document content.
Returns important terms representing the relationship between both nodes based on the underlying document content.
facets
the search query.
source
the first adjacent node of the edge.
dest
the second adjacent node of the edge.
numTerms
the number of keywords to fetch.
index
the data source index or database name to query.
returns
a list of models.KeyTerm representing important terms for the given relationship.
abstract def getNeighborCountsPerType(facets: Facets, entityId: Long)(index: String): Map[String, Int]

Accumulates the number of entities that fall in a certain entity type and co-occur with the given entity.
Accumulates the number of entities that fall in a certain entity type and co-occur with the given entity.
The result will contain n different buckets with n representing the distinct entity types for the underlying collection.
facets
the search query.
entityId
the entity id.
index
the data source index or database name to query.
returns
a map linking from the unique entity type to the number of neighbors of that type.
abstract def getNeighbors(facets: Facets, entityId: Long, size: Int, exclude: List[Long])(index: String): List[NodeBucket]

Returns entities co-occurring with the given entity matching the search query.
Returns entities co-occurring with the given entity matching the search query.
facets
the search query.
entityId
the entity id.
size
the number of neighbors to fetch.
exclude
a list of entity ids that should be excluded from the result. The result will contain no models.NodeBucket associated with one of the ids given in this list.
index
the data source index or database name to query.
returns
a list of models.NodeBucket co-occurring with the given entity.
abstract def induceNetwork(facets: Facets, currentNetwork: List[Long], entitiesToAdd: List[Long])(index: String): Network

Adds new nodes to the current network matching the given search query.
Adds new nodes to the current network matching the given search query.
The method induces relationships and nodes for the given entitiesToAdd considering the already present network i.e. it induces relationships between the new nodes and the current network and between the new nodes. It does not provide nodes for the current network nor relationships between those nodes.
facets
the search query.
currentNetwork
the entity ids of the current network.
entitiesToAdd
new entities to be added to the network.
index
the data source index or database name to query.
returns
a models.Network consisting of the nodes and relationships of the created co-occurrence network.

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 NetworkService extends AnyRef

Abstract Value Members

abstract def createNetwork(facets: Facets, nodeFraction: Map[String, Int], exclude: List[Long])(index: String): Network

abstract def getEdgeKeywords(facets: Facets, source: Long, dest: Long, numTerms: Int)(index: String): List[KeyTerm]

abstract def getNeighborCountsPerType(facets: Facets, entityId: Long)(index: String): Map[String, Int]

abstract def getNeighbors(facets: Facets, entityId: Long, size: Int, exclude: List[Long])(index: String): List[NodeBucket]

abstract def induceNetwork(facets: Facets, currentNetwork: List[Long], entitiesToAdd: List[Long])(index: String): Network

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