net.liftweb.mongodb.record.field

MongoRefField

trait MongoRefField[RefType <: MongoRecord[RefType], MyType] extends TypedField[MyType]

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. MongoRefField
  2. TypedField
  3. BaseField
  4. BaseField
  5. FieldContainer
  6. SettableField
  7. SettableValueHolder
  8. Settable
  9. ReadableField
  10. Bindable
  11. ValueHolder
  12. FieldIdentifier
  13. AnyRef
  14. Any
Visibility
  1. Public
  2. All

Type Members

  1. type MyType = MyType

    Definition Classes
    TypedField
  2. type ValidationFunction = (ValueType) ⇒ List[FieldError]

    Definition Classes
    TypedField
  3. abstract type ValueType

    Definition Classes
    ValueHolder

Abstract Value Members

  1. abstract def asJValue: JValue

    Encode the field value into a JValue

    Encode the field value into a JValue

    Definition Classes
    BaseField
  2. abstract def asJs: JsExp

    Returns the field's value as a valid JavaScript expression

    Returns the field's value as a valid JavaScript expression

    Definition Classes
    BaseField
  3. abstract def defaultValueBox: Box[MyType]

    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

    Definition Classes
    TypedField
  4. abstract def get: ValueType

    get the value

    get the value

    Definition Classes
    ValueHolder
  5. abstract def liftSetFilterToBox(in: Box[MyType]): Box[MyType]

    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

    Attributes
    protected
    Definition Classes
    TypedField
  6. abstract def refMeta: MongoMetaRecord[RefType]

    The MongoMetaRecord of the referenced object *

  7. abstract def set(in: ValueType): ValueType

    Definition Classes
    Settable
  8. abstract def setFromAny(in: Any): Box[MyType]

    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)

    • value: MyType => setBox(Full(value))
    • Some(value: MyType) => setBox(Full(value))
    • Full(value: MyType) => setBox(Full(value))
    • (value: MyType)::_ => setBox(Full(value))
    • s: String => setFromString(s)
    • Some(s: String) => setFromString(s)
    • Full(s: String) => setFromString(s)
    • null|None|Empty => setBox(defaultValueBox)
    • f: Failure => setBox(f) And usually convert the input to a string and uses setFromString as a last resort.

    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.

    Definition Classes
    TypedField
  9. abstract def setFromJValue(jvalue: JValue): Box[MyType]

    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

    Definition Classes
    TypedField
  10. abstract def setFromString(s: String): Box[MyType]

    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.

    returns

    Full(convertedValue) if the conversion succeeds (the field value will be set by side-effect) Empty or Failure if the conversion does not succeed

    Definition Classes
    TypedField
  11. abstract def toBoxMyType(in: ValueType): Box[MyType]

    Attributes
    protected
    Definition Classes
    TypedField
  12. abstract def toValueType(in: Box[MyType]): ValueType

    Attributes
    protected
    Definition Classes
    TypedField
  13. abstract def is: ValueType

    Get the value.

    Get the value. Use get.

    @deprecated

    Definition Classes
    ValueHolder
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use get

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def allFields: Seq[BaseField]

    Definition Classes
    BaseFieldFieldContainer
  7. def asHtml: NodeSeq

    Default read-only rendering of field

    Default read-only rendering of field

    Definition Classes
    ReadableFieldBindable
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def asJString(encode: (MyType) ⇒ String): JValue

    Helper for implementing asJValue for a conversion to an encoded JString

    Helper for implementing asJValue for a conversion to an encoded JString

    encode

    function to transform the field value into a String

    Attributes
    protected
    Definition Classes
    TypedField
  10. def asString: String

    Convert the field to a String.

    Convert the field to a String... usually of the form "displayName=value"

    Definition Classes
    TypedFieldBaseField
  11. def atomicUpdate(f: (ValueType) ⇒ ValueType): ValueType

    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

    Definition Classes
    Settable
  12. implicit def boxNodeFuncToFieldError(in: (Box[MyType]) ⇒ Box[Node]): (Box[MyType]) ⇒ List[FieldError]

    Attributes
    protected
    Definition Classes
    TypedField
  13. implicit def boxNodeToFieldError(in: Box[Node]): List[FieldError]

    Attributes
    protected
    Definition Classes
    TypedField
  14. def buildDisplayList: List[(Box[MyType], String)]

  15. def cached_?: Boolean

  16. def canRead_?: Boolean

    Can the value of this field be read without obscuring the result?

    Can the value of this field be read without obscuring the result?

    Definition Classes
    BaseField
  17. def canWrite_?: Boolean

    Can the value of this field be written?

    Can the value of this field be written?

    Definition Classes
    BaseField
  18. def checkCanRead_?: Boolean

    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

    Definition Classes
    BaseField
  19. def checkCanWrite_?: Boolean

    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

    Definition Classes
    BaseField
  20. def clear: Unit

    Clear the value of this field

    Clear the value of this field

    Definition Classes
    TypedField
  21. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  22. def dirty_?: Boolean

    Definition Classes
    BaseField
  23. def dirty_?(b: Boolean): Unit

    Attributes
    protected
    Definition Classes
    BaseField
  24. def displayHtml: NodeSeq

    Definition Classes
    ReadableField
  25. def displayName: String

    The display name of this field (e.

    The display name of this field (e.g., "First Name")

    Definition Classes
    ReadableField
  26. def displayNameHtml: Box[NodeSeq]

    Definition Classes
    ReadableField
  27. def emptyOptionLabel: String

    Label for the selection item representing Empty, show when this field is optional.

    Label for the selection item representing Empty, show when this field is optional. Defaults to the empty string.

  28. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  30. def fieldId: Option[NodeSeq]

    A unique 'id' for the field for form generation

    A unique 'id' for the field for form generation

    Definition Classes
    SettableField
  31. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  32. def find: Box[RefType]

    Find the referenced object

  33. def forceDirty_?: Boolean

    Should the dirty flag always be set when setBox is called

    Should the dirty flag always be set when setBox is called

    Definition Classes
    BaseField
  34. def formElemAttrs: Seq[ElemAttr]

    What form elements are we going to add to this field?

    What form elements are we going to add to this field?

    Definition Classes
    BaseField
  35. def formInputType: String

    Form field's type.

    Form field's type. Defaults to 'text', but you may want to change it to other HTML5 values.

    Definition Classes
    BaseField
  36. final def genericSetFromAny(in: Any)(implicit m: Manifest[MyType]): Box[MyType]

    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

    Attributes
    protected
    Definition Classes
    TypedField
  37. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  38. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  39. def helpAsHtml: Box[NodeSeq]

    Definition Classes
    SettableField
  40. def ignoreField_?: Boolean

    Should the field be ignored by the OR Mapper?

    Should the field be ignored by the OR Mapper?

    Definition Classes
    BaseField
  41. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  42. def label: NodeSeq

    Definition Classes
    BaseField
  43. def name: String

    The text name of this field

    The text name of this field

    Definition Classes
    BaseFieldReadableField
  44. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  45. def noValueErrorMessage: String

    The error message used when the field value could not be set

    The error message used when the field value could not be set

    Definition Classes
    BaseField
  46. implicit def nodeToFieldError(node: Node): List[FieldError]

    Attributes
    protected
    Definition Classes
    TypedField
  47. def notOptionalErrorMessage: String

    The error message used when the field value must be set

    The error message used when the field value must be set

    Definition Classes
    BaseField
  48. final def notify(): Unit

    Definition Classes
    AnyRef
  49. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  50. def obj: Box[RefType]

    Get the cacheable referenced object

  51. def obscure(in: MyType): Box[MyType]

    Definition Classes
    TypedField
  52. def optional_?: Boolean

    Is the value of this field optional (e.

    Is the value of this field optional (e.g. NULLable)?

    Definition Classes
    BaseField
  53. def options: List[(Box[MyType], String)]

    Options for select list *

  54. def performAtomicOperation[T](f: ⇒ T): T

    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

    Definition Classes
    Settable
  55. def primeObj(obj: Box[RefType]): Unit

  56. def required_?: Boolean

    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)

    Definition Classes
    SettableField
  57. def resetDirty: Unit

    Definition Classes
    BaseField
  58. def runFilters(in: Box[MyType], filter: List[(Box[MyType]) ⇒ Box[MyType]]): Box[MyType]

    Definition Classes
    TypedField
  59. def runValidation(in: Box[MyType]): List[FieldError]

    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

    Attributes
    protected
    Definition Classes
    TypedField
  60. def safe_?: Boolean

    Definition Classes
    BaseField
  61. def setBox(in: Box[MyType]): Box[MyType]

    Definition Classes
    MongoRefFieldTypedField
  62. def setFilter: List[(ValueType) ⇒ ValueType]

    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

    Definition Classes
    TypedFieldSettableField
  63. def setFilterBox: List[(Box[MyType]) ⇒ Box[MyType]]

    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

    Attributes
    protected
    Definition Classes
    TypedField
  64. def setFromJString(jvalue: JValue)(decode: (String) ⇒ Box[MyType]): Box[MyType]

    Helper for implementing setFromJValue for a conversion from an encoded JString

    Helper for implementing setFromJValue for a conversion from an encoded JString

    decode

    function to try and transform a String into a field value

    Attributes
    protected
    Definition Classes
    TypedField
  65. def set_!(in: Box[MyType]): Box[MyType]

    Attributes
    protected
    Definition Classes
    TypedField
  66. def shouldDisplay_?: Boolean

    Given the current context, should this field be displayed

    Given the current context, should this field be displayed

    Definition Classes
    ReadableField
  67. def show_?: Boolean

    Given the current state of things, should this field be shown

    Given the current state of things, should this field be shown

    Definition Classes
    SettableField
  68. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  69. def tabIndex: Int

    Definition Classes
    BaseField
  70. def toForm: Box[NodeSeq]

    Generate a form control for the field

    Generate a form control for the field

    Definition Classes
    MongoRefFieldBaseFieldSettableField
  71. def toString(): String

    Definition Classes
    AnyRef → Any
  72. def toXHtml: NodeSeq

    Convert the field value to an XHTML representation

    Convert the field value to an XHTML representation

    Definition Classes
    BaseField
  73. def uniqueFieldId: Box[String]

    Definition Classes
    BaseFieldFieldIdentifier
  74. def uploadField_?: Boolean

    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

    Definition Classes
    SettableField
  75. def validate: List[FieldError]

    Validate this field's setting, returning any errors found

    Validate this field's setting, returning any errors found

    Definition Classes
    TypedFieldSettableField
  76. def validations: List[(ValueType) ⇒ List[FieldError]]

    Definition Classes
    TypedFieldSettableField
  77. def valueBox: Box[MyType]

    Definition Classes
    TypedField
  78. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  79. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  80. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from TypedField[MyType]

Inherited from BaseField

Inherited from BaseField

Inherited from FieldContainer

Inherited from SettableField

Inherited from SettableValueHolder

Inherited from Settable

Inherited from ReadableField

Inherited from Bindable

Inherited from ValueHolder

Inherited from FieldIdentifier

Inherited from AnyRef

Inherited from Any