net.liftweb.mapper

CRUDify

trait CRUDify [KeyType, CrudType <: KeyedMapper[KeyType, CrudType]] extends Crudify

This trait automatically adds CRUD (Create, read, update and delete) operations to an existing MetaMapper object. Various methods can be overridden to customize which operations are available to a user and how things are displayed. For example, you can disable deletion of entities by overriding deleteMenuLoc to Empty.

Note: Compilation will fail if you try to mix this into a Mapper instead of the associated MetaMapper. You have been warned.

linear super types: Crudify, AnyRef, Any
known subclasses: LongCRUDify
self type: CRUDify[KeyType, CrudType] with CrudType with KeyedMetaMapper[KeyType, CrudType]
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. CRUDify
  2. Crudify
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. trait CrudBridge extends AnyRef

    This trait represents a Bridge between TheCrudType and the Crudify trait.

  2. trait FieldPointerBridge extends AnyRef

    attributes: protected
  3. type FieldPointerType = net.liftweb.mapper.MappedField[_, CrudType]

    What's a field pointer for the underlying CRUDify

    What's a field pointer for the underlying CRUDify

    definition classes: CRUDifyCrudify
  4. class MyBridge extends CrudBridge

    attributes: protected
  5. class MyPointer extends FieldPointerBridge

    attributes: protected
  6. type TheCrudType = CrudType

    What's the record type for the underlying CRUDify?

    What's the record type for the underlying CRUDify?

    definition classes: CRUDifyCrudify

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. lazy val CreateItem : String

    definition classes: Crudify
  9. lazy val DeleteItem : String

    definition classes: Crudify
  10. lazy val EditItem : String

    definition classes: Crudify
  11. lazy val ListItems : String

    definition classes: Crudify
  12. lazy val Prefix : List[String]

    definition classes: Crudify
  13. lazy val ViewItem : String

    definition classes: Crudify
  14. def _createTemplate : Elem

    The core template for creating.

    The core template for creating. Does not include any page wrapping

    definition classes: Crudify
  15. def _deleteTemplate : Elem

    The core template for deleting.

    The core template for deleting. Does not include any page wrapping

    definition classes: Crudify
  16. def _editTemplate : Elem

    The core template for editting.

    The core template for editting. Does not include any page wrapping

    attributes: protected
    definition classes: Crudify
  17. def _showAllTemplate : Elem

    The core template for showing record.

    The core template for showing record. Does not include any page wrapping

    definition classes: Crudify
  18. def _viewTemplate : Elem

    The core template for viewing.

    The core template for viewing. Does not include any page wrapping

    definition classes: Crudify
  19. def addlMenuLocParams : List[AnyLocParam]

    If there are any Loc.

    If there are any Loc.LocParams that need to be added to every menu (e.g., a guard for access control of the Crudify screens)

    attributes: protected
    definition classes: Crudify
  20. 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
  21. implicit def buildBridge (from: TheCrudType) : CrudBridge

    This method will instantiate a bridge from TheCrudType so that the appropriate logical operations can be performed on TheCrudType

    This method will instantiate a bridge from TheCrudType so that the appropriate logical operations can be performed on TheCrudType

    attributes: protected implicit
    definition classes: CRUDifyCrudify
  22. implicit def buildFieldBridge (from: FieldPointerType) : FieldPointerBridge

    Based on a FieldPointer, build a FieldPointerBridge

    Based on a FieldPointer, build a FieldPointerBridge

    attributes: protected implicit
    definition classes: CRUDifyCrudify
  23. def calcCreateItem : String

    definition classes: Crudify
  24. def calcDeleteItem : String

    definition classes: Crudify
  25. def calcEditItem : String

    definition classes: Crudify
  26. def calcListItems : String

    definition classes: Crudify
  27. def calcPrefix : List[String]

    What's the prefix for this CRUD.

    What's the prefix for this CRUD. Typically the table name

    definition classes: CRUDifyCrudify
  28. def calcViewItem : String

    definition classes: Crudify
  29. 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
  30. def computeFieldFromPointer (instance: TheCrudType, pointer: FieldPointerType) : Box[BaseField]

    Given a field pointer and an instance, get the field on that instance

    Given a field pointer and an instance, get the field on that instance

    attributes: protected
    definition classes: CRUDifyCrudify
  31. def create : TheCrudType

    Vend a new instance of TheCrudType

    Vend a new instance of TheCrudType

    attributes: abstract
    definition classes: Crudify
  32. def createButton : String

    definition classes: Crudify
  33. def createClass : String

    definition classes: Crudify
  34. def createId : String

    definition classes: Crudify
  35. def createMenuLoc : Box[Menu]

    The menu item for creating items (make this "Empty" to disable)

    The menu item for creating items (make this "Empty" to disable)

    definition classes: Crudify
  36. def createMenuLocParams : List[AnyLocParam]

    Override to include new Params for the create menu

    Override to include new Params for the create menu

    definition classes: Crudify
  37. def createMenuName : String

    definition classes: Crudify
  38. lazy val createPath : List[String]

    definition classes: Crudify
  39. lazy val createPathString : String

    definition classes: Crudify
  40. def createTemplate () : NodeSeq

    This is the template that's used to render the page after the optional wrapping of the template in the page wrapper

    This is the template that's used to render the page after the optional wrapping of the template in the page wrapper

    definition classes: Crudify
  41. def crudAllNext (first: Long, list: List[TheCrudType])(in: NodeSeq) : Node {...}

    Override this method to change how the next link is generated

    Override this method to change how the next link is generated

    attributes: protected
    definition classes: Crudify
  42. def crudAllPrev (first: Long)(in: NodeSeq) : Node {...}

    Override this method to change how the previous link is generated

    Override this method to change how the previous link is generated

    attributes: protected
    definition classes: Crudify
  43. def crudDoForm (item: TheCrudType, noticeMsg: String)(in: NodeSeq) : NodeSeq

    definition classes: Crudify
  44. def crudyDelete (item: TheCrudType)(html: NodeSeq) : NodeSeq

    Override this method to change how the delete screen is built

    Override this method to change how the delete screen is built

    attributes: protected
    definition classes: Crudify
  45. def deleteButton : String

    definition classes: Crudify
  46. def deleteClass : String

    definition classes: Crudify
  47. def deleteId : String

    definition classes: Crudify
  48. def deleteMenuLoc : Box[Menu]

    The menu item for deleting an item (make this "Empty" to disable)

    The menu item for deleting an item (make this "Empty" to disable)

    definition classes: Crudify
  49. def deleteMenuLocParams : List[LocParam[TheCrudType]]

    Override to include new Params for the delete menu

    Override to include new Params for the delete menu

    definition classes: Crudify
  50. def deleteMenuName : String

    definition classes: Crudify
  51. lazy val deletePath : List[String]

    definition classes: Crudify
  52. lazy val deletePathString : String

    definition classes: Crudify
  53. def deleteTemplate () : NodeSeq

    This is the template that's used to render the page after the optional wrapping of the template in the page wrapper

    This is the template that's used to render the page after the optional wrapping of the template in the page wrapper

    definition classes: Crudify
  54. def displayHtml : NodeSeq

    definition classes: Crudify
  55. def displayName : String

    definition classes: Crudify
  56. def displayRecord (entry: TheCrudType)(in: NodeSeq) : NodeSeq

    Customize the display of records for view menu loc

    Customize the display of records for view menu loc

    attributes: protected
    definition classes: Crudify
  57. def doCrudAll (in: NodeSeq) : NodeSeq

    Override this method if you want to change the behavior of displaying records via the crud.

    Override this method if you want to change the behavior of displaying records via the crud.all snippet

    attributes: protected
    definition classes: Crudify
  58. def doCrudAllHeaderItems (in: NodeSeq) : NodeSeq

    Override this method to customize how header items are treated

    Override this method to customize how header items are treated

    attributes: protected
    definition classes: Crudify
  59. def doCrudAllRowItem (c: TheCrudType)(in: NodeSeq) : NodeSeq

    Override this method to customize how a crudAll line is generated

    Override this method to customize how a crudAll line is generated

    attributes: protected
    definition classes: Crudify
  60. def doCrudAllRows (list: List[TheCrudType])(in: NodeSeq) : NodeSeq

    Override this method to determine how all the rows on a crud page are displayed

    Override this method to determine how all the rows on a crud page are displayed

    attributes: protected
    definition classes: Crudify
  61. def doDeleteFields (item: TheCrudType)(html: NodeSeq) : NodeSeq

    Override this method to change how fields are displayed for delete

    Override this method to change how fields are displayed for delete

    attributes: protected
    definition classes: Crudify
  62. def doDeleteSubmit (item: TheCrudType, from: String)() : Nothing

    Override this method to change the behavior of deleting an item

    Override this method to change the behavior of deleting an item

    attributes: protected
    definition classes: Crudify
  63. def doDisplayRecordRow (entry: TheCrudType)(in: NodeSeq) : NodeSeq

    Customize the display of a row for displayRecord

    Customize the display of a row for displayRecord

    attributes: protected
    definition classes: Crudify
  64. def editButton : String

    definition classes: Crudify
  65. def editClass : String

    definition classes: Crudify
  66. def editErrorClass : String

    definition classes: Crudify
  67. def editId : String

    definition classes: Crudify
  68. def editMenuLoc : Box[Menu]

    The menu item for editing an item (make this "Empty" to disable)

    The menu item for editing an item (make this "Empty" to disable)

    definition classes: Crudify
  69. def editMenuLocParams : List[LocParam[TheCrudType]]

    Override to include new Params for the edit menu

    Override to include new Params for the edit menu

    definition classes: Crudify
  70. def editMenuName : String

    The String displayed for menu editing

    The String displayed for menu editing

    definition classes: Crudify
  71. lazy val editPath : List[String]

    definition classes: Crudify
  72. lazy val editPathString : String

    definition classes: Crudify
  73. def editTemplate () : NodeSeq

    This is the template that's used to render the page after the optional wrapping of the template in the page wrapper

    This is the template that's used to render the page after the optional wrapping of the template in the page wrapper

    definition classes: Crudify
  74. 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
  75. 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
  76. def fieldsForDisplay : List[net.liftweb.mapper.MappedField[_, CrudType]]

    The fields to be displayed.

    The fields to be displayed. By default all the displayed fields, but this list can be shortened.

    definition classes: CRUDifyCrudify
  77. def fieldsForEditing : List[FieldPointerType]

    The list of fields to present on a form form editting

    The list of fields to present on a form form editting

    definition classes: Crudify
  78. def fieldsForList : List[FieldPointerType]

    The fields displayed on the list page.

    The fields displayed on the list page. By default all the displayed fields, but this list can be shortened.

    definition classes: Crudify
  79. 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
  80. def findForList (start: Long, count: Int) : List[TheCrudType]

    Get a List of items from the databased

    Get a List of items from the databased

    definition classes: CRUDifyCrudify
  81. def findForListParams : List[QueryParam[CrudType]]

    What are the query parameters? Default to ascending on primary key

    What are the query parameters? Default to ascending on primary key

  82. def findForParam (in: String) : Box[TheCrudType]

    Given a String that represents the primary key, find an instance of TheCrudType

    Given a String that represents the primary key, find an instance of TheCrudType

    definition classes: CRUDifyCrudify
  83. 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
  84. 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
  85. 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
  86. lazy val listPath : List[String]

    definition classes: Crudify
  87. lazy val listPathString : String

    definition classes: Crudify
  88. lazy val locSnippets : DispatchLocSnippets

    definition classes: Crudify
  89. def menus : List[Menu]

    definition classes: Crudify
  90. 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
  91. def nextWord : String

    definition classes: Crudify
  92. 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
  93. 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
  94. def obscurePrimaryKey (in: String) : String

    This method can be used to obscure the primary key.

    This method can be used to obscure the primary key. This is more secure because end users will not have access to the primary key. This method actually does the obfuscation. You can use Mapper's KeyObfuscator class to implement a nice implementation of this method for session-by-session obfuscation.

    By default, there's no obfuscation. Note that if you obfuscate the primary key, you need to update the findForParam method to accept the obfuscated keys (and translate them back.)

    definition classes: Crudify
  95. def obscurePrimaryKey (in: TheCrudType) : String

    This method can be used to obscure the primary key.

    This method can be used to obscure the primary key. This is more secure because end users will not have access to the primary key.

    definition classes: Crudify
  96. def pageWrapper (body: NodeSeq) : NodeSeq

    definition classes: Crudify
  97. def previousWord : String

    definition classes: Crudify
  98. def referer : String

    definition classes: Crudify
  99. def rowsPerPage : Int

    This method defines how many rows are displayed per page.

    This method defines how many rows are displayed per page. By default, it's hard coded at 20, but you can make it session specific or change the default by overriding this method

    attributes: protected
    definition classes: Crudify
  100. def showAllClass : String

    definition classes: Crudify
  101. def showAllId : String

    definition classes: Crudify
  102. def showAllMenuLoc : Box[Menu]

    The menu item for listing items (make this "Empty" to disable)

    The menu item for listing items (make this "Empty" to disable)

    definition classes: Crudify
  103. def showAllMenuLocParams : List[AnyLocParam]

    Override to include new Params for the show all menu

    Override to include new Params for the show all menu

    definition classes: Crudify
  104. def showAllMenuName : String

    definition classes: Crudify
  105. def showAllTemplate () : NodeSeq

    This is the template that's used to render the page after the optional wrapping of the template in the page wrapper

    This is the template that's used to render the page after the optional wrapping of the template in the page wrapper

    definition classes: Crudify
  106. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  107. 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
  108. def viewClass : String

    definition classes: Crudify
  109. def viewId : String

    definition classes: Crudify
  110. def viewMenuLoc : Box[Menu]

    The menu item for viewing an item (make this "Empty" to disable)

    The menu item for viewing an item (make this "Empty" to disable)

    definition classes: Crudify
  111. def viewMenuLocParams : List[LocParam[TheCrudType]]

    Override to include new Params for the view menu

    Override to include new Params for the view menu

    definition classes: Crudify
  112. def viewMenuName : String

    definition classes: Crudify
  113. lazy val viewPath : List[String]

    definition classes: Crudify
  114. lazy val viewPathString : String

    definition classes: Crudify
  115. def viewTemplate () : NodeSeq

    This is the template that's used to render the page after the optional wrapping of the template in the page wrapper

    This is the template that's used to render the page after the optional wrapping of the template in the page wrapper

    definition classes: Crudify
  116. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef
  119. def wrapNameInRequired (fieldName: NodeSeq, required: Boolean) : NodeSeq

    As the field names are being displayed for editting, this method is called with the XHTML that will be displayed as the field name an a flag indicating that the field is required (or not).

    As the field names are being displayed for editting, this method is called with the XHTML that will be displayed as the field name an a flag indicating that the field is required (or not). You can wrap the fieldName in a span with a css class indicating that the field is required or otherwise do something to update the field name indiciating to the user that the field is required. By default the method wraps the fieldName in a span with the class attribute set to "required_field"

    definition classes: Crudify

Inherited from Crudify

Inherited from AnyRef

Inherited from Any