class MongoMapField[OwnerType <: BsonRecord[OwnerType], MapValueType] extends Field[Map[String, MapValueType], OwnerType] with MandatoryTypedField[Map[String, MapValueType]] with MongoFieldFlavor[Map[String, MapValueType]]

Note: setting optional_? = false will result in incorrect equals behavior when using setFromJValue

Linear Supertypes
MongoFieldFlavor[Map[String, MapValueType]], MandatoryTypedField[Map[String, MapValueType]], Product1[Map[String, MapValueType]], Product, Equals, Field[Map[String, MapValueType], OwnerType], TypedField[Map[String, MapValueType]], OwnedField[OwnerType], BaseField, BaseField, FieldContainer, SettableField, SettableValueHolder, Settable, ReadableField, Bindable, ValueHolder, FieldIdentifier, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MongoMapField
  2. MongoFieldFlavor
  3. MandatoryTypedField
  4. Product1
  5. Product
  6. Equals
  7. Field
  8. TypedField
  9. OwnedField
  10. BaseField
  11. BaseField
  12. FieldContainer
  13. SettableField
  14. SettableValueHolder
  15. Settable
  16. ReadableField
  17. Bindable
  18. ValueHolder
  19. FieldIdentifier
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MongoMapField(rec: OwnerType)

Type Members

  1. type MyType = Map[String, MapValueType]
    Definition Classes
    TypedField
  2. type ValidationFunction = (ValueType) ⇒ List[FieldError]
    Definition Classes
    TypedField
  3. type ValueType = Map[String, MapValueType]

    ValueType represents the type that users will work with.

    ValueType represents the type that users will work with. For MandatoryTypeField, this is equal to ThisType.

    Definition Classes
    MandatoryTypedFieldValueHolder

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. def _1: MyType
    Definition Classes
    MandatoryTypedField → Product1
  5. def allFields: Seq[BaseField]
    Definition Classes
    BaseFieldFieldContainer
  6. def apply(in: Box[MyType]): OwnerType
    Definition Classes
    Field
  7. def apply(in: MyType): OwnerType
    Definition Classes
    Field
  8. def asDBObject: DBObject
    Definition Classes
    MongoMapFieldMongoFieldFlavor
  9. def asDocument: Document
  10. def asHtml: NodeSeq

    Default read-only rendering of field

    Default read-only rendering of field

    Definition Classes
    ReadableFieldBindable
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. 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
  13. def asJValue: JValue

    Encode the field value into a JValue

    Encode the field value into a JValue

    Definition Classes
    MongoMapFieldMongoFieldFlavorBaseField
  14. def asJs: JsExp with Product with Serializable

    Returns the field's value as a valid JavaScript expression

    Returns the field's value as a valid JavaScript expression

    Definition Classes
    MongoFieldFlavor
  15. def asString: String

    Convert the field to a String...

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

    Definition Classes
    TypedFieldBaseField
  16. 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
  17. implicit def boxNodeFuncToFieldError(in: (Box[MyType]) ⇒ Box[Node]): (Box[MyType]) ⇒ List[FieldError]
    Attributes
    protected
    Definition Classes
    TypedField
  18. implicit def boxNodeToFieldError(in: Box[Node]): List[FieldError]
    Attributes
    protected
    Definition Classes
    TypedField
  19. def canEqual(a: Any): Boolean
    Definition Classes
    MandatoryTypedField → Equals
  20. 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
  21. def canWrite_?: Boolean

    Can the value of this field be written?

    Can the value of this field be written?

    Definition Classes
    BaseField
  22. 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
  23. 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
  24. def clear: Unit

    Clear the value of this field

    Clear the value of this field

    Definition Classes
    TypedField
  25. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def defaultValue: Map[String, MapValueType]

    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.

    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

    Definition Classes
    MongoMapFieldMandatoryTypedField
  27. 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
    MandatoryTypedFieldTypedField
  28. def dirty_?: Boolean
    Definition Classes
    BaseField
  29. def dirty_?(b: Boolean): Unit
    Attributes
    protected
    Definition Classes
    BaseField
  30. def displayHtml: NodeSeq
    Definition Classes
    ReadableField
  31. def displayName: String

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

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

    Definition Classes
    OwnedFieldReadableField
  32. def displayNameHtml: Box[NodeSeq]
    Definition Classes
    ReadableField
  33. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  35. 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
  36. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. 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
  38. def formElemAttrs: Seq[http.SHtml.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
  39. 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
  40. 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
  41. def get: MyType

    get the value

    get the value

    Definition Classes
    MandatoryTypedFieldValueHolder
  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  43. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  44. def helpAsHtml: Box[NodeSeq]
    Definition Classes
    SettableField
  45. def ignoreField_?: Boolean

    Should the field be ignored by the OR Mapper?

    Should the field be ignored by the OR Mapper?

    Definition Classes
    BaseField
  46. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  47. def label: NodeSeq
    Definition Classes
    BaseField
  48. 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
    MandatoryTypedFieldTypedField
  49. def name: String

    The text name of this field

    The text name of this field

    Definition Classes
    OwnedFieldReadableField
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. 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
  52. implicit def nodeToFieldError(node: Node): List[FieldError]
    Attributes
    protected
    Definition Classes
    TypedField
  53. 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
  54. final def notify(): Unit
    Definition Classes
    AnyRef
  55. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  56. def obscure(in: MyType): Box[MyType]
    Definition Classes
    TypedField
  57. def optional_?: Boolean

    Is the value of this field optional (e.g.

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

    Definition Classes
    MandatoryTypedFieldBaseField
  58. def owner: OwnerType

    Return the owner of this field

    Return the owner of this field

    Definition Classes
    MongoMapFieldOwnedField
  59. 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
  60. def productArity: Int
    Definition Classes
    Product1 → Product
  61. def productElement(n: Int): Any
    Definition Classes
    Product1 → Product
    Annotations
    @throws( ... )
  62. def productIterator: Iterator[Any]
    Definition Classes
    Product
  63. def productPrefix: String
    Definition Classes
    Product
  64. 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
  65. def resetDirty: Unit
    Definition Classes
    BaseField
  66. def runFilters(in: Box[MyType], filter: List[(Box[MyType]) ⇒ Box[MyType]]): Box[MyType]
    Definition Classes
    TypedField
  67. 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
  68. final def safe_?: Boolean

    Are we in "safe" mode (i.e., the value of the field can be read or written without any security checks.)

    Are we in "safe" mode (i.e., the value of the field can be read or written without any security checks.)

    Definition Classes
    OwnedFieldBaseField
  69. def set(in: MyType): MyType

    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.

    Definition Classes
    MandatoryTypedFieldSettable
  70. def setBox(in: Box[MyType]): Box[MyType]
    Definition Classes
    TypedField
  71. 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
  72. 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
  73. def setFromAny(in: Any): Box[Map[String, MapValueType]]

    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
    MongoMapFieldTypedField
  74. def setFromDBObject(dbo: DBObject): Box[Map[String, MapValueType]]
    Definition Classes
    MongoMapFieldMongoFieldFlavor
  75. def setFromDocument(doc: Document): Box[Map[String, MapValueType]]
  76. 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
  77. 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
    MongoMapFieldTypedField
  78. def setFromString(in: String): Box[Map[String, MapValueType]]

    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
    MongoMapFieldTypedField
  79. def set_!(in: Box[MyType]): Box[MyType]
    Attributes
    protected
    Definition Classes
    TypedField
  80. def shouldDisplay_?: Boolean

    Given the current context, should this field be displayed

    Given the current context, should this field be displayed

    Definition Classes
    ReadableField
  81. 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
  82. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  83. def tabIndex: Int
    Definition Classes
    BaseField
  84. def toBoxMyType(in: ValueType): Full[ValueType]
    Definition Classes
    MandatoryTypedFieldTypedField
  85. def toForm: Box[NodeSeq]

    Generate a form control for the field

    Generate a form control for the field

    Definition Classes
    MongoMapFieldBaseFieldSettableField
  86. def toString(): String
    Definition Classes
    MandatoryTypedField → AnyRef → Any
  87. def toValueType(in: Box[MyType]): MyType
    Definition Classes
    MandatoryTypedFieldTypedField
  88. def toXHtml: NodeSeq

    Convert the field value to an XHTML representation

    Convert the field value to an XHTML representation

    Definition Classes
    BaseField
  89. def uniqueFieldId: Box[String]
    Definition Classes
    BaseFieldFieldIdentifier
  90. 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
  91. 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
  92. def validations: List[ValidationFunction]
    Definition Classes
    TypedFieldSettableField
  93. def value: MyType
    Definition Classes
    MandatoryTypedField
  94. def valueBox: Box[MyType]
    Definition Classes
    TypedField
  95. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  96. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  97. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MongoFieldFlavor[Map[String, MapValueType]]

Inherited from MandatoryTypedField[Map[String, MapValueType]]

Inherited from Product1[Map[String, MapValueType]]

Inherited from Product

Inherited from Equals

Inherited from Field[Map[String, MapValueType], OwnerType]

Inherited from TypedField[Map[String, MapValueType]]

Inherited from OwnedField[OwnerType]

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

Ungrouped