net.liftweb.mongodb.record

MongoMetaRecord

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

Self Type
MongoMetaRecord[BaseRecord] with BaseRecord
Linear Supertypes
MongoMeta[BaseRecord], BsonMetaRecord[BaseRecord], JsonFormats, MetaRecord[BaseRecord], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. MongoMetaRecord
  2. MongoMeta
  3. BsonMetaRecord
  4. JsonFormats
  5. MetaRecord
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Type Members

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

Value Members

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

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. implicit lazy val _formats: Formats

    Definition Classes
    JsonFormats
  7. lazy val allFormats: Formats

    Definition Classes
    JsonFormats
  8. 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 is 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
  9. 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
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def asJSON(inst: BaseRecord): JsObj

    Returns the JSON representation of inst record

    Returns the JSON representation of inst record

    returns

    JsObj

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

    Encode a record instance into a JValue

    Encode a record instance into a JValue

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

    Returns the JSON representation of inst record, converts asJValue to JsObj

    Returns the JSON representation of inst record, converts asJValue to JsObj

    returns

    a JsObj

    Definition Classes
    MetaRecord
  14. def bulkDelete_!!(k: String, o: Any): Unit

  15. def bulkDelete_!!(qry: DBObject): Unit

  16. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  17. 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
  18. def copy(rec: BaseRecord): BaseRecord

    Definition Classes
    MetaRecord
  19. def count(qry: JObject): Long

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

    Definition Classes
    MongoMeta
  21. def count: Long

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

    Definition Classes
    MongoMeta
  23. def createRecord: BaseRecord

    Creates a new record

    Creates a new record

    Definition Classes
    MetaRecord
  24. 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 applying the new value for the specific field

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

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

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

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

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

    Delete the instance from backing store

  29. def drop: Unit

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

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

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

    Definition Classes
    MongoMeta
  33. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  35. 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
  36. 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
  37. def fieldOrder: List[net.liftweb.record.Field[_, BaseRecord]]

    Defines the order of the fields in this record

    Defines the order of the fields in this record

    returns

    a List of Field

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

    Obtain the fields for a particular Record or subclass instance by passing the instance itself.

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

    Definition Classes
    MetaRecord
  39. def finalize(): Unit

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

    Find a single row by a qry using String key and Any value

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

    Find a single document by a qry using a json value

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

    Find a single row by a Long id

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

    Find a single row by an Int id

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

    Find a single row by a String id

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

    Find a single row by a UUID

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

    Find a single row by an ObjectId

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

    Find a single row by a qry, using a DBObject.

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

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

    Find all documents using a k, v query with JOBject sort

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

    Find all documents using a k, v query

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

    Find all documents using a JObject query with sort

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

    Find all documents using a JObject query

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

    Find all documents using a DBObject query with sort

  54. 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.

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

    Find all rows and retrieve only keys fields.

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

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

    Find all rows and retrieve only keys fields.

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

    Find all rows using a DBObject query.

  59. def findAll: List[BaseRecord]

    Find all rows in this collection

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

    Find all documents with the given ids

  61. 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.

  62. def fixCollectionName: String

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

    Definition Classes
    MetaRecord
  64. var formTemplate: Box[NodeSeq]

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

    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 having 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
  65. def formats: Formats

    Definition Classes
    JsonFormats
  66. 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
  67. 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
  68. 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
  69. 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
  70. 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
  71. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  72. def hashCode(): Int

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

    Insert multiple records

  74. 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
  75. def introspect(rec: BaseRecord, methods: Array[Method])(f: (Method, net.liftweb.record.Field[_, BaseRecord]) ⇒ Any): Unit

    Definition Classes
    MetaRecord
  76. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  77. 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

  78. def mongoIdentifier: MongoIdentifier

    Definition Classes
    MongoMeta
  79. def mutable_?: Boolean

    Specifies if this Record is mutable or not

    Specifies if this Record is mutable or not

    Definition Classes
    MetaRecord
  80. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  81. final def notify(): Unit

    Definition Classes
    AnyRef
  82. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  83. 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 is 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
  84. val rootClass: java.lang.Class[_ >: ?0]

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

  86. def save(inst: BaseRecord, concern: WriteConcern): Boolean

    Save the instance in the appropriate backing store

  87. def saveOp(inst: BaseRecord)(f: ⇒ Unit): Boolean

    Attributes
    protected
  88. 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
  89. 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
  90. 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
  91. 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
  92. def setFieldsFromRecord(inst: BaseRecord, rec: BaseRecord): Unit

    Populate the fields of the record with values from an existing record

    Populate the fields of the record with values from an existing record

    inst

    - The record to populate

    rec

    - The Record to read from

    Definition Classes
    MetaRecord
  93. 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
  94. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  95. 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
  96. 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
  97. def toString(): String

    Definition Classes
    AnyRef → Any
  98. 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
  99. def update(inst: BaseRecord): Unit

    Update only the dirty fields.

    Update only the dirty fields.

    Note: PatternField will always set the dirty flag when set.

  100. def update(obj: BaseRecord, update: DBObject): Unit

    Update a record with a DBObject query

  101. def update(query: DBObject, update: DBObject): Unit

    Update one record with a DBObject query

  102. def update(qry: JObject, newbr: BaseRecord, opts: UpdateOption*): Unit

  103. def update(qry: JObject, newbr: BaseRecord, db: DB, opts: UpdateOption*): Unit

  104. def update(qry: JObject, newobj: JObject, opts: UpdateOption*): Unit

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

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

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

    Update multiple records with a DBObject query

  108. def upsert(query: DBObject, update: DBObject): Unit

    Upsert records with a DBObject query

  109. def useColl[T](f: (DBCollection) ⇒ T): T

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

    Definition Classes
    MongoMeta
  111. 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

    inst

    - the Record to be validated

    returns

    a List of FieldError. If this list is empty you can assume that record was validated successfully

    Definition Classes
    MetaRecord
  112. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from MongoMeta[BaseRecord]

Inherited from BsonMetaRecord[BaseRecord]

Inherited from JsonFormats

Inherited from MetaRecord[BaseRecord]

Inherited from AnyRef

Inherited from Any