net.liftweb.mongodb.record.MongoMetaRecord

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

MongoMetaRecord
MongoMeta
BsonMetaRecord
JsonFormats
MetaRecord
AnyRef
Any

Visibility

Public
All

Type Members

case class FieldHolder (name: String, method: Method, metaField: net.liftweb.record.Field[_, BaseRecord]) extends Product with Serializable

Value Members

def != (arg0: AnyRef): Boolean

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

Attributes
final
Definition Classes
Any
def ## (): Int

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

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

Attributes
final
Definition Classes
Any
implicit lazy val _formats : Formats

Attributes
implicit
Definition Classes
JsonFormats
lazy val allFormats : Formats

Definition Classes
JsonFormats
def appendDispatch (func: PartialFunction[Req, (BaseRecord) ⇒ Box[LiftResponse]]): RulesSeq[PartialFunction[Req, () ⇒ Box[LiftResponse]]]

Append a DispatchPF function to LiftRules.
Append a DispatchPF function to LiftRules.dispatch. If the partial function id defined for a give Req it will construct a new Record based on the HTTP query string parameters and will pass this Record to the function returned by func parameter.
func
- a PartialFunction for associating a request with a user provided function and the proper Record

Definition Classes
MetaRecord
def asDBObject (inst: BaseRecord): DBObject

Create a BasicDBObject from the field names and values.
Create a BasicDBObject from the field names and values. - MongoFieldFlavor types (List) are converted to DBObjects using asDBObject

Definition Classes
BsonMetaRecord
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any
def asJSON (inst: BaseRecord): JsObj

Returns the JSON representation of inst record
Returns the JSON representation of inst record
returns
JsObj

Definition Classes
MetaRecord
def asJValue (rec: BaseRecord): JObject

Encode a record instance into a JValue
Encode a record instance into a JValue

Definition Classes
MetaRecord
def asJsExp (inst: BaseRecord): JsExp

Retuns the JSON representation of inst record, converts asJValue to JsObj
Retuns the JSON representation of inst record, converts asJValue to JsObj
returns
a JsObj

Definition Classes
MetaRecord
def bulkDelete_!! (k: String, o: Any): Unit
def bulkDelete_!! (qry: DBObject): Unit
def clone (): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def collectionName : String

The name of the database collection.
The name of the database collection. Override this method if you want to change the collection to something other than the name of the class with an 's' appended to the end.

Definition Classes
MongoMeta
def count (qry: JObject): Long

Definition Classes
MongoMeta
def count (qry: DBObject): Long

Definition Classes
MongoMeta
def count : Long

Definition Classes
MongoMeta
def countDistinct (key: String, query: DBObject): Long

Definition Classes
MongoMeta
def createRecord : BaseRecord

Creates a new record
Creates a new record

Definition Classes
MetaRecord
def createWithMutableField [FieldType] (original: BaseRecord, field: Field[FieldType, BaseRecord], newValue: Box[FieldType]): BaseRecord

Creates a new record setting the value of the fields from the original object but apply the new value for the specific field
Creates a new record setting the value of the fields from the original object but apply the new value for the specific field

Definition Classes
MetaRecord
def delete (qry: JObject): Unit

Definition Classes
MongoMeta
def delete (k: String, v: Any): Unit

Definition Classes
MongoMeta
def delete (qry: DBObject): Unit

Definition Classes
MongoMeta
def delete_! (inst: BaseRecord): Boolean

Delete the instance from backing store
def drop : Unit

Definition Classes
MongoMeta
def ensureIndex (keys: JObject, opts: JObject): Unit

Definition Classes
MongoMeta
def ensureIndex (keys: JObject, unique: Boolean): Unit

Definition Classes
MongoMeta
def ensureIndex (keys: JObject): Unit

Definition Classes
MongoMeta
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

Definition Classes
AnyRef → Any
def fieldByName (fieldName: String, inst: BaseRecord): Box[net.liftweb.record.Field[_, BaseRecord]]

Get a field by the field name
Get a field by the field name
fieldName
-- the name of the field to get
returns
Box[The Field] (Empty if the field is not found)

Definition Classes
MetaRecord
def fieldDbValue (f: net.liftweb.record.Field[_, BaseRecord]): Box[Any]

Return the value of a field suitable to be put in a DBObject
Return the value of a field suitable to be put in a DBObject

Definition Classes
BsonMetaRecord
def fieldOrder : List[net.liftweb.record.Field[_, BaseRecord]]

Defined the order of the fields in this record
Defined the order of the fields in this record
returns
a List of Field

Definition Classes
MetaRecord
def fields (rec: BaseRecord): List[net.liftweb.record.Field[_, BaseRecord]]

Obtain the fields for a particlar Record or subclass instance by passing the instance itself.
Obtain the fields for a particlar Record or subclass instance by passing the instance itself. (added 14th August 2009, Tim Perrett)

Definition Classes
MetaRecord
def finalize (): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def find (k: String, o: Any): Box[BaseRecord]

Find a single row by a qry using String key and Any value
def find (json: JObject): Box[BaseRecord]

Find a single document by a qry using a json value
def find (id: Long): Box[BaseRecord]

Find a single row by a Long id
def find (id: Int): Box[BaseRecord]

Find a single row by an Int id
def find (s: String): Box[BaseRecord]

Find a single row by a String id
def find (uid: UUID): Box[BaseRecord]

Find a single row by a UUID
def find (oid: ObjectId): Box[BaseRecord]

Find a single row by an ObjectId
def find (qry: DBObject): Box[BaseRecord]

Find a single row by a qry, using a DBObject.
def findAll (ids: List[ObjectId]): List[BaseRecord]
def findAll (k: String, o: Any, sort: JObject, opts: FindOption*): List[BaseRecord]

Find all documents using a k, v query with JOBject sort
def findAll (k: String, o: Any, opts: FindOption*): List[BaseRecord]

Find all documents using a k, v query
def findAll (qry: JObject, sort: JObject, opts: FindOption*): List[BaseRecord]

Find all documents using a JObject query with sort
def findAll (qry: JObject, opts: FindOption*): List[BaseRecord]

Find all documents using a JObject query
def findAll (qry: DBObject, sort: DBObject, opts: FindOption*): List[BaseRecord]

Find all documents using a DBObject query with sort
def findAll (qry: DBObject, opts: FindOption*): List[BaseRecord]

Find all documents using a DBObject query.
Find all documents using a DBObject query. These are for passing in regex queries.
def findAll (qry: JObject, keys: JObject, sort: Option[JObject], opts: FindOption*): List[BaseRecord]

Find all rows and retrieve only keys fields.
def findAll (sort: Option[DBObject], opts: FindOption*)(f: (DBCollection) ⇒ DBCursor): List[BaseRecord]

Attributes
protected
def findAll (qry: DBObject, keys: DBObject, sort: Option[DBObject], opts: FindOption*): List[BaseRecord]

Find all rows and retrieve only keys fields.
def findAll (qry: DBObject, sort: Option[DBObject], opts: FindOption*): List[BaseRecord]

Find all rows using a DBObject query.
def findAll : List[BaseRecord]

Find all rows in this collection
def findAllByList [T] (ids: List[T]): List[BaseRecord]

Find all documents with the given ids
def findAny (a: Any): Box[BaseRecord]

Find a single row by Any This doesn't work as find because we need JObject's to be implicitly converted.
def fixCollectionName : String

Definition Classes
MongoMeta
def foreachCallback (inst: BaseRecord, f: (LifecycleCallbacks) ⇒ Any): Unit

Definition Classes
MetaRecord

var formTemplate : Box[NodeSeq]

Set this to use your own form template when rendering a Record to a form.

This template is any given XHtml that contains three nodes acting as placeholders such as:


<lift:field_label name="firstName"/> - the label for firstName field will be rendered here
<lift:field name="firstName"/> - the firstName field will be rendered here (typically an input field)
<lift:field_msg name="firstName"/> - the  will be rendered here hafing the id given by
                                            uniqueFieldId of the firstName field.


Example.

Having:

class MyRecord extends Record[MyRecord] {

	def meta = MyRecordMeta

	object firstName extends StringField(this, "John")

}

object MyRecordMeta extends MyRecord with MetaRecord[MyRecord] {
 override def mutable_? = false
}

...

val rec = MyRecordMeta.createRecord.firstName("McLoud")

val template =
<div>
	<div>
		<div><lift:field_label name="firstName"/></div>
		<div><lift:field name="firstName"/></div>
		<div><lift:field_msg name="firstName"/></div>
	</div>
</div>

MyRecordMeta.formTemplate = Full(template)
rec.toForm((r:MyRecord) => println(r));

Definition Classes: MetaRecord

def formats : Formats

Definition Classes
JsonFormats
def fromDBObject (dbo: DBObject): BaseRecord

Creates a new record, then sets the fields with the given DBObject.
Creates a new record, then sets the fields with the given DBObject.
dbo
- the DBObject
returns
Box[BaseRecord]

Definition Classes
BsonMetaRecord
def fromJSON (json: String): Box[BaseRecord]

Create a record with fields populated with values from the JSON construct
Create a record with fields populated with values from the JSON construct
json
- The stringified JSON object
returns
Box[BaseRecord]

Definition Classes
MetaRecord
def fromJValue (jvalue: JValue): Box[BaseRecord]

Create a record by decoding a JValue which must be a JObject
Create a record by decoding a JValue which must be a JObject

Definition Classes
MetaRecord
def fromJsonString (json: String): Box[BaseRecord]

Create a record with fields populated with values from the JSON construct
Create a record with fields populated with values from the JSON construct
json
- The stringified JSON object
returns
Box[BaseRecord]

Definition Classes
MetaRecord
def fromReq (r: Req): BaseRecord

Create a record with fields populated with values from the request
Create a record with fields populated with values from the request
returns
the created record

Definition Classes
MetaRecord
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef → Any
def hashCode (): Int

Definition Classes
AnyRef → Any
def insertAll (insts: List[BaseRecord]): Unit

Insert multiple records
def instantiateRecord : BaseRecord

Make a new record instance.
Make a new record instance. This method can be overridden to provide caching behavior or what have you.

Attributes
protected
Definition Classes
MetaRecord
def introspect (rec: BaseRecord, methods: Array[Method])(f: (Method, net.liftweb.record.Field[_, BaseRecord]) ⇒ Any): Unit

Definition Classes
MetaRecord
def isInstanceOf [T0] : Boolean

Attributes
final
Definition Classes
Any
def metaFields (): List[net.liftweb.record.Field[_, BaseRecord]]

Renamed from fields() due to a clash with fields() in Record.
Renamed from fields() due to a clash with fields() in Record. Use this method to obtain a list of fields defined in the meta companion objects. Possibly a breaking change? (added 14th August 2009, Tim Perrett)

Definition Classes
MetaRecord
See also
Record
def mongoIdentifier : MongoIdentifier

Definition Classes
MongoMeta
def mutable_? : Boolean

Specifies if this Record is mutable or not
Specifies if this Record is mutable or not

Definition Classes
MetaRecord
def ne (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Attributes
final
Definition Classes
AnyRef
def prependDispatch (func: PartialFunction[Req, (BaseRecord) ⇒ Box[LiftResponse]]): RulesSeq[PartialFunction[Req, () ⇒ Box[LiftResponse]]]

Prepend a DispatchPF function to LiftRules.
Prepend a DispatchPF function to LiftRules.dispatch. If the partial function id defined for a give Req it will construct a new Record based on the HTTP query string parameters and will pass this Record to the function returned by func parameter.
func
- a PartialFunction for associating a request with a user provided function and the proper Record

Definition Classes
MetaRecord
val rootClass : java.lang.Class[_ >: ?0]

Attributes
protected
Definition Classes
MetaRecord
def save (inst: BaseRecord, db: DB, concern: WriteConcern): Boolean
def save (inst: BaseRecord, concern: WriteConcern): Boolean

Save the instance in the appropriate backing store
def saveOp (inst: BaseRecord)(f: ⇒ Unit): Boolean

Attributes
protected
def setFieldsFromDBObject (inst: BaseRecord, dbo: DBObject): Unit

Populate the inst's fields with the values from a DBObject.
Populate the inst's fields with the values from a DBObject. Values are set using setFromAny passing it the DBObject returned from Mongo.
inst
- the record that will be populated
dbo
- The DBObject
returns
Unit

Definition Classes
BsonMetaRecord
def setFieldsFromJSON (inst: BaseRecord, json: String): Box[Unit]

Populate the fields of the record instance with values from the JSON construct
Populate the fields of the record instance with values from the JSON construct
inst
- The record to populate
json
- The stringified JSON object
returns
- Full(()) on success, other on failure

Definition Classes
MetaRecord
def setFieldsFromJValue (rec: BaseRecord, jvalue: JValue): Box[Unit]

Attempt to decode a JValue, which must be a JObject, into a record instance
Attempt to decode a JValue, which must be a JObject, into a record instance

Definition Classes
MetaRecord
def setFieldsFromJsonString (inst: BaseRecord, json: String): Box[Unit]

Set from a Json String using the lift-json parser
Set from a Json String using the lift-json parser

Definition Classes
MetaRecord
def setFieldsFromReq (inst: BaseRecord, req: Req): Unit

Populate the fields of the record with values from the request
Populate the fields of the record with values from the request
inst
- The record to populate
req
- The Req to read from

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

Attributes
final
Definition Classes
AnyRef
def toForm (inst: BaseRecord, template: NodeSeq): NodeSeq

Returns the XHTML representation of inst Record.
Returns the XHTML representation of inst Record. You must provide the Node template to represent this record in the proprietary layout.
inst
- the record to be rendered
template
- The markup template forthe form. See also the formTemplate variable
returns
the XHTML content as a NodeSeq

Definition Classes
MetaRecord
def toForm (inst: BaseRecord): NodeSeq

Returns the XHTML representation of inst Record.
Returns the XHTML representation of inst Record. If formTemplate is set, this template will be used otherwise a default template is considered.
inst
- the record to be rendered
returns
the XHTML content as a NodeSeq

Definition Classes
MetaRecord
def toString (): String

Definition Classes
AnyRef → Any
def toXHtml (inst: BaseRecord): NodeSeq

Returns the HTML representation of inst Record.
Returns the HTML representation of inst Record.
inst
- th designated Record
returns
a NodeSeq

Definition Classes
MetaRecord
def update (inst: BaseRecord): Unit

Update only the dirty fields
def update (obj: BaseRecord, update: DBObject): Unit

Update a record with a DBObject query
def update (query: DBObject, update: DBObject): Unit

Update one record with a DBObject query
def update (qry: JObject, newbr: BaseRecord, opts: UpdateOption*): Unit
def update (qry: JObject, newbr: BaseRecord, db: DB, opts: UpdateOption*): Unit
def update (qry: JObject, newobj: JObject, opts: UpdateOption*): Unit

Definition Classes
MongoMeta
def update (qry: JObject, newobj: JObject, db: DB, opts: UpdateOption*): Unit

Definition Classes
MongoMeta
def update (qry: DBObject, newobj: DBObject, db: DB, opts: UpdateOption*): Unit

Definition Classes
MongoMeta
def updateMulti (query: DBObject, update: DBObject): Unit

Update multiple records with a DBObject query
def upsert (query: DBObject, update: DBObject): Unit

Upsert records with a DBObject query
def useColl [T] (f: (DBCollection) ⇒ T): T

Definition Classes
MongoMeta
def useDb [T] (f: (DB) ⇒ T): T

Definition Classes
MongoMeta
def validate (inst: BaseRecord): List[FieldError]

Validates the inst Record by calling validators for each field
Validates the inst Record by calling validators for each field
returns
a List of FieldError. If this list is empty you can assume that record was validated successfully

Definition Classes
MetaRecord
def wait (): Unit

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

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def wait (arg0: Long): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()

MongoMetaRecord

trait MongoMetaRecord [BaseRecord <: MongoRecord[BaseRecord]] extends BsonMetaRecord[BaseRecord] with MongoMeta[BaseRecord]

Type Members

case class FieldHolder (name: String, method: Method, metaField: net.liftweb.record.Field[_, BaseRecord]) extends Product with Serializable

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

implicit lazy val _formats : Formats

lazy val allFormats : Formats

def appendDispatch (func: PartialFunction[Req, (BaseRecord) ⇒ Box[LiftResponse]]): RulesSeq[PartialFunction[Req, () ⇒ Box[LiftResponse]]]

def asDBObject (inst: BaseRecord): DBObject

def asInstanceOf [T0] : T0

def asJSON (inst: BaseRecord): JsObj

def asJValue (rec: BaseRecord): JObject

def asJsExp (inst: BaseRecord): JsExp

def bulkDelete_!! (k: String, o: Any): Unit

def bulkDelete_!! (qry: DBObject): Unit

def clone (): AnyRef

def collectionName : String

def count (qry: JObject): Long

def count (qry: DBObject): Long

def count : Long

def countDistinct (key: String, query: DBObject): Long

def createRecord : BaseRecord

def createWithMutableField [FieldType] (original: BaseRecord, field: Field[FieldType, BaseRecord], newValue: Box[FieldType]): BaseRecord

def delete (qry: JObject): Unit

def delete (k: String, v: Any): Unit

def delete (qry: DBObject): Unit

def delete_! (inst: BaseRecord): Boolean

def drop : Unit

def ensureIndex (keys: JObject, opts: JObject): Unit

def ensureIndex (keys: JObject, unique: Boolean): Unit

def ensureIndex (keys: JObject): Unit

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def fieldByName (fieldName: String, inst: BaseRecord): Box[net.liftweb.record.Field[_, BaseRecord]]

def fieldDbValue (f: net.liftweb.record.Field[_, BaseRecord]): Box[Any]

def fieldOrder : List[net.liftweb.record.Field[_, BaseRecord]]

def fields (rec: BaseRecord): List[net.liftweb.record.Field[_, BaseRecord]]

def finalize (): Unit

def find (k: String, o: Any): Box[BaseRecord]

def find (json: JObject): Box[BaseRecord]

def find (id: Long): Box[BaseRecord]

def find (id: Int): Box[BaseRecord]

def find (s: String): Box[BaseRecord]

def find (uid: UUID): Box[BaseRecord]

def find (oid: ObjectId): Box[BaseRecord]

def find (qry: DBObject): Box[BaseRecord]

def findAll (ids: List[ObjectId]): List[BaseRecord]

def findAll (k: String, o: Any, sort: JObject, opts: FindOption*): List[BaseRecord]

def findAll (k: String, o: Any, opts: FindOption*): List[BaseRecord]

def findAll (qry: JObject, sort: JObject, opts: FindOption*): List[BaseRecord]

def findAll (qry: JObject, opts: FindOption*): List[BaseRecord]

def findAll (qry: DBObject, sort: DBObject, opts: FindOption*): List[BaseRecord]

def findAll (qry: DBObject, opts: FindOption*): List[BaseRecord]

def findAll (qry: JObject, keys: JObject, sort: Option[JObject], opts: FindOption*): List[BaseRecord]

def findAll (sort: Option[DBObject], opts: FindOption*)(f: (DBCollection) ⇒ DBCursor): List[BaseRecord]

def findAll (qry: DBObject, keys: DBObject, sort: Option[DBObject], opts: FindOption*): List[BaseRecord]

def findAll (qry: DBObject, sort: Option[DBObject], opts: FindOption*): List[BaseRecord]

def findAll : List[BaseRecord]

def findAllByList [T] (ids: List[T]): List[BaseRecord]

def findAny (a: Any): Box[BaseRecord]

def fixCollectionName : String

def foreachCallback (inst: BaseRecord, f: (LifecycleCallbacks) ⇒ Any): Unit

var formTemplate : Box[NodeSeq]

def formats : Formats

def fromDBObject (dbo: DBObject): BaseRecord

def fromJSON (json: String): Box[BaseRecord]

def fromJValue (jvalue: JValue): Box[BaseRecord]

def fromJsonString (json: String): Box[BaseRecord]

def fromReq (r: Req): BaseRecord

def getClass (): java.lang.Class[_]

def hashCode (): Int

def insertAll (insts: List[BaseRecord]): Unit

def instantiateRecord : BaseRecord

def introspect (rec: BaseRecord, methods: Array[Method])(f: (Method, net.liftweb.record.Field[_, BaseRecord]) ⇒ Any): Unit

def isInstanceOf [T0] : Boolean