net.liftweb.mapper

KeyedMapper

trait KeyedMapper [KeyType, OwnerType <: KeyedMapper[KeyType, OwnerType]] extends Mapper[OwnerType] with BaseKeyedMapper

linear super types: BaseKeyedMapper, Mapper[OwnerType], BaseMapper, FieldContainer, AnyRef, Any
known subclasses: ProtoUser, ProtoTag, ProtoExtendedSession, OneToMany, KeyedMetaMapper, MetaProtoTag, MetaProtoExtendedSession, MetaMegaProtoUser, MegaProtoUser, LongKeyedMetaMapper, LongKeyedMapper, MetaLDAPProtoUser, LDAPProtoUser
self type: OwnerType
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. KeyedMapper
  2. BaseKeyedMapper
  3. Mapper
  4. BaseMapper
  5. FieldContainer
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. type FieldPF = PartialFunction[String, (NodeSeq) ⇒ NodeSeq]

    definition classes: Mapper
  2. type KeyedMapperType = OwnerType

    definition classes: KeyedMapperBaseKeyedMapper
  3. type MapperType = OwnerType

    definition classes: MapperBaseMapper
  4. type TheKeyType = KeyType

    definition classes: KeyedMapperBaseKeyedMapper

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 allFields : Seq[BaseField]

    definition classes: MapperFieldContainer
  9. def appendField (pf: FieldPF) : Unit

    definition classes: Mapper
  10. def asHtml : NodeSeq

    definition classes: Mapper
  11. 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
  12. def asJs : JsExp

    Convert the model to a JavaScript object

    Convert the model to a JavaScript object

    definition classes: Mapper
  13. def asSafeJs (f: KeyObfuscator) : JsExp

  14. def asValid : Box[OwnerType]

    Returns the instance in a Full Box if the instance is valid, otherwise returns a Failure with the validation errors

    Returns the instance in a Full Box if the instance is valid, otherwise returns a Failure with the validation errors

    definition classes: Mapper
  15. def checkNames : Unit

    definition classes: Mapper
  16. 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
  17. def comparePrimaryKeys (other: OwnerType) : Boolean

    definition classes: KeyedMapperMapper
  18. def connectionIdentifier : ConnectionIdentifier

    definition classes: Mapper
  19. def connectionIdentifier (id: ConnectionIdentifier) : OwnerType

    definition classes: Mapper
  20. def countryField : Box[MappedCountry[OwnerType]]

    definition classes: Mapper
  21. def dbCalculateConnectionIdentifier : PartialFunction[OwnerType, ConnectionIdentifier]

    definition classes: Mapper
  22. def dbName : String

    definition classes: MapperBaseMapper
  23. def db_can_delete_? : Boolean

    Can this model object be deleted?

    Can this model object be deleted?

    definition classes: Mapper
  24. def delete_! : Boolean

    Delete the model from the RDBMS

    Delete the model from the RDBMS

    definition classes: Mapper
  25. def dirty_? : Boolean

    definition classes: Mapper
  26. def doPostCommit (func: () ⇒ Unit) : OwnerType

    Append a function to perform after the commit happens

    Append a function to perform after the commit happens

    func

    - the function to perform after the commit happens

    definition classes: Mapper
  27. 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
  28. def equals (other: 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)).

    returns

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

    definition classes: KeyedMapper → AnyRef → Any
  29. def fieldByName [T] (fieldName: String) : Box[MappedField[T, OwnerType]]

    Find the field by name

    Find the field by name

    fieldName

    -- the name of the field to find

    returns

    Box[MappedField]

    definition classes: Mapper
  30. def fieldMapperPF (transform: (BaseOwnedMappedField[OwnerType]) ⇒ NodeSeq) : FieldPF

    definition classes: Mapper
  31. def fieldPF : FieldPF

    definition classes: Mapper
  32. 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
  33. def flatMapFieldTitleForm [T] (func: (NodeSeq, Box[NodeSeq], NodeSeq) ⇒ Seq[T]) : List[T]

    flat map the fields titles and forms to generate a list

    flat map the fields titles and forms to generate a list

    func

    called with displayHtml, fieldId, form

    definition classes: Mapper
  34. def flatMapFieldTitleForm2 [T] (func: (NodeSeq, net.liftweb.mapper.MappedField[_, OwnerType], NodeSeq) ⇒ Seq[T]) : List[T]

    flat map the fields titles and forms to generate a list

    flat map the fields titles and forms to generate a list

    func

    called with displayHtml, fieldId, form

    definition classes: Mapper
  35. def formFields : List[net.liftweb.mapper.MappedField[_, OwnerType]]

    Get the fields (in order) for displaying a form

    Get the fields (in order) for displaying a form

    definition classes: Mapper
  36. 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
  37. def getSingleton : KeyedMetaMapper[KeyType, OwnerType]

    attributes: abstract
    definition classes: KeyedMapperMapper
  38. 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: KeyedMapper → AnyRef → Any
  39. def htmlLine : NodeSeq

    definition classes: Mapper
  40. 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
  41. def localeField : Box[MappedLocale[OwnerType]]

    If there's a field in this record that defines the locale, return it

    If there's a field in this record that defines the locale, return it

    definition classes: Mapper
  42. def mapFieldTitleForm [T] (func: (NodeSeq, Box[NodeSeq], NodeSeq) ⇒ T) : List[T]

    map the fields titles and forms to generate a list

    map the fields titles and forms to generate a list

    func

    called with displayHtml, fieldId, form

    definition classes: Mapper
  43. 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
  44. 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
  45. 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
  46. def prependField (pf: FieldPF) : Unit

    definition classes: Mapper
  47. def primaryKeyField : MappedField[KeyType, OwnerType] with IndexedField[KeyType]

    attributes: abstract
    definition classes: KeyedMapperBaseKeyedMapper
  48. def reload : OwnerType

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

    definition classes: Mapper
  50. def safe_? : Boolean

    attributes: final
    definition classes: Mapper
  51. def save () : Boolean

    definition classes: MapperBaseMapper
  52. def saveMe () : OwnerType

    Save the instance and return the instance

    Save the instance and return the instance

    definition classes: Mapper
  53. def saved_? : Boolean

    definition classes: Mapper
  54. def suplementalJs (ob: Box[KeyObfuscator]) : List[(String, JsExp)]

    If the instance calculates any additional fields for JSON object, put the calculated fields here

    If the instance calculates any additional fields for JSON object, put the calculated fields here

    definition classes: Mapper
  55. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  56. implicit def thisToMappee (in: Mapper[OwnerType]) : OwnerType

    attributes: implicit
    definition classes: Mapper
  57. def timeZoneField : Box[MappedTimeZone[OwnerType]]

    definition classes: Mapper
  58. def toForm (button: Box[String], redoSnippet: (NodeSeq) ⇒ NodeSeq, onSuccess: (OwnerType) ⇒ Unit) : NodeSeq

    definition classes: Mapper
  59. def toForm (button: Box[String], f: (OwnerType) ⇒ Any) : 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: Mapper
  60. def toForm (button: Box[String], onSuccess: String) : 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

    onSuccess

    - redirect to the URL if the model validates, otherwise display the errors

    returns

    the form

    definition classes: Mapper
  61. def toHtml : NodeSeq

    Present the model as a HTML using the same formatting as toForm

    Present the model as a HTML using the same formatting as toForm

    returns

    the html view of the model

    definition classes: Mapper
  62. 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: Mapper → AnyRef → Any
  63. def toXml : Elem

    definition classes: Mapper
  64. def validate : List[FieldError]

    definition classes: Mapper
  65. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef

Inherited from BaseKeyedMapper

Inherited from Mapper[OwnerType]

Inherited from BaseMapper

Inherited from FieldContainer

Inherited from AnyRef

Inherited from Any