SalatDAO

Instance Constructors

new SalatDAO(collection: mongodb.casbah.Imports.MongoCollection)(implicit mot: Manifest[ObjectType], mid: Manifest[ID], ctx: Context)

collection
MongoDB collection
mot
implicit manifest for ObjectType
mid
implicit manifest for ID
ctx
implicit com.novus.salat.Context

Type Members

abstract class ChildCollection[ChildType <: AnyRef, ChildID] extends SalatDAO[ChildType, ChildID]

Inner abstract class to facilitate working with child collections using a typed parent id - no cascading support will be offered, but you can override saves and deletes in the parent DAO to manually cascade children as you like.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
val _grater: Grater[ObjectType]

Supplies the com.novus.salat.Grater from the implicit com.novus.salat.Context and ObjectType manifest
Supplies the com.novus.salat.Grater from the implicit com.novus.salat.Context and ObjectType manifest
returns
com.novus.salat.Grater to serialize and deserialize ObjectType

Definition Classes
SalatDAO → DAO
val appendTypeHintToQueries: Boolean

If you are mixing and matching abstract and concrete DAOs, turn this on in the concrete DAOs to ensure that querying on a mixed collection will only yield results in the child collection.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
val collection: mongodb.casbah.Imports.MongoCollection

MongoDB collection
MongoDB collection

Definition Classes
SalatDAO → DAO
def count(q: DBObject = MongoDBObject.empty, fieldsThatMustExist: List[String] = Nil, fieldsThatMustNotExist: List[String] = Nil): Long

q
object for which to search
fieldsThatMustExist
list of field keys that must exist
fieldsThatMustNotExist
list of field keys that must not exist
returns
count of documents matching the search criteria

Definition Classes
SalatDAO → BaseDAOMethods
def decorateDBO(toPersist: ObjectType): mongodb.casbah.Imports.DBObject

A central place to modify DBOs before inserting, saving, or updating.
A central place to modify DBOs before inserting, saving, or updating.
toPersist
object to be serialized
returns
decorated DBO for persisting
def decorateQuery(query: DBObject): DBObject

A central place to modify find, count and update queries before executing them.
A central place to modify find, count and update queries before executing them.
query
query to decorate
returns
decorated query for execution
def defaultWriteConcern: WriteConcern

In the absence of a specified write concern, supplies a default write concern.
In the absence of a specified write concern, supplies a default write concern.
returns
default write concern to use for insert, update, save and remove operations

Definition Classes
DAO → BaseDAOMethods
lazy val description: String

Default description is the case class simple name and the collection.
Default description is the case class simple name and the collection.

Definition Classes
SalatDAO → DAO
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()
def find[A, B](ref: A, keys: B)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject): SalatMongoCursor[ObjectType]

A
type view bound to DBObject
B
type view bound to DBObject
ref
object for which to search
keys
fields to return
returns
a typed cursor to iterate over results

Definition Classes
SalatDAO → BaseDAOMethods
def find[A](ref: A)(implicit arg0: (A) ⇒ DBObject): SalatMongoCursor[ObjectType]

Queries for an object in this collection.
Queries for an object in this collection.
A
type view bound to DBObject
ref
object for which to search
returns
a typed cursor to iterate over results

Definition Classes
BaseDAOMethods
def findOne[A](t: A)(implicit arg0: (A) ⇒ DBObject): Option[ObjectType]

A
type view bound to DBObject
t
object for which to search
returns
(Option[ObjectType]) Some() of the object found, or None if no such object exists

Definition Classes
SalatDAO → BaseDAOMethods
def findOneById(id: ID): Option[ObjectType]

id
identifier
returns
(Option[ObjectType]) Some() of the object found, or None if no such object exists

Definition Classes
SalatDAO → BaseDAOMethods
val forceTypeHints: Boolean

Force type hints when objects are persisted.
Force type hints when objects are persisted. Used to support a DAO typed to an abstract superclass or trait. Should be overriden and forced to true when you want to select
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def ids[A](query: A)(implicit arg0: (A) ⇒ DBObject): List[ID]

A
type view bound to DBObject
query
query
returns
list of IDs

Definition Classes
SalatDAO → BaseDAOMethods
def insert(docs: Traversable[ObjectType], wc: WriteConcern = defaultWriteConcern): List[Option[ID]]

docs
collection of ObjectType instances to insert
wc
write concern
returns
list of object ids TODO: flatten list of IDs - why on earth didn't I do that in the first place?

Definition Classes
SalatDAO → BaseDAOMethods
def insert(t: ObjectType, wc: WriteConcern): Option[ID]

t
instance of ObjectType
wc
write concern
returns
if insert succeeds, ID of inserted object

Definition Classes
SalatDAO → BaseDAOMethods
def insert(docs: ObjectType*)(implicit wc: WriteConcern): List[Option[ID]]

Inserts a group of documents into the database.
Inserts a group of documents into the database.
docs
variable length argument of ObjectType instances
returns
if write concern succeeds, a list of object IDs TODO: this implicit: dumbest design decision on the face of the planet? TODO: replace vararg with traversable TODO: flatten list of IDs - why on earth didn't I do that in the first place?

Definition Classes
BaseDAOMethods
def insert(t: ObjectType): Option[ID]

Inserts a document into the database.
Inserts a document into the database.
t
instance of ObjectType
returns
if insert succeeds, ID of inserted object

Definition Classes
BaseDAOMethods
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
var log: Logger

Attributes
protected[com.mongodb.casbah]
Definition Classes
Logging
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def primitiveProjection[P](query: DBObject, field: String)(implicit m: Manifest[P], ctx: Context): Option[P]

P
type of projected field
query
object for which to search
field
field to project on
m
implicit manifest typed to P
ctx
implicit com.novus.salat.Context
returns
(Option[P]) Some() of the object found, or None if no such object exists

Definition Classes
SalatDAO → BaseDAOMethods
def primitiveProjections[P](query: DBObject, field: String)(implicit m: Manifest[P], ctx: Context): List[P]

P
type of projected field
query
object for which to search
field
field to project on
m
implicit manifest typed to P
ctx
implicit com.novus.salat.Context
returns
(List[P]) of the objects found

Definition Classes
SalatDAO → BaseDAOMethods
def projection[P <: CaseClass](query: DBObject, field: String)(implicit m: Manifest[P], ctx: Context): Option[P]

P
type of projected field
query
object for which to search
field
field to project on
m
implicit manifest typed to P
ctx
implicit com.novus.salat.Context
returns
(Option[P]) Some() of the object found, or None if no such object exists

Definition Classes
SalatDAO → BaseDAOMethods
def projections[P <: CaseClass](query: DBObject, field: String)(implicit m: Manifest[P], ctx: Context): List[P]

P
type of projected field
query
object for which to search
field
field to project on
m
implicit manifest typed to P
ctx
implicit com.novus.salat.Context
returns
(List[P]) of the objects found

Definition Classes
SalatDAO → BaseDAOMethods
def remove[A](q: A, wc: WriteConcern)(implicit arg0: (A) ⇒ DBObject): WriteResult

q
the object that documents to be removed must match
wc
write concern
returns
(WriteResult) result of write operation

Definition Classes
SalatDAO → BaseDAOMethods
def remove(t: ObjectType, wc: WriteConcern): WriteResult

t
object to remove from the collection
wc
write concern
returns
(WriteResult) result of write operation

Definition Classes
SalatDAO → BaseDAOMethods
def remove[A](q: A)(implicit arg0: (A) ⇒ DBObject): mongodb.casbah.Imports.WriteResult

Removes objects from the database collection.
Removes objects from the database collection.
q
the object that documents to be removed must match
returns
(WriteResult) result of write operation

Definition Classes
BaseDAOMethods
def remove(t: ObjectType): mongodb.casbah.Imports.WriteResult

Remove a matching object from the collection
Remove a matching object from the collection
t
object to remove from the collection
returns
(WriteResult) result of write operation

Definition Classes
BaseDAOMethods
def removeById(id: ID, wc: WriteConcern = defaultWriteConcern): WriteResult

id
the ID of the document to be removed
wc
write concern
returns
(WriteResult) result of write operation

Definition Classes
SalatDAO → BaseDAOMethods
def removeByIds(ids: List[ID], wc: WriteConcern): WriteResult

ids
the list of IDs identifying the list of documents to be removed
wc
wrote concern
returns
(WriteResult) result of write operation

Definition Classes
SalatDAO → BaseDAOMethods
def save(t: ObjectType, wc: WriteConcern): WriteResult

t
object to save
wc
write concern
returns
(WriteResult) result of write operation

Definition Classes
SalatDAO → BaseDAOMethods
def save(t: ObjectType): mongodb.casbah.Imports.WriteResult

Saves an object to this collection.
Saves an object to this collection.
t
object to save
returns
(WriteResult) result of write operation

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

Definition Classes
AnyRef
def toDBObject(o: ObjectType): mongodb.casbah.Imports.DBObject

o
object to transform
returns
object serialized as DBObject

Definition Classes
DAO → BaseDAOMethods
def toString(): String

Definition Classes
AnyRef → Any
def update(q: DBObject, o: DBObject, upsert: Boolean = false, multi: Boolean = false, wc: WriteConcern = defaultWriteConcern): mongodb.casbah.Imports.WriteResult

q
search query for old object to update
o
object with which to update q
upsert
if the database should create the element if it does not exist
multi
if the update should be applied to all objects matching
wc
write concern
returns
(WriteResult) result of write operation

Definition Classes
SalatDAO → BaseDAOMethods
def update(q: DBObject, t: ObjectType, upsert: Boolean, multi: Boolean, wc: WriteConcern): mongodb.casbah.Imports.WriteResult

Performs an update operation.
Performs an update operation.
q
search query for old object to update
t
object with which to update q
upsert
if the database should create the element if it does not exist
multi
if the update should be applied to all objects matching
wc
write concern
returns
(WriteResult) result of write operation

Definition Classes
BaseDAOMethods
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()

Deprecated Value Members

def findOneByID(id: ID): Option[ObjectType]

Find an object by its ID.
Find an object by its ID.
id
identifier
returns
(Option[ObjectType]) Some() of the object found, or None if no such object exists

Definition Classes
BaseDAOMethods
Annotations
@deprecated
Deprecated
(Since version 0.0.8) Use findOneById instead

abstract class SalatDAO[ObjectType <: AnyRef, ID] extends DAO[ObjectType, ID] with Logging

Instance Constructors

new SalatDAO(collection: mongodb.casbah.Imports.MongoCollection)(implicit mot: Manifest[ObjectType], mid: Manifest[ID], ctx: Context)

Type Members

abstract class ChildCollection[ChildType <: AnyRef, ChildID] extends SalatDAO[ChildType, ChildID]

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

val _grater: Grater[ObjectType]

val appendTypeHintToQueries: Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val collection: mongodb.casbah.Imports.MongoCollection

def count(q: DBObject = MongoDBObject.empty, fieldsThatMustExist: List[String] = Nil, fieldsThatMustNotExist: List[String] = Nil): Long

def decorateDBO(toPersist: ObjectType): mongodb.casbah.Imports.DBObject

def decorateQuery(query: DBObject): DBObject

def defaultWriteConcern: WriteConcern

lazy val description: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def find[A, B](ref: A, keys: B)(implicit arg0: (A) ⇒ DBObject, arg1: (B) ⇒ DBObject): SalatMongoCursor[ObjectType]

def find[A](ref: A)(implicit arg0: (A) ⇒ DBObject): SalatMongoCursor[ObjectType]

def findOne[A](t: A)(implicit arg0: (A) ⇒ DBObject): Option[ObjectType]

def findOneById(id: ID): Option[ObjectType]

val forceTypeHints: Boolean

final def getClass(): Class[_]

def hashCode(): Int

def ids[A](query: A)(implicit arg0: (A) ⇒ DBObject): List[ID]

def insert(docs: Traversable[ObjectType], wc: WriteConcern = defaultWriteConcern): List[Option[ID]]

def insert(t: ObjectType, wc: WriteConcern): Option[ID]

def insert(docs: ObjectType*)(implicit wc: WriteConcern): List[Option[ID]]

def insert(t: ObjectType): Option[ID]

final def isInstanceOf[T0]: Boolean

var log: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def primitiveProjection[P](query: DBObject, field: String)(implicit m: Manifest[P], ctx: Context): Option[P]

def primitiveProjections[P](query: DBObject, field: String)(implicit m: Manifest[P], ctx: Context): List[P]

def projection[P <: CaseClass](query: DBObject, field: String)(implicit m: Manifest[P], ctx: Context): Option[P]

def projections[P <: CaseClass](query: DBObject, field: String)(implicit m: Manifest[P], ctx: Context): List[P]

def remove[A](q: A, wc: WriteConcern)(implicit arg0: (A) ⇒ DBObject): WriteResult

def remove(t: ObjectType, wc: WriteConcern): WriteResult

def remove[A](q: A)(implicit arg0: (A) ⇒ DBObject): mongodb.casbah.Imports.WriteResult

def remove(t: ObjectType): mongodb.casbah.Imports.WriteResult

def removeById(id: ID, wc: WriteConcern = defaultWriteConcern): WriteResult

def removeByIds(ids: List[ID], wc: WriteConcern): WriteResult

def save(t: ObjectType, wc: WriteConcern): WriteResult

def save(t: ObjectType): mongodb.casbah.Imports.WriteResult

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

def toDBObject(o: ObjectType): mongodb.casbah.Imports.DBObject

def toString(): String

def update(q: DBObject, o: DBObject, upsert: Boolean = false, multi: Boolean = false, wc: WriteConcern = defaultWriteConcern): mongodb.casbah.Imports.WriteResult

def update(q: DBObject, t: ObjectType, upsert: Boolean, multi: Boolean, wc: WriteConcern): mongodb.casbah.Imports.WriteResult

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

def findOneByID(id: ID): Option[ObjectType]

Inherited from Logging

Inherited from DAO[ObjectType, ID]

Inherited from BaseDAOMethods[ObjectType, ID]

Inherited from AnyRef

Inherited from Any

Ungrouped