DocumentServiceDefault

Instance Constructors

new DocumentServiceDefault(db: DB, scalaCache: ScalaCachePool, userRepository: UserRepository, documentRepository: DocumentRepository, revisionRepository: RevisionRepository)

Type Members

case class PushResult(document: Document, revision: Revision, serverOps: IndexedSeq[Revision]) extends Product with Serializable

A case class encapsulating the result of a push operation.
A case class encapsulating the result of a push operation.
document
the updated copy of the document
revision
the pushed revision that as it was actually stored in the database, transformed against more recent revisions. This can be sent to other clients to update their document.
serverOps
The more recent revisions that have been applied to the server since this revision's version.

Definition Classes
DocumentService

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
implicit def cache: ScalaCachePool
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit def conn: Connection
def create(id: UUID = UUID.random, owner: User, title: String, initialDelta: Delta): Future[\/[Fail, Document]]

Create a new document.
Create a new document.
id
title
initialDelta
TODO - can have default value Delta(IndexedSeq.empty[Operation]), if it is not empty it should have record in document_revisions table
returns

Definition Classes
DocumentServiceDefault → DocumentService
val db: DB

Database connection (pool).
Database connection (pool). Services will take connections from this pool when making repository calls.

Definition Classes
DocumentServiceDefault → Service
val documentRepository: DocumentRepository

Definition Classes
DocumentServiceDefault → DocumentService
implicit def eitherRunner[B](eithert: EitherT[Future, Fail, B]): Future[\/[Fail, B]]

Definition Classes
Lifting
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] )
def find(id: UUID, version: Option[Long] = None): Future[\/[Fail, Document]]

Find a document.
Find a document.
id
returns

Definition Classes
DocumentServiceDefault → DocumentService
implicit val futureMonad: Monad[Future]

Definition Classes
FutureMonad
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getHistory(documentId: UUID, granularity: Int = 10): Future[\/[Fail, IndexedSeq[Revision]]]

Get a list of revisions spaced by "granularity"
Get a list of revisions spaced by "granularity"
documentId
granularity
returns

Definition Classes
DocumentServiceDefault → DocumentService
def hashCode(): Int

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

Definition Classes
Any
def lift[B]: (Future[\/[Fail, B]]) ⇒ EitherT[Future, Fail, B]

Definition Classes
Lifting
def liftSeq[B](fIntermediate: Future[IndexedSeq[\/[Fail, B]]])(implicit ec: ExecutionContext): EitherT[Future, Fail, IndexedSeq[B]]

Definition Classes
Lifting
def liftSeq[B](interList: IndexedSeq[Future[\/[Fail, B]]])(implicit ec: ExecutionContext): EitherT[Future, Fail, IndexedSeq[B]]

Definition Classes
Lifting
def listRevisions(documentId: UUID, fromVersion: Long = 0): Future[\/[Fail, IndexedSeq[Revision]]]

List a document's revisions.
List a document's revisions.
documentId
fromVersion
returns

Definition Classes
DocumentServiceDefault → DocumentService
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def predicate(fCondition: Future[Boolean])(fail: Fail)(implicit ec: ExecutionContext): EitherT[Future, Fail, Unit]

Definition Classes
Lifting
def predicate(condition: Boolean)(fail: Fail): EitherT[Future, Fail, Unit]

Definition Classes
Lifting
def push(documentId: UUID, version: Long, author: User, delta: Delta): Future[\/[Fail, PushResult]]

Push a new revision.
Push a new revision.
This method will push a new revision onto the document's revision history, transforming the given operation against any revisions that have already been applied to the document.
The push operation runs in a transaction so that if any one part fails, the entire operation fails and rolls back.
documentId
the ca.shiftfocus.uuid.UUID of the document to update
version
the version of the document to update from
delta
the operation to be performed on the document
returns
a PushResult object containing: document: the new version of the document revision: the newly pushed (and possibly transformed) revision serverOps: the server operations that have been applied more recently than this one, transformed against this operation so that they can be applied to the client's document. The client may need to transform them further against any additional edits they have in the clientside operation buffer.

Definition Classes
DocumentServiceDefault → DocumentService
def revert(documentId: UUID, version: Long, authorId: UUID): Future[\/[Fail, Document]]

Revert a document to a previous revision.
Revert a document to a previous revision. Note that this doesn't erase anything from the document's history, rather the "reversion" will be inserted as a new revision that clears the document and inserts the reverted text.
documentId
the document to revert
version
the version of the document to revert to
authorId
the ID of the user who will own the new revision
returns

Definition Classes
DocumentServiceDefault → DocumentService
val revisionRepository: RevisionRepository
val scalaCache: ScalaCachePool
def serialized[E, R, L[E] <: IndexedSeq[E]](collection: L[E])(fn: (E) ⇒ Future[R])(implicit ec: ExecutionContext): Future[IndexedSeq[R]]

Definition Classes
Serialized
def serializedT[E, R, L[E] <: IndexedSeq[E]](collection: L[E])(fn: (E) ⇒ Future[\/[Fail, R]])(implicit ec: ExecutionContext): Future[\/[Fail, IndexedSeq[R]]]

Definition Classes
Lifting
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transactional[A](f: (Connection) ⇒ Future[A]): Future[A]

Takes a function that returns a future, and runs it inside a database transaction.
Takes a function that returns a future, and runs it inside a database transaction.

Definition Classes
Service
def update(id: UUID, version: Long, owner: User, editors: IndexedSeq[User], title: String): Future[\/[Fail, Document]]

Update an existing document (metadata only).
Update an existing document (metadata only).
id
version
title
returns

Definition Classes
DocumentServiceDefault → DocumentService
val userRepository: UserRepository

Definition Classes
DocumentServiceDefault → DocumentService
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

class DocumentServiceDefault extends DocumentService

Instance Constructors

new DocumentServiceDefault(db: DB, scalaCache: ScalaCachePool, userRepository: UserRepository, documentRepository: DocumentRepository, revisionRepository: RevisionRepository)

Type Members

case class PushResult(document: Document, revision: Revision, serverOps: IndexedSeq[Revision]) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

implicit def cache: ScalaCachePool

def clone(): AnyRef

implicit def conn: Connection

def create(id: UUID = UUID.random, owner: User, title: String, initialDelta: Delta): Future[\/[Fail, Document]]

val db: DB

val documentRepository: DocumentRepository

implicit def eitherRunner[B](eithert: EitherT[Future, Fail, B]): Future[\/[Fail, B]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def find(id: UUID, version: Option[Long] = None): Future[\/[Fail, Document]]

implicit val futureMonad: Monad[Future]

final def getClass(): Class[_]

def getHistory(documentId: UUID, granularity: Int = 10): Future[\/[Fail, IndexedSeq[Revision]]]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def lift[B]: (Future[\/[Fail, B]]) ⇒ EitherT[Future, Fail, B]

def liftSeq[B](fIntermediate: Future[IndexedSeq[\/[Fail, B]]])(implicit ec: ExecutionContext): EitherT[Future, Fail, IndexedSeq[B]]

def liftSeq[B](interList: IndexedSeq[Future[\/[Fail, B]]])(implicit ec: ExecutionContext): EitherT[Future, Fail, IndexedSeq[B]]

def listRevisions(documentId: UUID, fromVersion: Long = 0): Future[\/[Fail, IndexedSeq[Revision]]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def predicate(fCondition: Future[Boolean])(fail: Fail)(implicit ec: ExecutionContext): EitherT[Future, Fail, Unit]

def predicate(condition: Boolean)(fail: Fail): EitherT[Future, Fail, Unit]

def push(documentId: UUID, version: Long, author: User, delta: Delta): Future[\/[Fail, PushResult]]

def revert(documentId: UUID, version: Long, authorId: UUID): Future[\/[Fail, Document]]

val revisionRepository: RevisionRepository

val scalaCache: ScalaCachePool

def serialized[E, R, L[E] <: IndexedSeq[E]](collection: L[E])(fn: (E) ⇒ Future[R])(implicit ec: ExecutionContext): Future[IndexedSeq[R]]

def serializedT[E, R, L[E] <: IndexedSeq[E]](collection: L[E])(fn: (E) ⇒ Future[\/[Fail, R]])(implicit ec: ExecutionContext): Future[\/[Fail, IndexedSeq[R]]]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def transactional[A](f: (Connection) ⇒ Future[A]): Future[A]

def update(id: UUID, version: Long, owner: User, editors: IndexedSeq[User], title: String): Future[\/[Fail, Document]]

val userRepository: UserRepository

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from DocumentService

Inherited from Service[Fail]

Inherited from Lifting[Fail]

Inherited from Serialized

Inherited from FutureMonad

Inherited from AnyRef

Inherited from Any

Ungrouped