Packages

t

net.liftweb.mapper

MetaMapper

trait MetaMapper[A <: Mapper[A]] extends BaseMetaMapper with Mapper[A]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MetaMapper
  2. Mapper
  3. SourceInfo
  4. Serializable
  5. Serializable
  6. BaseMapper
  7. FieldContainer
  8. BaseMetaMapper
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AnyBound = T forSome {type T}
  2. case class FieldHolder (name: String, method: Method, field: MappedField[_, A]) extends Product with Serializable
  3. type FieldPF = PartialFunction[String, (NodeSeq) ⇒ NodeSeq]
    Definition Classes
    Mapper
  4. type MapperType = A
    Definition Classes
    Mapper → BaseMapper
  5. type OtherMapper = KeyedMapper[_, _]
  6. type OtherMetaMapper = KeyedMetaMapper[_, _]
  7. type RealType = A
    Definition Classes
    MetaMapper → BaseMetaMapper

Abstract Value Members

  1. abstract def getSingleton: MetaMapper[A]
    Definition Classes
    Mapper

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def _dbTableNameLC: String

    The table name, to lower case...

    The table name, to lower case... ensures that it works on all DBs

    Definition Classes
    MetaMapper → BaseMetaMapper
  5. def addEndStuffs(in: String, params: List[QueryParam[A]], conn: SuperConnection): (String, Box[Long], Box[Long])
    Attributes
    protected
  6. def afterCommit: List[(A) ⇒ Unit]
  7. def afterCreate: List[(A) ⇒ Unit]
  8. def afterDelete: List[(A) ⇒ Unit]
  9. def afterSave: List[(A) ⇒ Unit]
  10. def afterSchemifier: Unit
    Definition Classes
    MetaMapper → BaseMetaMapper
  11. def afterUpdate: List[(A) ⇒ Unit]
  12. def afterValidation: List[(A) ⇒ Unit]
  13. def afterValidationOnCreate: List[(A) ⇒ Unit]
  14. def afterValidationOnUpdate: List[(A) ⇒ Unit]
  15. def allFieldNames(): Seq[(String, SourceFieldMetadata)]

    Get a list of all the fields

    Get a list of all the fields

    returns

    a list of all the fields

    Definition Classes
    Mapper → SourceInfo
  16. def allFields: Seq[BaseField]
    Definition Classes
    Mapper → FieldContainer
  17. def appendFieldToStrings(in: A): String
  18. def appendFieldTransform(transform: CssSel): Unit
    Definition Classes
    Mapper
  19. def asHtml(toLine: A): NodeSeq
  20. def asHtml: NodeSeq
    Definition Classes
    Mapper
  21. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  22. def asJs(actual: A): JsExp
  23. def asJs: JsExp

    Convert the model to a JavaScript object

    Convert the model to a JavaScript object

    Definition Classes
    Mapper
  24. def asValid: Box[A]

    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
  25. def beforeCreate: List[(A) ⇒ Unit]
  26. def beforeDelete: List[(A) ⇒ Unit]
  27. def beforeSave: List[(A) ⇒ Unit]
  28. def beforeSchemifier: Unit
    Definition Classes
    MetaMapper → BaseMetaMapper
  29. def beforeUpdate: List[(A) ⇒ Unit]
  30. def beforeValidation: List[(A) ⇒ Unit]
  31. def beforeValidationOnCreate: List[(A) ⇒ Unit]
  32. def beforeValidationOnUpdate: List[(A) ⇒ Unit]
  33. implicit def boundedFieldToItem(in: (MappedField[String, A], Int)): BoundedIndexField[A]
  34. def buildMapper(rs: ResultSet): List[Box[(ResultSet, Int, A) ⇒ Unit]]
  35. def buildSelectString(fields: Seq[SelectableField], conn: SuperConnection, by: QueryParam[A]*): (String, Box[Long], Box[Long], List[QueryParam[A]])

    Given fields, a connection and the query parameters, build a query and return the query String, and Start or MaxRows values (depending on whether the driver supports LIMIT and OFFSET) and the complete List of QueryParams based on any synthetic query parameters calculated during the query creation.

    Given fields, a connection and the query parameters, build a query and return the query String, and Start or MaxRows values (depending on whether the driver supports LIMIT and OFFSET) and the complete List of QueryParams based on any synthetic query parameters calculated during the query creation.

    fields

    -- a Seq of the fields to be selected

    conn

    -- the SuperConnection to be used for calculating the query

    by

    -- the varg of QueryParams

    returns

    a Tuple of the Query String, Start (offset), MaxRows (limit), and the list of all query parameters including and synthetic query parameters

  36. def bulkDelete_!!(dbId: ConnectionIdentifier, by: QueryParam[A]*): Boolean
  37. def bulkDelete_!!(by: QueryParam[A]*): Boolean
  38. def checkNames: Unit
    Definition Classes
    Mapper
  39. def clean_?(toCheck: A): Boolean

    Returns true if none of the fields are dirty

  40. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. val columnNamesForInsert: String
  42. def columnPrimaryKey_?(name: String): Boolean

    This method returns true if the named column is the primary key and it is autogenerated

  43. val columnQueriesForInsert: String
  44. def comparePrimaryKeys(other: A): Boolean
    Definition Classes
    Mapper
  45. def connectionIdentifier: ConnectionIdentifier
    Definition Classes
    Mapper
  46. def connectionIdentifier(id: ConnectionIdentifier): A
    Definition Classes
    Mapper
  47. def count(by: QueryParam[A]*): Long
  48. def count: Long
  49. def countByInsecureSql(query: String, checkedBy: IHaveValidatedThisSQL): Long
  50. def countByInsecureSqlDb(dbId: ConnectionIdentifier, query: String, checkedBy: IHaveValidatedThisSQL): Long
  51. def countDb(dbId: ConnectionIdentifier, by: QueryParam[A]*): Long
  52. def countryField: Box[MappedCountry[A]]
    Definition Classes
    Mapper
  53. def create: A
  54. def createInstance: A
  55. def createInstance(dbId: ConnectionIdentifier, rs: ResultSet, mapFuncs: List[Box[(ResultSet, Int, A) ⇒ Unit]]): A
  56. def createInstances[T](dbId: ConnectionIdentifier, rs: ResultSet, start: Box[Long], omax: Box[Long], f: (A) ⇒ Box[T]): List[T]
  57. def createInstances(dbId: ConnectionIdentifier, rs: ResultSet, start: Box[Long], omax: Box[Long]): List[A]
  58. def dbAddTable: Box[() ⇒ Unit]
    Definition Classes
    MetaMapper → BaseMetaMapper
  59. def dbCalculateConnectionIdentifier: PartialFunction[A, ConnectionIdentifier]
    Definition Classes
    Mapper
  60. def dbDefaultConnectionIdentifier: ConnectionIdentifier
  61. def dbIndexes: List[BaseIndex[A]]
    Definition Classes
    MetaMapper → BaseMetaMapper
  62. def dbName: String

    The name of the mapped object

    The name of the mapped object

    Definition Classes
    MetaMapper → Mapper → BaseMapper
  63. def dbTableName: String

    The name of the database table.

    The name of the database table. Override this method if you want to change the table to something other than the name of the Mapper class

    Definition Classes
    MetaMapper → BaseMetaMapper
  64. def db_can_delete_?: Boolean

    Can this model object be deleted?

    Can this model object be deleted?

    Definition Classes
    Mapper
  65. def decodeFromJSON_!(json: JObject, markFieldsAsDirty: Boolean): A

    Decode the fields from a JSON Object.

    Decode the fields from a JSON Object. Should the fields be marked as dirty?

    Attributes
    protected
  66. def delete_!(toDelete: A): Boolean
  67. def delete_!: Boolean

    Delete the model from the RDBMS

    Delete the model from the RDBMS

    Definition Classes
    Mapper
  68. def dirty_?(toTest: A): Boolean
  69. def dirty_?: Boolean
    Definition Classes
    Mapper
  70. val displayFieldAsLineElement: (NodeSeq) ⇒ NodeSeq

    This function converts an element into the appropriate XHTML format for displaying across a line formatted block.

    This function converts an element into the appropriate XHTML format for displaying across a line formatted block. The default is <td> for use in XHTML tables. If you change this function, the change will be used for this MetaMapper unless you override the doHtmlLine method.

  71. val displayNameToHeaderElement: (String) ⇒ NodeSeq

    This function converts a header name into the appropriate XHTML format for displaying across the headers of a formatted block.

    This function converts a header name into the appropriate XHTML format for displaying across the headers of a formatted block. The default is <th> for use in XHTML tables. If you change this function, the change will be used for this MetaMapper unless you override the htmlHeades method

  72. lazy val doAllFieldNames: Seq[(String, SourceFieldMetadata)]

    Get a list of all the fields

    Get a list of all the fields

    returns

    a list of all the fields

  73. def doHtmlLine(toLine: A): NodeSeq
  74. def doPostCommit(func: () ⇒ Unit): A

    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
  75. val elemName: String
  76. def encodeAsJSON_!(toEncode: A): JObject

    This method will encode the instance as JSON.

    This method will encode the instance as JSON. It may reveal data in fields that might otherwise be proprietary. It should be used with caution and only exposed as a public method after a security review.

    Attributes
    protected
  77. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  78. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  79. def fieldByName[T](fieldName: String, actual: A): Box[MappedField[T, A]]

    Get a field by the field name

    Get a field by the field name

    fieldName

    -- the name of the field to get

    actual

    -- the instance to get the field on

    returns

    Box[The Field] (Empty if the field is not found)

  80. def fieldByName[T](fieldName: String): Box[MappedField[T, A]]

    Find the field by name

    Find the field by name

    fieldName

    -- the name of the field to find

    returns

    Box[MappedField]

    Definition Classes
    Mapper
  81. def fieldMapperTransforms(fieldHtml: (BaseOwnedMappedField[A]) ⇒ NodeSeq, mappedObject: A): Seq[CssSel]

    A set of CssSels that can be used to bind this MetaMapper's fields.

    A set of CssSels that can be used to bind this MetaMapper's fields.

    Elements with a class matching the field name are mapped to the NodeSeq produced by the fieldHtml function that is passed in.

    So, with a MetaMapper that has three fields, name, date, and description, the resulting CSS selector transforms are:

    Seq(
  ".name" #> fieldHtml(-name field-),
  ".date" #> fieldHtml(-date field-),
  ".description" #> fieldHtml(-description field-)
)

    Above, -name field-, -date field-, and -description field- refer to the actual MappedField objects for those fields.

  82. def fieldMapperTransforms(fieldTransform: (BaseOwnedMappedField[A]) ⇒ NodeSeq): Seq[CssSel]

    Given a function that takes a mapper field and returns a NodeSeq for the field, return, for this mapper instance, a set of CSS selector transforms that will transform a form for those fields into a fully-bound form that will interact with this instance.

    Given a function that takes a mapper field and returns a NodeSeq for the field, return, for this mapper instance, a set of CSS selector transforms that will transform a form for those fields into a fully-bound form that will interact with this instance.

    Definition Classes
    Mapper
  83. lazy val fieldMatcher: PartialFunction[(A, String), MappedField[Any, A]]

    A partial function that takes an instance of A and a field name and returns the mapped field

  84. lazy val fieldNamesAsMap: Map[String, SourceFieldMetadata]

    Get a list of all the fields as a map

    Get a list of all the fields as a map

    returns

    a list of all the fields

  85. def fieldOrder: List[BaseOwnedMappedField[A]]
  86. implicit def fieldToItem[T](in: MappedField[T, A]): IndexItem[A]
  87. def fieldTransforms: Seq[CssSel]

    A list of CSS selector transforms that will help render the fields of this mapper object.

    A list of CSS selector transforms that will help render the fields of this mapper object.

    Definition Classes
    Mapper
  88. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  89. def findAll(by: QueryParam[A]*): List[A]
  90. def findAll(): List[A]
  91. def findAllByInsecureSql(query: String, checkedBy: IHaveValidatedThisSQL): List[A]
  92. def findAllByInsecureSqlDb(dbId: ConnectionIdentifier, query: String, checkedBy: IHaveValidatedThisSQL): List[A]
  93. def findAllByPreparedStatement(dbId: ConnectionIdentifier, stmt: PreparedStatement): List[A]
  94. def findAllByPreparedStatement(f: (SuperConnection) ⇒ PreparedStatement): List[A]

    Execute a PreparedStatement and return a List of Mapper instances.

    Execute a PreparedStatement and return a List of Mapper instances. f is where the user will do the work of creating the PreparedStatement and preparing it for execution.

    f

    A function that takes a SuperConnection and returns a PreparedStatement.

    returns

    A List of Mapper instances.

  95. def findAllByPreparedStatementDb[T](dbId: ConnectionIdentifier, stmt: PreparedStatement)(f: (A) ⇒ Box[T]): List[T]
  96. def findAllDb(dbId: ConnectionIdentifier, by: QueryParam[A]*): List[A]
  97. def findAllDb(dbId: ConnectionIdentifier): List[A]
  98. def findAllFields(fields: Seq[SelectableField], by: QueryParam[A]*): List[A]
  99. def findAllFieldsDb(dbId: ConnectionIdentifier, fields: Seq[SelectableField], by: QueryParam[A]*): List[A]
  100. def findApplier(name: String, inst: AnyRef): Box[(A, AnyRef) ⇒ Unit]
    Attributes
    protected
  101. def findMap[T](by: QueryParam[A]*)(f: (A) ⇒ Box[T]): List[T]
  102. def findMapByInsecureSql[T](query: String, checkedBy: IHaveValidatedThisSQL)(f: (A) ⇒ Box[T]): List[T]
  103. def findMapByInsecureSqlDb[T](dbId: ConnectionIdentifier, query: String, checkedBy: IHaveValidatedThisSQL)(f: (A) ⇒ Box[T]): List[T]
  104. def findMapDb[T](dbId: ConnectionIdentifier, by: QueryParam[A]*)(f: (A) ⇒ Box[T]): List[T]
  105. def findMapFieldDb[T](dbId: ConnectionIdentifier, fields: Seq[SelectableField], by: QueryParam[A]*)(f: (A) ⇒ Box[T]): List[T]
  106. def findSourceField(name: String): Box[SourceFieldInfo]

    Given a name, look up the field

    Given a name, look up the field

    name

    the name of the field

    returns

    the metadata

    Definition Classes
    Mapper → SourceInfo
  107. def flatMapFieldTitleForm[T](toMap: A, 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

  108. 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
  109. def flatMapFieldTitleForm2[T](toMap: A, func: (NodeSeq, MappedField[_, A], 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

  110. def flatMapFieldTitleForm2[T](func: (NodeSeq, MappedField[_, A], 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
  111. def formFields(toMap: A): List[MappedField[_, A]]

    Get the fields (in order) for displaying a form

  112. def formFields: List[MappedField[_, A]]

    Get the fields (in order) for displaying a form

    Get the fields (in order) for displaying a form

    Definition Classes
    Mapper
  113. val formatFormElement: (NodeSeq, NodeSeq) ⇒ NodeSeq

    This function converts a name and form for a given field in the model to XHTML for presentation in the browser.

    This function converts a name and form for a given field in the model to XHTML for presentation in the browser. By default, a table row ( <tr> ) is presented, but you can change the function to display something else.

  114. def formatFormLine(displayName: NodeSeq, form: NodeSeq): NodeSeq
  115. def getActualBaseField(actual: A, protoField: BaseOwnedMappedField[A]): BaseOwnedMappedField[A]

    Given the prototype field (the field on the Singleton), get the field from the instance

    Given the prototype field (the field on the Singleton), get the field from the instance

    actual

    -- the Mapper instance

    protoField

    -- the field from the MetaMapper (Singleton)

    returns

    the field from the actual object

  116. def getActualField[T](actual: A, protoField: MappedField[T, A]): MappedField[T, A]

    Given the prototype field (the field on the Singleton), get the field from the instance

    Given the prototype field (the field on the Singleton), get the field from the instance

    actual

    -- the Mapper instance

    protoField

    -- the field from the MetaMapper (Singleton)

    returns

    the field from the actual object

  117. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  118. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  119. def htmlHeaders: NodeSeq
  120. def htmlLine: NodeSeq
    Definition Classes
    Mapper
  121. def indexedField(toSave: A): Box[MappedField[Any, A]]
  122. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  123. def localeField: Box[MappedLocale[A]]

    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
  124. def mapFieldTitleForm[T](toMap: A, 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

  125. 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
  126. lazy val mappedFields: Seq[BaseMappedField]

    The mapped fields

    The mapped fields

    Definition Classes
    MetaMapper → BaseMetaMapper
  127. lazy val mappedFieldsForModel: List[MappedField[_, A]]

    the mapped fields as MappedField rather than BaseMappedField

  128. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  129. final def notify(): Unit
    Definition Classes
    AnyRef
  130. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  131. def prependFieldTransform(transform: CssSel): Unit
    Definition Classes
    Mapper
  132. val rootClass: Class[?0] forSome {type ?0 <: MetaMapper[A] with A, type ?0 >: ?0}
    Attributes
    protected
  133. def runSafe[T](f: ⇒ T): T
    Definition Classes
    Mapper
  134. def runValidationList(toValidate: A): List[FieldError]

    Run the list of field validations, etc.

    Run the list of field validations, etc. This is the raw validation, without the notifications. This method can be over-ridden.

    Attributes
    protected
  135. final def safe_?: Boolean
    Definition Classes
    Mapper
  136. def save(toSave: A): Boolean
  137. def save(): Boolean
    Definition Classes
    Mapper → BaseMapper
  138. def saveMe(): A

    Save the instance and return the instance

    Save the instance and return the instance

    Definition Classes
    Mapper
  139. def saved_?(toSave: A): Boolean
  140. def saved_?: Boolean
    Definition Classes
    Mapper
  141. 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
  142. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  143. implicit def thisToMappee(in: Mapper[A]): A
    Definition Classes
    Mapper
  144. def timeZoneField: Box[MappedTimeZone[A]]
    Definition Classes
    Mapper
  145. def toForm(toMap: A): NodeSeq
  146. def toForm(button: Box[String], redoSnippet: (NodeSeq) ⇒ NodeSeq, onSuccess: (A) ⇒ Unit): NodeSeq
    Definition Classes
    Mapper
  147. def toForm(button: Box[String], f: (A) ⇒ 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
  148. 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
  149. def toHtml(toMap: A): 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

    toMap

    the instance to generate the HTML for

    returns

    the html view of the model

  150. 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
  151. def toString(): String
    Definition Classes
    Mapper → AnyRef → Any
  152. def toXml(what: A): Elem
  153. def toXml: Elem
    Definition Classes
    Mapper
  154. def updateFromJSON_!(toUpdate: A, json: JObject): A

    This method will update the instance from JSON.

    This method will update the instance from JSON. It allows for attacks from untrusted JSON as it bypasses normal security. By default, the method is protected. You can write a proxy method to expose the functionality.

    Attributes
    protected
  155. final def validate(toValidate: A): List[FieldError]
  156. def validate: List[FieldError]
    Definition Classes
    Mapper
  157. def validation: List[(A) ⇒ List[FieldError]]

    If there are model-specific validations to perform, override this method and return an additional list of validations to perform

  158. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  159. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  160. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  161. def whatToSet(toSave: A): String
  162. object addlQueryParams extends RequestVar[List[QueryParam[A]]]

Inherited from Mapper[A]

Inherited from SourceInfo

Inherited from Serializable

Inherited from Serializable

Inherited from BaseMapper

Inherited from FieldContainer

Inherited from BaseMetaMapper

Inherited from AnyRef

Inherited from Any

Ungrouped