Class

controllers

DocumentController

Related Doc: package controllers

Permalink

class DocumentController extends Controller

Provides document related actions.

Linear Supertypes
Controller, Rendering, RequestExtractors, AcceptExtractors, ContentTypes, HeaderNames, play.api.http.Status, HttpProtocol, BodyParsers, Results, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DocumentController
  2. Controller
  3. Rendering
  4. RequestExtractors
  5. AcceptExtractors
  6. ContentTypes
  7. HeaderNames
  8. Status
  9. HttpProtocol
  10. BodyParsers
  11. Results
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentController(cache: CacheApi, documentService: DocumentService, dateUtils: DateUtils)

    Permalink

    cache

    the application cache.

    documentService

    the service for document backend operations.

    dateUtils

    common helper for date and time operations.

    Annotations
    @Inject()

Type Members

  1. class Status extends Result

    Permalink
    Definition Classes
    Results

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val ACCEPT: String

    Permalink
    Definition Classes
    HeaderNames
  5. val ACCEPTED: Int

    Permalink
    Definition Classes
    Status
  6. val ACCEPT_CHARSET: String

    Permalink
    Definition Classes
    HeaderNames
  7. val ACCEPT_ENCODING: String

    Permalink
    Definition Classes
    HeaderNames
  8. val ACCEPT_LANGUAGE: String

    Permalink
    Definition Classes
    HeaderNames
  9. val ACCEPT_RANGES: String

    Permalink
    Definition Classes
    HeaderNames
  10. val ACCESS_CONTROL_ALLOW_CREDENTIALS: String

    Permalink
    Definition Classes
    HeaderNames
  11. val ACCESS_CONTROL_ALLOW_HEADERS: String

    Permalink
    Definition Classes
    HeaderNames
  12. val ACCESS_CONTROL_ALLOW_METHODS: String

    Permalink
    Definition Classes
    HeaderNames
  13. val ACCESS_CONTROL_ALLOW_ORIGIN: String

    Permalink
    Definition Classes
    HeaderNames
  14. val ACCESS_CONTROL_EXPOSE_HEADERS: String

    Permalink
    Definition Classes
    HeaderNames
  15. val ACCESS_CONTROL_MAX_AGE: String

    Permalink
    Definition Classes
    HeaderNames
  16. val ACCESS_CONTROL_REQUEST_HEADERS: String

    Permalink
    Definition Classes
    HeaderNames
  17. val ACCESS_CONTROL_REQUEST_METHOD: String

    Permalink
    Definition Classes
    HeaderNames
  18. val AGE: String

    Permalink
    Definition Classes
    HeaderNames
  19. val ALLOW: String

    Permalink
    Definition Classes
    HeaderNames
  20. val AUTHORIZATION: String

    Permalink
    Definition Classes
    HeaderNames
  21. val Accepted: Status

    Permalink
    Definition Classes
    Results
  22. val BAD_GATEWAY: Int

    Permalink
    Definition Classes
    Status
  23. val BAD_REQUEST: Int

    Permalink
    Definition Classes
    Status
  24. val BINARY: String

    Permalink
    Definition Classes
    ContentTypes
  25. val BadGateway: Status

    Permalink
    Definition Classes
    Results
  26. val BadRequest: Status

    Permalink
    Definition Classes
    Results
  27. val CACHE_CONTROL: String

    Permalink
    Definition Classes
    HeaderNames
  28. val CACHE_MANIFEST: String

    Permalink
    Definition Classes
    ContentTypes
  29. val CHUNKED: String

    Permalink
    Definition Classes
    HttpProtocol
  30. val CONFLICT: Int

    Permalink
    Definition Classes
    Status
  31. val CONNECTION: String

    Permalink
    Definition Classes
    HeaderNames
  32. val CONTENT_DISPOSITION: String

    Permalink
    Definition Classes
    HeaderNames
  33. val CONTENT_ENCODING: String

    Permalink
    Definition Classes
    HeaderNames
  34. val CONTENT_LANGUAGE: String

    Permalink
    Definition Classes
    HeaderNames
  35. val CONTENT_LENGTH: String

    Permalink
    Definition Classes
    HeaderNames
  36. val CONTENT_LOCATION: String

    Permalink
    Definition Classes
    HeaderNames
  37. val CONTENT_MD5: String

    Permalink
    Definition Classes
    HeaderNames
  38. val CONTENT_RANGE: String

    Permalink
    Definition Classes
    HeaderNames
  39. val CONTENT_TRANSFER_ENCODING: String

    Permalink
    Definition Classes
    HeaderNames
  40. val CONTENT_TYPE: String

    Permalink
    Definition Classes
    HeaderNames
  41. val CONTINUE: Int

    Permalink
    Definition Classes
    Status
  42. val COOKIE: String

    Permalink
    Definition Classes
    HeaderNames
  43. val CREATED: Int

    Permalink
    Definition Classes
    Status
  44. def CSS(implicit codec: Codec): String

    Permalink
    Definition Classes
    ContentTypes
  45. val Conflict: Status

    Permalink
    Definition Classes
    Results
  46. val Created: Status

    Permalink
    Definition Classes
    Results
  47. val DATE: String

    Permalink
    Definition Classes
    HeaderNames
  48. val ETAG: String

    Permalink
    Definition Classes
    HeaderNames
  49. def EVENT_STREAM(implicit codec: Codec): String

    Permalink
    Definition Classes
    ContentTypes
  50. val EXPECT: String

    Permalink
    Definition Classes
    HeaderNames
  51. val EXPECTATION_FAILED: Int

    Permalink
    Definition Classes
    Status
  52. val EXPIRES: String

    Permalink
    Definition Classes
    HeaderNames
  53. val EntityTooLarge: Status

    Permalink
    Definition Classes
    Results
  54. val ExpectationFailed: Status

    Permalink
    Definition Classes
    Results
  55. val FAILED_DEPENDENCY: Int

    Permalink
    Definition Classes
    Status
  56. val FORBIDDEN: Int

    Permalink
    Definition Classes
    Status
  57. val FORM: String

    Permalink
    Definition Classes
    ContentTypes
  58. val FORWARDED: String

    Permalink
    Definition Classes
    HeaderNames
  59. val FOUND: Int

    Permalink
    Definition Classes
    Status
  60. val FROM: String

    Permalink
    Definition Classes
    HeaderNames
  61. val FailedDependency: Status

    Permalink
    Definition Classes
    Results
  62. val Forbidden: Status

    Permalink
    Definition Classes
    Results
  63. def Found(url: String): Result

    Permalink
    Definition Classes
    Results
  64. val GATEWAY_TIMEOUT: Int

    Permalink
    Definition Classes
    Status
  65. val GONE: Int

    Permalink
    Definition Classes
    Status
  66. val GatewayTimeout: Status

    Permalink
    Definition Classes
    Results
  67. val Gone: Status

    Permalink
    Definition Classes
    Results
  68. val HOST: String

    Permalink
    Definition Classes
    HeaderNames
  69. def HTML(implicit codec: Codec): String

    Permalink
    Definition Classes
    ContentTypes
  70. val HTTP_1_0: String

    Permalink
    Definition Classes
    HttpProtocol
  71. val HTTP_1_1: String

    Permalink
    Definition Classes
    HttpProtocol
  72. val HTTP_VERSION_NOT_SUPPORTED: Int

    Permalink
    Definition Classes
    Status
  73. val HttpVersionNotSupported: Status

    Permalink
    Definition Classes
    Results
  74. val IF_MATCH: String

    Permalink
    Definition Classes
    HeaderNames
  75. val IF_MODIFIED_SINCE: String

    Permalink
    Definition Classes
    HeaderNames
  76. val IF_NONE_MATCH: String

    Permalink
    Definition Classes
    HeaderNames
  77. val IF_RANGE: String

    Permalink
    Definition Classes
    HeaderNames
  78. val IF_UNMODIFIED_SINCE: String

    Permalink
    Definition Classes
    HeaderNames
  79. val INSUFFICIENT_STORAGE: Int

    Permalink
    Definition Classes
    Status
  80. val INTERNAL_SERVER_ERROR: Int

    Permalink
    Definition Classes
    Status
  81. val InsufficientStorage: Status

    Permalink
    Definition Classes
    Results
  82. val InternalServerError: Status

    Permalink
    Definition Classes
    Results
  83. def JAVASCRIPT(implicit codec: Codec): String

    Permalink
    Definition Classes
    ContentTypes
  84. val JSON: String

    Permalink
    Definition Classes
    ContentTypes
  85. val LAST_MODIFIED: String

    Permalink
    Definition Classes
    HeaderNames
  86. val LENGTH_REQUIRED: Int

    Permalink
    Definition Classes
    Status
  87. val LOCATION: String

    Permalink
    Definition Classes
    HeaderNames
  88. val LOCKED: Int

    Permalink
    Definition Classes
    Status
  89. val Locked: Status

    Permalink
    Definition Classes
    Results
  90. val MAX_FORWARDS: String

    Permalink
    Definition Classes
    HeaderNames
  91. val METHOD_NOT_ALLOWED: Int

    Permalink
    Definition Classes
    Status
  92. val MOVED_PERMANENTLY: Int

    Permalink
    Definition Classes
    Status
  93. val MULTIPLE_CHOICES: Int

    Permalink
    Definition Classes
    Status
  94. val MULTI_STATUS: Int

    Permalink
    Definition Classes
    Status
  95. val MethodNotAllowed: Status

    Permalink
    Definition Classes
    Results
  96. def MovedPermanently(url: String): Result

    Permalink
    Definition Classes
    Results
  97. val MultiStatus: Status

    Permalink
    Definition Classes
    Results
  98. val NON_AUTHORITATIVE_INFORMATION: Int

    Permalink
    Definition Classes
    Status
  99. val NOT_ACCEPTABLE: Int

    Permalink
    Definition Classes
    Status
  100. val NOT_FOUND: Int

    Permalink
    Definition Classes
    Status
  101. val NOT_IMPLEMENTED: Int

    Permalink
    Definition Classes
    Status
  102. val NOT_MODIFIED: Int

    Permalink
    Definition Classes
    Status
  103. val NO_CONTENT: Int

    Permalink
    Definition Classes
    Status
  104. val NoContent: Result

    Permalink
    Definition Classes
    Results
  105. val NonAuthoritativeInformation: Status

    Permalink
    Definition Classes
    Results
  106. val NotAcceptable: Status

    Permalink
    Definition Classes
    Results
  107. val NotFound: Status

    Permalink
    Definition Classes
    Results
  108. val NotImplemented: Status

    Permalink
    Definition Classes
    Results
  109. val NotModified: Result

    Permalink
    Definition Classes
    Results
  110. val OK: Int

    Permalink
    Definition Classes
    Status
  111. val ORIGIN: String

    Permalink
    Definition Classes
    HeaderNames
  112. val Ok: Status

    Permalink
    Definition Classes
    Results
  113. val PARTIAL_CONTENT: Int

    Permalink
    Definition Classes
    Status
  114. val PAYMENT_REQUIRED: Int

    Permalink
    Definition Classes
    Status
  115. val PERMANENT_REDIRECT: Int

    Permalink
    Definition Classes
    Status
  116. val PRAGMA: String

    Permalink
    Definition Classes
    HeaderNames
  117. val PRECONDITION_FAILED: Int

    Permalink
    Definition Classes
    Status
  118. val PROXY_AUTHENTICATE: String

    Permalink
    Definition Classes
    HeaderNames
  119. val PROXY_AUTHENTICATION_REQUIRED: Int

    Permalink
    Definition Classes
    Status
  120. val PROXY_AUTHORIZATION: String

    Permalink
    Definition Classes
    HeaderNames
  121. val PartialContent: Status

    Permalink
    Definition Classes
    Results
  122. val PaymentRequired: Status

    Permalink
    Definition Classes
    Results
  123. def PermanentRedirect(url: String): Result

    Permalink
    Definition Classes
    Results
  124. val PreconditionFailed: Status

    Permalink
    Definition Classes
    Results
  125. val RANGE: String

    Permalink
    Definition Classes
    HeaderNames
  126. val REFERER: String

    Permalink
    Definition Classes
    HeaderNames
  127. val REQUESTED_RANGE_NOT_SATISFIABLE: Int

    Permalink
    Definition Classes
    Status
  128. val REQUEST_ENTITY_TOO_LARGE: Int

    Permalink
    Definition Classes
    Status
  129. val REQUEST_TIMEOUT: Int

    Permalink
    Definition Classes
    Status
  130. val REQUEST_URI_TOO_LONG: Int

    Permalink
    Definition Classes
    Status
  131. val RESET_CONTENT: Int

    Permalink
    Definition Classes
    Status
  132. val RETRY_AFTER: String

    Permalink
    Definition Classes
    HeaderNames
  133. def Redirect(call: Call, status: Int): Result

    Permalink
    Definition Classes
    Results
  134. def Redirect(call: Call): Result

    Permalink
    Definition Classes
    Results
  135. def Redirect(url: String, queryString: Map[String, Seq[String]], status: Int): Result

    Permalink
    Definition Classes
    Results
  136. def Redirect(url: String, status: Int): Result

    Permalink
    Definition Classes
    Results
  137. val RequestTimeout: Status

    Permalink
    Definition Classes
    Results
  138. val ResetContent: Result

    Permalink
    Definition Classes
    Results
  139. val SEE_OTHER: Int

    Permalink
    Definition Classes
    Status
  140. val SERVER: String

    Permalink
    Definition Classes
    HeaderNames
  141. val SERVICE_UNAVAILABLE: Int

    Permalink
    Definition Classes
    Status
  142. val SET_COOKIE: String

    Permalink
    Definition Classes
    HeaderNames
  143. val SET_COOKIE2: String

    Permalink
    Definition Classes
    HeaderNames
  144. val SWITCHING_PROTOCOLS: Int

    Permalink
    Definition Classes
    Status
  145. def SeeOther(url: String): Result

    Permalink
    Definition Classes
    Results
  146. val ServiceUnavailable: Status

    Permalink
    Definition Classes
    Results
  147. def Status(code: Int): Status

    Permalink
    Definition Classes
    Results
  148. val TE: String

    Permalink
    Definition Classes
    HeaderNames
  149. val TEMPORARY_REDIRECT: Int

    Permalink
    Definition Classes
    Status
  150. def TEXT(implicit codec: Codec): String

    Permalink
    Definition Classes
    ContentTypes
  151. val TODO: Action[AnyContent]

    Permalink
    Definition Classes
    Controller
  152. val TOO_MANY_REQUESTS: Int

    Permalink
    Definition Classes
    Status
  153. val TRAILER: String

    Permalink
    Definition Classes
    HeaderNames
  154. val TRANSFER_ENCODING: String

    Permalink
    Definition Classes
    HeaderNames
  155. def TemporaryRedirect(url: String): Result

    Permalink
    Definition Classes
    Results
  156. val TooManyRequests: Status

    Permalink
    Definition Classes
    Results
  157. val UNAUTHORIZED: Int

    Permalink
    Definition Classes
    Status
  158. val UNPROCESSABLE_ENTITY: Int

    Permalink
    Definition Classes
    Status
  159. val UNSUPPORTED_MEDIA_TYPE: Int

    Permalink
    Definition Classes
    Status
  160. val UPGRADE: String

    Permalink
    Definition Classes
    HeaderNames
  161. val UPGRADE_REQUIRED: Int

    Permalink
    Definition Classes
    Status
  162. val USER_AGENT: String

    Permalink
    Definition Classes
    HeaderNames
  163. val USE_PROXY: Int

    Permalink
    Definition Classes
    Status
  164. val Unauthorized: Status

    Permalink
    Definition Classes
    Results
  165. val UnprocessableEntity: Status

    Permalink
    Definition Classes
    Results
  166. val UnsupportedMediaType: Status

    Permalink
    Definition Classes
    Results
  167. val UriTooLong: Status

    Permalink
    Definition Classes
    Results
  168. val VARY: String

    Permalink
    Definition Classes
    HeaderNames
  169. val VIA: String

    Permalink
    Definition Classes
    HeaderNames
  170. val WARNING: String

    Permalink
    Definition Classes
    HeaderNames
  171. val WWW_AUTHENTICATE: String

    Permalink
    Definition Classes
    HeaderNames
  172. def XML(implicit codec: Codec): String

    Permalink
    Definition Classes
    ContentTypes
  173. val X_FORWARDED_FOR: String

    Permalink
    Definition Classes
    HeaderNames
  174. val X_FORWARDED_HOST: String

    Permalink
    Definition Classes
    HeaderNames
  175. val X_FORWARDED_PORT: String

    Permalink
    Definition Classes
    HeaderNames
  176. val X_FORWARDED_PROTO: String

    Permalink
    Definition Classes
    HeaderNames
  177. val X_REQUESTED_WITH: String

    Permalink
    Definition Classes
    HeaderNames
  178. def addTag(id: Int, label: String): Action[AnyContent]

    Permalink

    Annotates a document with the given label.

    Annotates a document with the given label.

    id

    the document id to annotate.

    label

    the label to assign.

    returns

    the added tag or if already present the existing tag.

  179. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  180. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  181. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  182. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  183. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  185. def getDocs(fullText: List[String], generic: Map[String, List[String]], entities: List[Long], timeRange: String, timeExprRange: String): Action[AnyContent]

    Permalink

    Search for documents given a search query.

    Search for documents given a search query.

    fullText

    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.

    entities

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

    timeRange

    a string representing a time range for the document creation date.

    timeExprRange

    a string representing a time range for the document time expression.

    returns

    list of matching documents with their metadata.

  186. def getDocsByLabel(label: String): Action[AnyContent]

    Permalink

    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.

    returns

    a list of documents associated with the given tag label.

  187. def getKeywordsById(id: Int, size: Int): Action[AnyContent]

    Permalink

    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.

    id

    the document id.

    size

    the number of terms to fetch.

    returns

    a list of terms representing important keywords for the given document.

  188. def getTagLabels(): Action[AnyContent]

    Permalink

    Returns all distinct annotated document labels.

  189. def getTagsByDocId(id: Int): Action[AnyContent]

    Permalink

    Returns a list of tags associated with the given document id.

    Returns a list of tags associated with the given document id.

    id

    the document id.

    returns

    a list of tags.

  190. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AnyRef
  193. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  194. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  195. def removeTagById(tagId: Int): Action[AnyContent]

    Permalink

    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.

  196. implicit def request2flash(implicit request: RequestHeader): Flash

    Permalink
    Definition Classes
    Controller
  197. implicit def request2lang(implicit request: RequestHeader): Lang

    Permalink
    Definition Classes
    Controller
  198. implicit def request2session(implicit request: RequestHeader): Session

    Permalink
    Definition Classes
    Controller
  199. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  200. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  201. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  202. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  204. def withCharset(mimeType: String)(implicit codec: Codec): String

    Permalink
    Definition Classes
    ContentTypes

Deprecated Value Members

  1. val TOO_MANY_REQUEST: Int

    Permalink
    Definition Classes
    Status
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use TOO_MANY_REQUESTS instead

  2. val TooManyRequest: Status

    Permalink
    Definition Classes
    Results
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use TooManyRequests instead

Inherited from Controller

Inherited from Rendering

Inherited from RequestExtractors

Inherited from AcceptExtractors

Inherited from ContentTypes

Inherited from HeaderNames

Inherited from play.api.http.Status

Inherited from HttpProtocol

Inherited from BodyParsers

Inherited from Results

Inherited from AnyRef

Inherited from Any

Ungrouped