net.liftweb.couchdb

CouchRecord

trait CouchRecord [MyType <: CouchRecord[MyType]] extends JSONRecord[MyType]

Base trait of records that can be stored in CouchDB

linear super types: JSONRecord[MyType], Record[MyType], FieldContainer, AnyRef, Any
self type: MyType
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. CouchRecord
  2. JSONRecord
  3. Record
  4. FieldContainer
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def _calcDatabase : Database

    Calculate the database for this record, falling back to the CouchMetaRecord's default database if calculateDatabase does not apply to this instance

    Calculate the database for this record, falling back to the CouchMetaRecord's default database if calculateDatabase does not apply to this instance

  9. def additionalJFields : List[JField]

    Additional fields that are not represented by Record fields, nor are fixed additional fields.

    Additional fields that are not represented by Record fields, nor are fixed additional fields. Default implementation is for preserving unknown fields across read/write

    definition classes: JSONRecord
  10. def additionalJFields_= (fields: List[JField]) : Unit

    Handle any additional fields that are not represented by Record fields when decoding from a JObject.

    Handle any additional fields that are not represented by Record fields when decoding from a JObject. Default implementation preserves the fields intact and returns them via additionalJFields

    definition classes: JSONRecord
  11. def allFields : List[net.liftweb.record.Field[_, MyType]]

    definition classes: RecordFieldContainer
  12. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  13. def asJSON : JsExp

    Retuns the JSON representation of this record

    Retuns the JSON representation of this record

    returns

    a JsObj

    definition classes: Record
  14. def asJValue : JObject

    Encode this record instance as a JObject

    Encode this record instance as a JObject

    definition classes: Record
  15. def asJsExp : JsExp

    Retuns the JSON representation of this record, converts asJValue to JsObj

    Retuns the JSON representation of this record, converts asJValue to JsObj

    returns

    a JsObj

    definition classes: Record
  16. def calculateDatabase : PartialFunction[MyType, Database]

    Override to calculate which database to use on a per-record basis

    Override to calculate which database to use on a per-record basis

  17. def canDelete_? : Boolean

    Can this record instance be deleted (e.

    Can this record instance be deleted (e.g. is it in the backing store in the first place?)

  18. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  19. def database : Database

    Return the database this record is associated with, determining it if necessary

    Return the database this record is associated with, determining it if necessary

  20. def database_= (database: Database) : Unit

    Set the current database (if any) for this record

    Set the current database (if any) for this record

  21. def delete_! : Box[Unit]

    Delete the record instance from the backing store

    Delete the record instance from the backing store

  22. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  23. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  24. def fieldByName (fieldName: String) : Box[net.liftweb.record.Field[_, MyType]]

    Find the field by name

    Find the field by name

    fieldName

    -- the name of the field to find

    returns

    Box[MappedField]

    definition classes: Record
  25. def fields () : List[net.liftweb.record.Field[_, MyType]]

    Get the fields defined on the meta object for this record instance

    Get the fields defined on the meta object for this record instance

    definition classes: Record
  26. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  27. def fixedAdditionalJFields : List[JField]

    By default include a "type" field with value calculated by the typeName method

    By default include a "type" field with value calculated by the typeName method

    definition classes: CouchRecordJSONRecord
  28. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  29. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  30. object id extends OptionalStringField[MyType] with JSONField

    The mandatory _id field

  31. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  32. def meta : CouchMetaRecord[MyType]

    Refine meta to require a CouchMetaRecord

    Refine meta to require a CouchMetaRecord

    attributes: abstract
    definition classes: CouchRecordJSONRecordRecord
  33. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  34. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  35. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  36. object rev extends OptionalStringField[MyType] with JSONField

    The mandatory _rev field

  37. def runSafe [T] (f: ⇒ T) : T

    definition classes: Record
  38. def safe_? : Boolean

    Is it safe to make changes to the record (or should we check access control?)

    Is it safe to make changes to the record (or should we check access control?)

    attributes: final
    definition classes: Record
  39. def save : Box[MyType]

    Save the record instance and return it

    Save the record instance and return it

  40. def saved_? : Boolean

    Return whether this instance was saved into the backing store or not

    Return whether this instance was saved into the backing store or not

  41. def setFieldsFromJSON (json: String) : Box[Unit]

    Sets the fields of this Record from the given JSON.

    Sets the fields of this Record from the given JSON.

    definition classes: Record
  42. def setFieldsFromJValue (jvalue: JValue) : Box[Unit]

    Set the fields of this record from the given JValue

    Set the fields of this record from the given JValue

    definition classes: Record
  43. def setFieldsFromJsonString (json: String) : Box[Unit]

    Sets the fields of this Record from the given JSON.

    Sets the fields of this Record from the given JSON.

    definition classes: Record
  44. def setFieldsFromReq (req: Req) : Unit

    Sets the fields of this Record from the given Req.

    Sets the fields of this Record from the given Req.

    definition classes: Record
  45. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  46. def toForm (f: (MyType) ⇒ Unit) : NodeSeq

    Present the model as a form and execute the function on submission of the form

    Present the model as a form and execute the function on submission of the form

    f

    - the function to execute on form submission

    returns

    the form

    definition classes: Record
  47. def toForm (button: Box[String])(f: (MyType) ⇒ Unit) : NodeSeq

    Present the model as a form and execute the function on submission of the form

    Present the model as a form and execute the function on submission of the form

    button

    - If it's Full, put a submit button on the form with the value of the parameter

    f

    - the function to execute on form submission

    returns

    the form

    definition classes: Record
  48. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  49. def toXHtml : NodeSeq

    Returns the HTML representation ofthis Record

    Returns the HTML representation ofthis Record

    definition classes: Record
  50. def typeName : String

    The value of the "type" field for this class of record.

    The value of the "type" field for this class of record. Only used with default implementation of extraEncodedFields. The default definition is the unqualified class name (e.g. the fully-qualified class name with the package name stripped)

  51. def validate : List[FieldError]

    Validates this Record by calling validators for each field

    Validates this 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: Record
  52. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  53. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  54. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from JSONRecord[MyType]

Inherited from Record[MyType]

Inherited from FieldContainer

Inherited from AnyRef

Inherited from Any