net.liftweb.couchdb.CouchMetaRecord

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

CouchMetaRecord
JSONMetaRecord
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
def all (filter: (AllDocs) ⇒ AllDocs): Box[Seq[BaseRecord]]

Query records from the default database by document id.
Query records from the default database by document id. includeDocs is always on for this type of query. Filter refines the query (e.g. by key), see Queryable. Note that this is probably not very useful, as there is no way to constrain the documents retrieved by type
def allIn (database: Database, filter: (AllDocs) ⇒ AllDocs): Box[Seq[BaseRecord]]

Query records from the given database by document id.
Query records from the given database by document id. includeDocs is always on for this type of query. Filter refines the query (e.g. by key), see Queryable. Note that this is probably not very useful, as there is no way to constrain the documents retrieved by type
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 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
JSONMetaRecord → MetaRecord
def asJValue (rec: BaseRecord): JObject

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

Definition Classes
JSONMetaRecord → 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 clone (): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
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 defaultDatabase : Database

Get the default Database to use, if the record's calculateDatabase function does not provide one.
Get the default Database to use, if the record's calculateDatabase function does not provide one. Defaults to CouchDB.defaultDatabase
def delete_! (inst: BaseRecord): Box[Unit]

Delete the instance from the backing store.
Delete the instance from the backing store. Only works if the instance is the current revision in the database.
def eq (arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def fetch (id: String): Box[BaseRecord]

Query a single document by _id from the default database
def fetchFrom (database: Database, id: String): Box[BaseRecord]

Query a single document by _id from the given database
def fetchMany (ids: String*): Box[Seq[BaseRecord]]

Query a series of documents by _id from the default database
def fetchManyFrom (database: Database, ids: String*): Box[Seq[BaseRecord]]

Query a series of documents by _id from the given database
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 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 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 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
def hashCode (): Int

Definition Classes
AnyRef → Any
def http : Http

Get an Http instance to use when accessing CouchDB
def ignoreExtraJSONFields : Boolean

Whether or not extra fields in a JObject to decode is an error (false) or not (true).
Whether or not extra fields in a JObject to decode is an error (false) or not (true). The default is true

Definition Classes
JSONMetaRecord
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 jsonName (field: net.liftweb.record.Field[_, BaseRecord]): String

Return the name of the field in the encoded JSON object.
Return the name of the field in the encoded JSON object. If the field implements JSONField and has overridden jsonName then that will be used, otherwise the record field name

Definition Classes
JSONMetaRecord
def looseParsing [A] (f: ⇒ A): A

Perform the given action with loose parsing turned on
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 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 needAllJSONFields : Boolean

Whether or not missing fields in a JObject to decode is an error (false) or not (true).
Whether or not missing fields in a JObject to decode is an error (false) or not (true). The default is true

Definition Classes
JSONMetaRecord
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
def queryView (design: String, view: String, filter: (View) ⇒ View): Box[Seq[BaseRecord]]

Query using a view in the default database.
Query using a view in the default database. Filter refines the query (e.g. by key), see Queryable.
def queryView (design: String, view: String): Box[Seq[BaseRecord]]

Query using a view in the default database.
def queryViewDocs (design: String, view: String, filter: (View) ⇒ View): Box[Seq[BaseRecord]]

Query using a view in the default database, returning records created from the documents returned with the view.
Query using a view in the default database, returning records created from the documents returned with the view. If used against a reduce view, make sure to use dontReduce in the filter, otherwise CouchDB will signal an error. Filter refines the query (e.g. by key), see Queryable. includeDocs are always on for this type of query.
def queryViewDocs (design: String, view: String): Box[Seq[BaseRecord]]

Query using a view in the default database, returning records created from the documents returned with the view.
Query using a view in the default database, returning records created from the documents returned with the view. If used against a reduce view, make sure to use dontReduce in the filter, otherwise CouchDB will signal an error. includeDocs are always on for this type of query.
def queryViewDocsFrom (database: Database, design: String, view: String, filter: (View) ⇒ View): Box[Seq[BaseRecord]]

Query using a view in the given database, returning records created from the documents returned with the view.
Query using a view in the given database, returning records created from the documents returned with the view. If used against a reduce view, make sure to use dontReduce in the filter, otherwise CouchDB will signal an error. Filter refines the query (e.g. by key), see Queryable. includeDocs are always on for this type of query.
def queryViewFrom (database: Database, design: String, view: String, filter: (View) ⇒ View): Box[Seq[BaseRecord]]

Query using a view in the given database.
Query using a view in the given database. Filter refines the query (e.g. by key), see Queryable.
def queryViewProjection (design: String, view: String, filter: (View) ⇒ View, project: (QueryRow) ⇒ Box[JValue]): Box[Seq[BaseRecord]]

Query using a view in the default database, using some projection function that converts each QueryRow into a JSON document to read as the record.
Query using a view in the default database, using some projection function that converts each QueryRow into a JSON document to read as the record. Filter refines the query (e.g. by key), see Queryable.
def queryViewProjection (design: String, view: String, project: (QueryRow) ⇒ Box[JValue]): Box[Seq[BaseRecord]]

Query using a view in the default database, using some projection function that converts each QueryRow into a JSON document to read as the record.
def queryViewProjectionFrom (database: Database, design: String, view: String, filter: (View) ⇒ View, project: (QueryRow) ⇒ Box[JValue]): Box[Seq[BaseRecord]]

Query using a view in the given database, using some projection function that converts each QueryRow into a JSON document to read as the record.
val rootClass : java.lang.Class[_ >: ?0]

Attributes
protected
Definition Classes
MetaRecord
def save (inst: BaseRecord): Box[Unit]

Save the record instance in the backing store
def saved_? (inst: BaseRecord): Boolean

Was the record instance saved in the backing store?
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
JSONMetaRecord → 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
JSONMetaRecord → 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 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()

CouchMetaRecord

trait CouchMetaRecord [BaseRecord <: CouchRecord[BaseRecord]] extends JSONMetaRecord[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

def all (filter: (AllDocs) ⇒ AllDocs): Box[Seq[BaseRecord]]

def allIn (database: Database, filter: (AllDocs) ⇒ AllDocs): Box[Seq[BaseRecord]]

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

def asInstanceOf [T0] : T0

def asJSON (inst: BaseRecord): JsObj

def asJValue (rec: BaseRecord): JObject

def asJsExp (inst: BaseRecord): JsExp

def clone (): AnyRef

def createRecord : BaseRecord

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

def defaultDatabase : Database

def delete_! (inst: BaseRecord): Box[Unit]

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def fetch (id: String): Box[BaseRecord]

def fetchFrom (database: Database, id: String): Box[BaseRecord]

def fetchMany (ids: String*): Box[Seq[BaseRecord]]

def fetchManyFrom (database: Database, ids: String*): Box[Seq[BaseRecord]]

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

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

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

def finalize (): Unit

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

var formTemplate : Box[NodeSeq]

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 http : Http

def ignoreExtraJSONFields : Boolean

def instantiateRecord : BaseRecord

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

def isInstanceOf [T0] : Boolean

def jsonName (field: net.liftweb.record.Field[_, BaseRecord]): String

def looseParsing [A] (f: ⇒ A): A

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

def mutable_? : Boolean

def ne (arg0: AnyRef): Boolean

def needAllJSONFields : Boolean

def notify (): Unit

def notifyAll (): Unit

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

def queryView (design: String, view: String, filter: (View) ⇒ View): Box[Seq[BaseRecord]]

def queryView (design: String, view: String): Box[Seq[BaseRecord]]

def queryViewDocs (design: String, view: String, filter: (View) ⇒ View): Box[Seq[BaseRecord]]

def queryViewDocs (design: String, view: String): Box[Seq[BaseRecord]]

def queryViewDocsFrom (database: Database, design: String, view: String, filter: (View) ⇒ View): Box[Seq[BaseRecord]]

def queryViewFrom (database: Database, design: String, view: String, filter: (View) ⇒ View): Box[Seq[BaseRecord]]

def queryViewProjection (design: String, view: String, filter: (View) ⇒ View, project: (QueryRow) ⇒ Box[JValue]): Box[Seq[BaseRecord]]

def queryViewProjection (design: String, view: String, project: (QueryRow) ⇒ Box[JValue]): Box[Seq[BaseRecord]]

def queryViewProjectionFrom (database: Database, design: String, view: String, filter: (View) ⇒ View, project: (QueryRow) ⇒ Box[JValue]): Box[Seq[BaseRecord]]

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

def save (inst: BaseRecord): Box[Unit]

def saved_? (inst: BaseRecord): Boolean

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

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

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

def setFieldsFromReq (inst: BaseRecord, req: Req): Unit

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

def toForm (inst: BaseRecord, template: NodeSeq): NodeSeq

def toForm (inst: BaseRecord): NodeSeq

def toString (): String

def toXHtml (inst: BaseRecord): NodeSeq

def validate (inst: BaseRecord): List[FieldError]

def wait (): Unit

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

def wait (arg0: Long): Unit

Inherited from JSONMetaRecord[BaseRecord]