net.liftweb.mapper

MappedField

trait MappedField[FieldType, OwnerType <: Mapper[OwnerType]] extends TypedField[FieldType] with BaseOwnedMappedField[OwnerType] with FieldIdentifier with PSettableValueHolder[FieldType] with Equals

The strongly typed field that's mapped to a column (or many columns) in the database. FieldType is the type of the field and OwnerType is the Owner of the field

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MappedField
  2. Equals
  3. PSettableValueHolder
  4. PValueHolder
  5. BaseOwnedMappedField
  6. BaseMappedField
  7. Serializable
  8. Serializable
  9. MixableMappedField
  10. BaseField
  11. FieldContainer
  12. SettableField
  13. SettableValueHolder
  14. Settable
  15. ReadableField
  16. ValueHolder
  17. FieldIdentifier
  18. Bindable
  19. SelectableField
  20. TypedField
  21. AnyRef
  22. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type TheOwnerType = OwnerType

    Will be set to the type of the owner of the field

    Will be set to the type of the owner of the field

    Definition Classes
    MappedFieldMixableMappedField
  2. type ValueType = FieldType

    Will be set to the type of the field

    Will be set to the type of the field

    Definition Classes
    MappedFieldPValueHolderValueHolder

Abstract Value Members

  1. abstract def asJsExp: JsExp

    Definition Classes
    BaseMappedField
  2. abstract def asJsonValue: Box[JValue]

    Definition Classes
    BaseMappedField
  3. abstract def buildSetActualValue(accessor: Method, inst: AnyRef, columnName: String): (OwnerType, AnyRef) ⇒ Unit

  4. abstract def buildSetBooleanValue(accessor: Method, columnName: String): (OwnerType, Boolean, Boolean) ⇒ Unit

  5. abstract def buildSetDateValue(accessor: Method, columnName: String): (OwnerType, Date) ⇒ Unit

  6. abstract def buildSetLongValue(accessor: Method, columnName: String): (OwnerType, Long, Boolean) ⇒ Unit

  7. abstract def buildSetStringValue(accessor: Method, columnName: String): (OwnerType, String) ⇒ Unit

  8. abstract def dbFieldClass: Class[FieldType]

    What is the real class that corresponds to FieldType

    What is the real class that corresponds to FieldType

    Definition Classes
    TypedField
  9. abstract def defaultValue: FieldType

    The default value for the field

    The default value for the field

    Definition Classes
    TypedField
  10. abstract def doneWithSave(): Unit

    Called after the field is saved to the database

    Called after the field is saved to the database

    Attributes
    protected[net.liftweb.mapper]
    Definition Classes
    BaseMappedField
  11. abstract def fieldCreatorString(dbType: DriverType, colName: String): String

    Given the driver type, return the string required to create the column in the database

    Given the driver type, return the string required to create the column in the database

    Definition Classes
    MappedFieldBaseMappedField
  12. abstract def fieldOwner: OwnerType

    Return the owner of this field

  13. abstract def i_is_!: FieldType

    The actual value of the field

    The actual value of the field

    Attributes
    protected
  14. abstract def i_obscure_!(in: FieldType): FieldType

    Obscure the incoming value to a "safe" value (e.

    Obscure the incoming value to a "safe" value (e.g., if there are not enough rights to view the entire social security number 123-45-5678, this method might return ***-**-*678

    Attributes
    protected
  15. abstract def i_was_!: FieldType

    The value of the field when it was pulled from the DB

    The value of the field when it was pulled from the DB

    Attributes
    protected
  16. abstract def jdbcFriendly(field: String): AnyRef

    Get a JDBC friendly representation of the named field (this is used for MappedFields that correspond to more than 1 column in the database.

    Get a JDBC friendly representation of the named field (this is used for MappedFields that correspond to more than 1 column in the database.)

    field

    -- the name of the field being mapped to

    Definition Classes
    MappedFieldBaseMappedField
  17. abstract def real_convertToJDBCFriendly(value: FieldType): AnyRef

    Attributes
    protected
  18. abstract def real_i_set_!(value: FieldType): FieldType

    Must be implemented to store the value of the field

    Must be implemented to store the value of the field

    Attributes
    protected
  19. abstract def setFromAny(value: Any): FieldType

    Attempt to figure out what the incoming value is and set the field to that value.

    Attempt to figure out what the incoming value is and set the field to that value. Return true if the value could be assigned

  20. abstract def targetSQLType: Int

    Get the JDBC SQL Type for this field

    Get the JDBC SQL Type for this field

    Definition Classes
    MappedFieldBaseMappedField

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. def :=(v: FieldType): FieldType

  5. def :=[Q](v: Q)(implicit arg0: (Q) ⇒ FieldType): FieldType

  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. final def _dbColumnNameLC: String

    The forced lower case column names

    The forced lower case column names

    Definition Classes
    BaseMappedField
  9. def _toForm: Box[NodeSeq]

    Create an input field for the item

    Create an input field for the item

    Definition Classes
    MappedFieldBaseMappedField
  10. def actualField(actual: OwnerType): MappedField[FieldType, OwnerType]

    Get the field that this prototypical field represents

    Get the field that this prototypical field represents

    actual

    the object to find the field on

  11. def allFields: Seq[BaseField]

    Definition Classes
    BaseFieldFieldContainer
  12. def appendFieldId(in: Elem): Elem

    If the field has a defined fieldId, append it

    If the field has a defined fieldId, append it

    Attributes
    protected
  13. def apply(v: FieldType): OwnerType

  14. def apply[Q](v: Q)(implicit arg0: (Q) ⇒ FieldType): OwnerType

  15. def asHtml: Node

    Default read-only rendering of field

    Default read-only rendering of field

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedFieldReadableFieldBindable
  16. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  17. def asJs: List[(String, JsExp)]

    Definition Classes
    BaseMappedField
  18. def asJsonField: Box[JField]

    Definition Classes
    BaseMappedField
  19. def asString: String

    Return the field name and field value, delimited by an '='

    Return the field name and field value, delimited by an '='

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  20. 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
  21. def calcFieldName: String

  22. def canEqual(that: Any): Boolean

    Definition Classes
    MappedField → Equals
  23. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def convertToJDBCFriendly(value: FieldType): AnyRef

  25. def dbAddedColumn: Box[() ⇒ Unit]

    Called when a column has been added to the database via Schemifier

    Called when a column has been added to the database via Schemifier

    Definition Classes
    MappedFieldBaseMappedField
  26. def dbAddedIndex: Box[() ⇒ Unit]

    Called when a column has indexed via Schemifier

    Called when a column has indexed via Schemifier

    Definition Classes
    MappedFieldBaseMappedField
  27. def dbAutogenerated_?: Boolean

    Is the primary key autogenerated

    Is the primary key autogenerated

    Definition Classes
    BaseMappedField
  28. def dbColumnCount: Int

    The number of database columns that this field represents

    The number of database columns that this field represents

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  29. def dbColumnName: String

    Definition Classes
    MappedFieldBaseMappedField
  30. def dbColumnNames(in: String): List[String]

    Definition Classes
    MappedFieldBaseMappedField
  31. def dbDisplay_?: Boolean

    Definition Classes
    BaseMappedField
  32. def dbForeignKey_?: Boolean

    Is the field a foreign key reference

    Is the field a foreign key reference

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  33. def dbIgnoreSQLType_?: Boolean

    Do we ignore the targetSQLType for setObject

    Do we ignore the targetSQLType for setObject

    Definition Classes
    BaseMappedField
  34. def dbIncludeInForm_?: Boolean

    Definition Classes
    BaseMappedField
  35. def dbIndexFieldIndicatesSaved_?: Boolean

    override this method in indexed fields to indicate that the field has been saved

  36. def dbIndexed_?: Boolean

    Should the field be indexed?

    Should the field be indexed?

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  37. def dbNotNull_?: Boolean

    Set to true if the field should be created as NOT NULL

    Set to true if the field should be created as NOT NULL

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  38. def dbPrimaryKey_?: Boolean

    Is the field the table's primary key

    Is the field the table's primary key

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  39. def dbSelectString: String

    Definition Classes
    MappedFieldSelectableField
  40. def dirty_?(b: Boolean): Unit

    Make the field dirty

    Make the field dirty

    Attributes
    protected
  41. def dirty_?: Boolean

    Is the field dirty (has it been changed since the record was loaded from the database

  42. def displayHtml: NodeSeq

    Definition Classes
    ReadableField
  43. def displayName: String

    The display name of this field (e.

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

    Definition Classes
    MappedFieldReadableField
  44. def displayNameHtml: Box[NodeSeq]

    Definition Classes
    ReadableField
  45. def doField(inst: OwnerType, meth: Method, func: PartialFunction[MappedField[FieldType, OwnerType], Unit]): Unit

    Attributes
    protected
  46. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  47. def equals(other: Any): Boolean

    Does the "right thing" comparing mapped fields

    Does the "right thing" comparing mapped fields

    Definition Classes
    MappedField → Equals → AnyRef → Any
  48. def fieldCreatorString(dbType: DriverType): List[String]

    Given the driver type, return a list of SQL creation strings for the columns represented by this field

    Given the driver type, return a list of SQL creation strings for the columns represented by this field

    Definition Classes
    MappedFieldBaseMappedField
  49. 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
  50. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  51. 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
    BaseMappedField
  52. def formInputType: String

    When building the form field, what's the input element's type attribute.

    When building the form field, what's the input element's type attribute. Defaults to 'text', but change to 'email' or other HTML5 values.

    Attributes
    protected
  53. def get: FieldType

    Convert the field to its "context free" type (e.

    Convert the field to its "context free" type (e.g., String, Int, Long, etc.) If there are no read permissions, the value will be obscured

    Definition Classes
    MappedFieldValueHolder
  54. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  55. def getField(inst: OwnerType, meth: Method): MappedField[FieldType, OwnerType]

    Attributes
    protected
  56. def hashCode(): Int

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

    Definition Classes
    SettableField
  58. final def i_set_!(value: FieldType): FieldType

    Attributes
    protected
  59. def ignoreField_?: Boolean

    Should the field be ignored by the OR Mapper?

  60. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  61. def jdbcFriendly: AnyRef

    Get a JDBC friendly object for the part of this field that maps to the first column in the database

    Get a JDBC friendly object for the part of this field that maps to the first column in the database

    Definition Classes
    MappedFieldBaseMappedField
  62. final def name: String

    The name of this field

    The name of this field

    Definition Classes
    MappedFieldReadableField
  63. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  64. def notNullAppender(): String

  65. final def notify(): Unit

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

    Definition Classes
    AnyRef
  67. 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
  68. def readPermission_?: Boolean

    Given the current execution state, can the field be read?

  69. def renderJs_?: Boolean

    Definition Classes
    BaseMappedField
  70. 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
  71. def resetDirty: Unit

  72. def runFilters(in: FieldType, filter: List[(FieldType) ⇒ FieldType]): FieldType

  73. final def safe_?: Boolean

    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.)

  74. def set(value: FieldType): FieldType

    Set the field to the value

    Set the field to the value

    Definition Classes
    MappedFieldSettable
  75. def setFilter: List[(FieldType) ⇒ FieldType]

    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
    MappedFieldSettableField
  76. def set_?(value: Box[FieldType]): Box[FieldType]

    Set the field to the Box value if the Box is Full

  77. def shouldDisplay_?: Boolean

    Given the current context, should this field be displayed

    Given the current context, should this field be displayed

    Definition Classes
    ReadableField
  78. 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
  79. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  80. def targetSQLType(field: String): Int

    Get the JDBC SQL Type for this field

    Get the JDBC SQL Type for this field

    Definition Classes
    MappedFieldBaseMappedField
  81. def toForm: Box[NodeSeq]

    Create an input field for the item

    Create an input field for the item

    Definition Classes
    MappedFieldSettableField
  82. def toFormAppendedAttributes: MetaData

  83. def toString(): String

    Definition Classes
    MappedField → AnyRef → Any
  84. def uniqueFieldId: Box[String]

    The unique field id is the field name and the mapper name

    The unique field id is the field name and the mapper name

    Definition Classes
    MappedFieldFieldIdentifier
  85. def update[Q](v: Q)(implicit arg0: (Q) ⇒ FieldType): Unit

    Assignment from the underlying type.

    Assignment from the underlying type. It's ugly, but:
    field() = new_value
    field set new_value
    field.set(new_value)
    are all the same

  86. 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
  87. def validate: List[FieldError]

    Validate this field and return a list of Validation Issues

    Validate this field and return a list of Validation Issues

    Definition Classes
    MappedFieldSettableField
  88. def validations: List[(FieldType) ⇒ List[FieldError]]

    Definition Classes
    MappedFieldSettableField
  89. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  92. def was: FieldType

    What value was the field's value when it was pulled from the DB?

  93. def writePermission_?: Boolean

    Given the current execution state, can the field be written?

Deprecated Value Members

  1. def is: FieldType

    Get the value.

    Get the value. Use get.

    Definition Classes
    MappedFieldValueHolder
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6) Use get instead

Inherited from Equals

Inherited from PSettableValueHolder[FieldType]

Inherited from PValueHolder[FieldType]

Inherited from BaseOwnedMappedField[OwnerType]

Inherited from BaseMappedField

Inherited from Serializable

Inherited from Serializable

Inherited from MixableMappedField

Inherited from BaseField

Inherited from FieldContainer

Inherited from SettableField

Inherited from SettableValueHolder

Inherited from Settable

Inherited from ReadableField

Inherited from ValueHolder

Inherited from FieldIdentifier

Inherited from Bindable

Inherited from SelectableField

Inherited from TypedField[FieldType]

Inherited from AnyRef

Inherited from Any

Ungrouped