What's a field pointer for the underlying CRUDify
What's a field pointer for the underlying CRUDify
Bridges from TheUserType to methods used in this class
The underlying record for the User
The underlying record for the User
Bridges from TheUserType to methods used in this class
o != arg0 is the same as !(o == (arg0)).
o != arg0 is the same as !(o == (arg0)).
the object to compare against this object for dis-equality.
false if the receiver object is equivalent to the argument; true otherwise.
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).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
o == arg0 is the same as o.equals(arg0).
o == arg0 is the same as o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
Insert this LocParam into your menu if you want the User's menu items to be inserted at the same level and after the item
replace the menu that has this LocParam with the User's menu items
Insert this LocParam into your menu if you want the User's menu items to be children of that menu
The table name, to lower case.
The table name, to lower case... ensures that it works on all DBs
Override this method to do something else after the user signs up
Override this method to do something else after the user signs up
Default add snippet.
Default add snippet. Override to change behavior of the add snippet.
Default callback behavior of the add snippet.
Default callback behavior of the add snippet. Called when the user presses submit. Saves the passed in object.
mapped object of this metamapper's type
Default setup behavior for the add snippet.
Default setup behavior for the add snippet. Creates a new mapped object.
new mapped object
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.
the receiver object.
Convert the model to a JavaScript object
Convert the model to a JavaScript object
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
This function is given a chance to log in a user programmatically when needed
This function is given a chance to log in a user programmatically when needed
Based on a FieldPointer, build a FieldPointerBridge
Based on a FieldPointer, build a FieldPointerBridge
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.
-- a Seq of the fields to be selected
-- the SuperConnection to be used for calculating the query
-- the varg of QueryParams
If there's any state that you want to capture pre-login to be set post-login (the session is destroyed), then set the state here.
If there's any state that you want to capture pre-login to be set post-login (the session is destroyed), then set the state here. Just make a function that captures the state... that function will be applied post login.
The menu item for changing password (make this "Empty" to disable)
The menu item for changing password (make this "Empty" to disable)
The LocParams for the menu item for changing password.
The LocParams for the menu item for changing password. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
Returns true if none of the fields are dirty
Returns true if none of the fields are dirty
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.
a copy of the receiver object.
This method returns true if the named column is the primary key and it is autogenerated
This method returns true if the named column is the primary key and it is autogenerated
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
Create a new instance of the User
Create a new instance of the User
The menu item for creating the user/sign up (make this "Empty" to disable)
The menu item for creating the user/sign up (make this "Empty" to disable)
The LocParams for the menu item for creating the user/sign up.
The LocParams for the menu item for creating the user/sign up. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
Defines the default CRUD snippets.
Defines the default CRUD snippets. Override if you want to change the names of the snippets. Defaults are "add", "edit", and "view".
(No, there's no D in CRUD.)
Override this definition in your model to enable CRUD snippets for that model.
Override this definition in your model to enable CRUD snippets for that model. Set to false by default.
Remember to override editSnippetSetup and viewSnippetSetup as well, as the defaults are broken.
false
The name of the mapped object
The name of the mapped object
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
Can this model object be deleted?
Can this model object be deleted?
Decode the fields from a JSON Object.
Decode the fields from a JSON Object. Should the fields be marked as dirty?
Delete the model from the RDBMS
Delete the model from the RDBMS
By default, destroy the session on login.
By default, destroy the session on login. Change this is some of the session information needs to be preserved.
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.
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
Append a function to perform after the commit happens
Append a function to perform after the commit happens
- the function to perform after the commit happens
The list of fields presented to the user for editing
The list of fields presented to the user for editing
Default edit snippet.
Default edit snippet. Override to change behavior of the edit snippet.
Default callback behavior of the edit snippet.
Default callback behavior of the edit snippet. Called when the user presses submit. Saves the passed in object.
mapped object of this metamapper's type
Default setup behavior for the edit snippet.
Default setup behavior for the edit snippet. BROKEN! MUST OVERRIDE IF USING CRUD SNIPPETS!
a mapped object of this metamapper's type
The menu item for editing the user (make this "Empty" to disable)
The menu item for editing the user (make this "Empty" to disable)
The LocParams for the menu item for editing the user.
The LocParams for the menu item for editing the user. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
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.
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).
the object to compare against this object for reference equality.
true if the argument is a reference to the receiver object; false otherwise.
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)).
true if the receiver object is equivalent to the argument; false otherwise.
Get a field by the field name
Get a field by the field name
-- the name of the field to get
-- the instance to get the field on
Box[The Field] (Empty if the field is not found)
Find the field by name
Find the field by name
-- the name of the field to find
Box[MappedField]
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.
Find the element based on the first element of the List
Find the element based on the first element of the List
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.
A function that takes a SuperConnection and returns a PreparedStatement.
A List of Mapper instances.
Find an element by primary key or create a new one
Find an element by primary key or create a new one
Find an element by primary key or create a new one
Find an element by primary key or create a new one
Given a unique id, find the user
Given a unique id, find the user
Given an username (probably email address), find the user
Given an username (probably email address), find the user
flat map the fields titles and forms to generate a list
flat map the fields titles and forms to generate a list
called with displayHtml, fieldId, form
flat map the fields titles and forms to generate a list
flat map the fields titles and forms to generate a list
called with displayHtml, fieldId, form
flat map the fields titles and forms to generate a list
flat map the fields titles and forms to generate a list
called with displayHtml, fieldId, form
flat map the fields titles and forms to generate a list
flat map the fields titles and forms to generate a list
called with displayHtml, fieldId, form
Get the fields (in order) for displaying a form
Get the fields (in order) for displaying a form
Get the fields (in order) for displaying a form
Get the fields (in order) for displaying a form
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.
Generate the mail bodies to send with the password reset link.
Generate the mail bodies to send with the password reset link. By default, just an HTML mail body is generated by calling passwordResetMailBody but you can send additional or alternative mail by overriding this method.
Generate the mail bodies to send with the valdiation link.
Generate the mail bodies to send with the valdiation link. By default, just an HTML mail body is generated by calling signupMailBody but you can send additional or alternative mail by override this method.
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
-- the Mapper instance
-- the field from the MetaMapper (Singleton)
the field from the actual object
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
-- the Mapper instance
-- the field from the MetaMapper (Singleton)
the field from the actual object
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.
a representation that corresponds to the dynamic class of the receiver object.
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.
the hash code value for the object.
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.
true if the receiver object is an instance of erasure of type T0; false otherwise.
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
The menu item for login (make this "Empty" to disable)
The menu item for login (make this "Empty" to disable)
The LocParams for the menu item for login.
The LocParams for the menu item for login. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
Return the URL of the "login" page
Return the URL of the "login" page
The menu item for logout (make this "Empty" to disable)
The menu item for logout (make this "Empty" to disable)
The LocParams for the menu item for logout.
The LocParams for the menu item for logout. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
The menu item for lost password (make this "Empty" to disable)
The menu item for lost password (make this "Empty" to disable)
The LocParams for the menu item for lost password.
The LocParams for the menu item for lost password. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
map the fields titles and forms to generate a list
map the fields titles and forms to generate a list
called with displayHtml, fieldId, form
map the fields titles and forms to generate a list
map the fields titles and forms to generate a list
called with displayHtml, fieldId, form
An alias for the sitemap property
An alias for the sitemap property
Default snippet for modification.
Default snippet for modification. Used by the default add and edit snippets.
If there's any mutation to do to the user on retrieval for editting, override this method and mutate the user.
If there's any mutation to do to the user on retrieval for editting, override this method and mutate the user. This can be used to pull query parameters from the request and assign certain fields. Issue #722
the user to mutate
the mutated user
If there's any mutation to do to the user on creation for signup, override this method and mutate the user.
If there's any mutation to do to the user on creation for signup, override this method and mutate the user. This can be used to pull query parameters from the request and assign certain fields. . Issue #722
the user to mutate
the mutated user
o.ne(arg0) is the same as !(o.eq(arg0)).
o.ne(arg0) is the same as !(o.eq(arg0)).
the object to compare against this object for reference dis-equality.
false if the argument is not a reference to the receiver object; true otherwise.
Get a nice name for the user
Get a nice name for the user
Get an email link for the user
Get an email link for the user
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.
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.
Lame attempt at automatically getting an object from the HTTP parameters.
Lame attempt at automatically getting an object from the HTTP parameters. BROKEN! DO NOT USE! Only here so that existing sub-classes KeyedMetaMapper don't have to implement new methods when I commit the CRUD snippets code.
The menu item for resetting the password (make this "Empty" to disable)
The menu item for resetting the password (make this "Empty" to disable)
The LocParams for the menu item for resetting the password.
The LocParams for the menu item for resetting the password. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
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.
Save the instance and return the instance
Save the instance and return the instance
What template are you going to wrap the various nodes in
What template are you going to wrap the various nodes in
Send password reset email to the user.
Send password reset email to the user. The XHTML version of the mail body is generated by calling passwordResetMailBody. You can customize the mail sent to users by overriding generateResetEmailBodies to send non-HTML mail or alternative mail bodies.
Send validation email to the user.
Send validation email to the user. The XHTML version of the mail body is generated by calling signupMailBody. You can customize the mail sent to users by override generateValidationEmailBodies to send non-HTML mail or alternative mail bodies.
Get a nice name for the user
Get a nice name for the user
The list of fields presented to the user at sign-up
The list of fields presented to the user at sign-up
The SiteMap mutator function
The SiteMap mutator function
Is there a user logged in and are they a superUser?
Is there a user logged in and are they a superUser?
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
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
- If it's Full, put a submit button on the form with the value of the parameter
- the function to execute on form submission
the form
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
- If it's Full, put a submit button on the form with the value of the parameter
- redirect to the URL if the model validates, otherwise display the errors
the form
Present the model as a HTML using the same formatting as toForm
Present the model as a HTML using the same formatting as toForm
the instance to generate the HTML for
the html view of the model
Present the model as a HTML using the same formatting as toForm
Present the model as a HTML using the same formatting as toForm
the html view of the model
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
a string representation of the object.
Convert an instance of TheUserType to the Bridge trait
Convert an instance of TheUserType to the Bridge trait
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.
Given a String representing the User ID, find the user
Given a String representing the User ID, find the user
How do we prompt the user for the username.
How do we prompt the user for the username. By default, it's S.??("email.address"), you can can change it to something else
The string that's generated when the user name is not found.
The string that's generated when the user name is not found. By default: S.??("email.address.not.found")
Override this method to validate the user signup (eg by adding captcha verification)
Override this method to validate the user signup (eg by adding captcha verification)
The menu item for validating a user (make this "Empty" to disable)
The menu item for validating a user (make this "Empty" to disable)
The LocParams for the menu item for validating a user.
The LocParams for the menu item for validating a user. Overwrite in order to add custom LocParams. Attention: Not calling super will change the default behavior!
If there are model-specific validations to perform, override this method and return an additional list of validations to perform
If there are model-specific validations to perform, override this method and return an additional list of validations to perform
Default view snippet.
Default view snippet. Override to change behavior of the view snippet.
Default setup behavior for the view snippet.
Default setup behavior for the view snippet. BROKEN! MUST OVERRIDE IF USING CRUD SNIPPETS!
a mapped object of this metamapper's type
Mix this trait into the the Mapper singleton for User and you get a bunch of user functionality including password reset, etc.