net.revenj.patterns.Report.scala Maven / Gradle / Ivy

Go to download
package net.revenj.patterns

import scala.concurrent.Future

/** Report is concept for aggregating multiple calls into a single object.
  * By providing search arguments and specifying queries with search predicates,
  * order, limit and offset using LINQ data will be populated on the server.
  *
  * DSL example:
  * {{{
  * module Blog {
  *   aggregate Post {
  *     Timestamp createdAt { versioning; }
  *     String    author;
  *     String    content;
  *   }
  *
  *   report FindPosts {
  *     String? byAuthor;
  *     Date?   from;
  *     Set   postsFromAuthor 'it => it.author == byAuthor' ORDER BY createdAt;
  *     Array recentPosts 'it => it.createdAt >= from' LIMIT 20 ORDER BY createdAt DESC;
  *   }
  * }
  * }}}
  */
trait Report[T] {
  def populate(locator: ServiceLocator): Future[T]
}

trait ReportAspect[R, T <: Report[R]] {
  def before(report: T): T = report
  def after(result: R): R = result
}