net.liftweb.record.MetaRecord

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

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 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
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
def asJValue (rec: BaseRecord): JObject

Encode a record instance into a JValue
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
def clone (): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def createRecord : BaseRecord

Creates a new record
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
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)
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
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)
def finalize (): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def foreachCallback (inst: BaseRecord, f: (LifecycleCallbacks) ⇒ Any): Unit

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));

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]
def fromJValue (jvalue: JValue): Box[BaseRecord]

Create a record by decoding a JValue which must be a JObject
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]
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
def getClass (): java.lang.Class[_]

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

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

See also
Record
def mutable_? : Boolean

Specifies if this Record is mutable or not
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
val rootClass : java.lang.Class[_ >: ?0]

Attributes
protected
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
def setFieldsFromJValue (rec: BaseRecord, jvalue: JValue): Box[Unit]

Attempt to decode a JValue, which must be a JObject, into a record instance
def setFieldsFromJsonString (inst: BaseRecord, json: String): Box[Unit]

Set from a Json String using the lift-json parser
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
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
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
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
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
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()

MetaRecord

trait MetaRecord [BaseRecord <: Record[BaseRecord]] extends AnyRef

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 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 eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

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 instantiateRecord : BaseRecord

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

def isInstanceOf [T0] : Boolean

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

def mutable_? : Boolean

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit

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

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

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 AnyRef

Inherited from Any