models

Type Members

1. case class Aggregation(key: String, buckets: List[Bucket]) extends Product with Serializable

   

   Top-level aggregation representation.

   Top-level aggregation representation.

   key

   the name of the aggregation.

   buckets

   a list of models.Bucket representing the distinct aggregated result values.

2. sealed abstract class Bucket extends AnyRef

   

   Abstract representation for the bucketing aggregation.

3. case class Document(id: Long, content: String, created: LocalDateTime, highlightedContent: Option[String] = None) extends Product with Serializable

   

   Document representation.

   Document representation.

   id

   unique document identifier.

   content

   document body containing raw text.

   created

   creation date and time of the document.

   highlightedContent

   document content enriched with tags ( [...] ) for highlighting. This field is used to highlight full-text search results.

4. case class Entity(id: Long, name: String, entityType: String, freq: Int) extends Product with Serializable

   

   Representation for an entity.

   Representation for an entity.

   id

   unique id and primary key of the entity.

   name

   the entity name.

   entityType

   the entity type e.g. Person, Organisation, Location or Miscellaneous.

   freq

   the document occurrence i.e. in how many documents does this entity occur.

5. case class Facets(fullTextSearch: List[String], generic: Map[String, List[String]], entities: List[Long], fromDate: Option[LocalDateTime], toDate: Option[LocalDateTime], fromTimeExpression: Option[LocalDateTime], toTimeExpression: Option[LocalDateTime]) extends Product with Serializable

   

   Representation for a search query to find the most relevant documents.

   Representation for a search query to find the most relevant documents.

   fullTextSearch

   match documents that contain the given expression in the document body.

   generic

   a map linking from document metadata keys to a list of instances for this metadata. Different metadata keys are joined via a logical and, whereas different instances of the same metadata key are joined via a logical or.

   entities

   a list of entity ids that should occur in the document.

   fromDate

   start date for the document creation date (inclusive).

   toDate

   end date for the document creation date (inclusive).

   fromTimeExpression

   start date for the time expression mentioned in the document body (inclusive).

   toTimeExpression

   end date for the time expresson mentioned in the document body (inclusive).

6. case class Fragment(start: Int, end: Int) extends Product with Serializable

   

   Representation for an entity occurrence within the body of a document.

   Representation for an entity occurrence within the body of a document.

   start

   the offset start of the entity occurrence.

   end

   the offset end of the entity occurrence.

7. case class IteratorSession(hits: Long, hitIterator: Iterator[Document], hash: Long) extends Product with Serializable

   

   Storage representation for the document iterator.

   Storage representation for the document iterator.

   This representation is used to store the current document iterator matching a search query between different user requests.

   hits

   the number of documents matching the search query.

   hitIterator

   the document iterator consisting of documents matching the search query.

   hash

   the hash code of the search query i.e. models.Facets#hashCode.

   See also

   For usage see controllers.DocumentController.

8. case class KeyTerm(term: String, score: Int) extends Product with Serializable

   

   Representation for important terms including their importance value.

   Representation for important terms including their importance value.

   term

   the important term value.

   score

   the score of the important term. Higher values represent more important terms.

9. case class MetaDataBucket(key: String, occurrence: Long) extends Bucket with Product with Serializable

   

   Aggregated result representation for generic metadata such as "Sender_name" or "Classification_level".

   Aggregated result representation for generic metadata such as "Sender_name" or "Classification_level".

   key

   the name of the aggregated value.

   occurrence

   the number of times this instance occurs in the background collection.

10. case class Network(nodes: List[NodeBucket], relations: List[Relationship]) extends Product with Serializable

    

    Representation for a co-occurrence network.

    Representation for a co-occurrence network.

    nodes

    the vertices of the network.

    relations

    the edges of the network.

11. case class NodeBucket(id: Long, occurrence: Long) extends Bucket with Product with Serializable

    

    Aggregated result representation for entities.

    Aggregated result representation for entities.

    id

    the id of the entity.

    occurrence

    the number of times the entity occurs in the background collection.

12. case class Relationship(source: Long, dest: Long, occurrence: Long) extends Product with Serializable

    

    Representation for a relationship.

    Representation for a relationship.

    source

    the first adjacent node.

    dest

    the second adjacent node.

    occurrence

    the document occurrence i.e. in how many documents does this relationship occur.

13. case class Tag(id: Long, documentId: Long, label: String) extends Product with Serializable

    

    Representation for a document tag.

    Representation for a document tag.

    id

    the unique tag id.

    documentId

    the unique document id.

    label

    the corresponding tag label.