DocumentService

Abstract Value Members

abstract def addTag(docId: Long, label: String)(index: String): Tag

Annotates a document with the given label.
Annotates a document with the given label.
This function is useful for grouping documents according to a label. Documents associated with the same label belong to the same group. Each tag belongs exactly to one document. However, multiple tags can share the same label. In case the document is already annotated with the given label the existing models.Tag is returned.
docId
the document id corresponding to the document to annotate.
label
the label to assign.
index
the data source index or database name to query.
returns
a models.Tag representing the added tag or if already present the existing tag.
abstract def getById(docId: Long)(index: String): Option[Document]

Returns an option value of models.Document associated with the given id.
Returns an option value of models.Document associated with the given id.
docId
the document id to search for.
index
the data source index or database name to query.
returns
scala.Some if a document with the given id exists. scala.None otherwise.
abstract def getByTagLabel(label: String)(index: String): List[Document]

Returns a list of documents associated with the given tag label.
Returns a list of documents associated with the given tag label.
label
the tag label to search for.
index
the data source index or database name to query.
returns
a non-empty list of models.Document, if at least one document annotated with the given label exists. scala.Nil otherwise.

See also
See the method models.services.DocumentService#addTag to annotate documents with tags.
abstract def getDocumentLabels()(index: String): List[String]

Returns all distinct labels over all annotated models.Tag.
Returns all distinct labels over all annotated models.Tag.
index
the data source index or database name to query.
returns
a non-empty list of tag labels, if at least one tag is assigned to a document. scala.Nil otherwise.
abstract def getKeywords(docId: Long, size: Option[Int] = None)(index: String): List[KeyTerm]

Returns important terms occurring in the document content for the given document id.
Returns important terms occurring in the document content for the given document id.
docId
the document id.
size
the number of terms to fetch.
index
the data source index or database name to query.
returns
a list of models.KeyTerm representing important terms for the given document. scala.Nil if no important term is associated with the given document id.
abstract def getMetadata(docIds: List[Long], fields: List[String])(index: String): List[(Long, String, String)]

Returns metadata keys and values for the given document ids.
Returns metadata keys and values for the given document ids.
The function only returns metadata instances for the given keys in the field parameter.
docIds
a list of document ids.
fields
a filter for metadata keys.
index
the data source index or database name to query.
returns
a list of triple consisting of the document id, the metadata key and metadata value.
abstract def getMetadataKeys()(index: String): List[String]

Returns all unique metadata keys for the underlying collection.
abstract def getTags(docId: Long)(index: String): List[Tag]

Returns a list of models.Tag associated with the given document id.
Returns a list of models.Tag associated with the given document id.
docId
the document id.
index
the data source index or database name to query.
returns
a non-empty list of models.Tag, if at least one tag is associated with the given document id. scala.Nil otherwise.
abstract def removeTag(tagId: Int)(index: String): Boolean

Removes the tag from the document associated with the given id.
Removes the tag from the document associated with the given id.
tagId
the tag id associated with a document.
index
the data source index or database name to query.
returns
true, if the tag is removed successfully. False, in case the the tag does not exist.
abstract def searchDocuments(facets: Facets, pageSize: Int)(index: String): (Long, Iterator[Document])

Returns an iterator with documents matching the given search query.
Returns an iterator with documents matching the given search query.
The iterator acts lazy and queries for more documents once the number of consumed documents exceeds the page size.
facets
the search query.
pageSize
number of documents per page.
index
the data source index or database name to query.
returns
a tuple consisting of the total number of hits and a document iterator for the given query.

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

Abstract Value Members

abstract def addTag(docId: Long, label: String)(index: String): Tag

abstract def getById(docId: Long)(index: String): Option[Document]

abstract def getByTagLabel(label: String)(index: String): List[Document]

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

abstract def getKeywords(docId: Long, size: Option[Int] = None)(index: String): List[KeyTerm]

abstract def getMetadata(docIds: List[Long], fields: List[String])(index: String): List[(Long, String, String)]

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

abstract def getTags(docId: Long)(index: String): List[Tag]

abstract def removeTag(tagId: Int)(index: String): Boolean

abstract def searchDocuments(facets: Facets, pageSize: Int)(index: String): (Long, Iterator[Document])

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