net.liftweb.mongodb.record.field
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.
Default read-only rendering of field
Default read-only rendering of field
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.
Helper for implementing asJValue for a conversion to an encoded JString
Helper for implementing asJValue for a conversion to an encoded JString
function to transform the field value into a String
Encode the field value into a JValue
Encode the field value into a JValue
Returns the field's value as a valid JavaScript expression
Returns the field's value as a valid JavaScript expression
Convert the field to a String.
Convert the field to a String... usually of the form "displayName=value"
Perform an atomic update of this Settable.
Perform an atomic update of this Settable. The current value is passed to the function and the ValueHolder is set to the result of the function. This is enclosed in the performAtomicOperation method which will, by default, synchronize this instance
Can the value of this field be read without obscuring the result?
Can the value of this field be read without obscuring the result?
Can the value of this field be written?
Can the value of this field be written?
If the owner is not in "safe" mode, check the current environment to see if the field can be read
If the owner is not in "safe" mode, check the current environment to see if the field can be read
If the owner is not in "safe" mode, check the current environment to see if the field can be written
If the owner is not in "safe" mode, check the current environment to see if the field can be written
Clear the value of this field
Clear the value of this field
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.
The default value of the field when a field has no value set and is optional, or a method that must return a value (e.
The default value of the field when a field has no value set and is optional, or a method that must return a value (e.g. value) is used
The default value of the field when no value is set.
The default value of the field when no value is set. Must return a Full Box unless optional_? is true
The display name of this field (e.
The display name of this field (e.g., "First Name")
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)
).
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
A unique 'id' for the field for form generation
A unique 'id' for the field for form generation
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 finalize
and non-local returns and exceptions, are all platform dependent.
Generic implementation of setFromAny that implements exactly what the doc for setFromAny specifies, using a Manifest to check types
Generic implementation of setFromAny that implements exactly what the doc for setFromAny specifies, using a Manifest to check types
get the value
get the value
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.
Should the field be ignored by the OR Mapper?
Should the field be ignored by the OR Mapper?
Get the value.
Get the value. Use get.
@deprecated
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.
OptionalTypedField and MandatoryTypedField implement this to do the appropriate lifting of Box[MyType] to ValueType
OptionalTypedField and MandatoryTypedField implement this to do the appropriate lifting of Box[MyType] to ValueType
The text name of this field
The text name of this field
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.
The error message used when the field value could not be set
The error message used when the field value could not be set
The error message used when the field value must be set
The error message used when the field value must be set
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.
Is the value of this field optional (e.
Is the value of this field optional (e.g. NULLable)?
Return the owner of this field
Return the owner of this field
Perform an atomic operation on the Settable.
Perform an atomic operation on the Settable. By default synchronizes the instance, but it could use other mechanisms
use productIterator instead
Is the Field required (and will have a style designating it as such)
Is the Field required (and will have a style designating it as such)
Helper function that does validation of a value by using the validators specified for the field
Helper function that does validation of a value by using the validators specified for the field
Are we in "safe" mode (i.
Are we in "safe" mode (i.e., the value of the field can be read or written without any security checks.)
Set the value of the field to the given value.
Set the value of the field to the given value. Note: Because setting a field can fail (return non-Full), this method will return defaultValue if the field could not be set.
A list of functions that transform the value before it is set.
A list of functions that transform the value before it is set. The transformations are also applied before the value is used in a query. Typical applications of this are trimming and/or toLowerCase-ing strings
A list of functions that transform the value before it is set.
A list of functions that transform the value before it is set. The transformations are also applied before the value is used in a query. Typical applications of this are trimming and/or toLowerCase-ing strings
Set the value of the field from anything.
Set the value of the field from anything. Implementations of this method should accept at least the following (pattern => valueBox)
Note that setFromAny should _always_ call setBox, even if the conversion fails. This is so that validation properly notes the error.
The method genericSetFromAny implements this guideline.
Helper for implementing setFromJValue for a conversion from an encoded JString
Helper for implementing setFromJValue for a conversion from an encoded JString
function to try and transform a String into a field value
Decode the JValue and set the field to the decoded value.
Decode the JValue and set the field to the decoded value. Returns Empty or Failure if the value could not be set
Set the value of the field using some kind of type-specific conversion from a String.
Set the value of the field using some kind of type-specific conversion from a String. By convention, if the field is optional_?, then the empty string should be treated as no-value (Empty). Note that setFromString should _always_ call setBox, even if the conversion fails. This is so that validation properly notes the error.
Full(convertedValue) if the conversion succeeds (the field value will be set by side-effect) Empty or Failure if the conversion does not succeed
Given the current context, should this field be displayed
Given the current context, should this field be displayed
Give the current state of things, should the this field be shown
Give the current state of things, should the this field be shown
Generate a form control for the field
Generate a form control for the field
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 the field value to an XHTML representation
Convert the field value to an XHTML representation
Is this an upload field so that a form that includes this field must be multi-part mime
Is this an upload field so that a form that includes this field must be multi-part mime
Validate this field's setting, returning any errors found
Validate this field's setting, returning any errors found