Facets

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

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Facets(fullTextSearch: List[String], generic: Map[String, List[String]], entities: List[Long], fromDate: Option[LocalDateTime], toDate: Option[LocalDateTime], fromTimeExpression: Option[LocalDateTime], toTimeExpression: Option[LocalDateTime])

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

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( ... )
val entities: List[Long]

a list of entity ids that should occur in the document.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val fromDate: Option[LocalDateTime]

start date for the document creation date (inclusive).
val fromTimeExpression: Option[LocalDateTime]

start date for the time expression mentioned in the document body (inclusive).
val fullTextSearch: List[String]

match documents that contain the given expression in the document body.
val generic: Map[String, List[String]]

a map linking from document metadata keys to a list of instances for this metadata.
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.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasDateFilter: Boolean

Returns true when the filter defines any date restriction such as the document creation date or a time expression occurring in the document.
Returns true when the filter defines any date restriction such as the document creation date or a time expression occurring in the document. False otherwise.
def isEmpty: Boolean

Returns true when the filter is empty i.e.
Returns true when the filter is empty i.e. it matches all documents. False otherwise.
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
val toDate: Option[LocalDateTime]

end date for the document creation date (inclusive).
val toTimeExpression: Option[LocalDateTime]

end date for the time expresson mentioned in the document body (inclusive).
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( ... )
def withEntities(ids: List[Long]): Facets

Related Docs: object Facets | package models

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

Instance Constructors

new Facets(fullTextSearch: List[String], generic: Map[String, List[String]], entities: List[Long], fromDate: Option[LocalDateTime], toDate: Option[LocalDateTime], fromTimeExpression: Option[LocalDateTime], toTimeExpression: Option[LocalDateTime])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val entities: List[Long]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val fromDate: Option[LocalDateTime]

val fromTimeExpression: Option[LocalDateTime]

val fullTextSearch: List[String]

val generic: Map[String, List[String]]

final def getClass(): Class[_]

def hasDateFilter: Boolean

def isEmpty: Boolean

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

val toDate: Option[LocalDateTime]

val toTimeExpression: Option[LocalDateTime]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withEntities(ids: List[Long]): Facets

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped