Class

net.liftweb.mongodb.record.field

StringRefField

Related Doc: package field

Permalink

class StringRefField[OwnerType <: BsonRecord[OwnerType], RefType <: MongoRecord[RefType]] extends StringField[OwnerType] with MongoRefField[RefType, String]

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. StringRefField
  2. MongoRefField
  3. StringField
  4. StringTypedField
  5. StringValidators
  6. MandatoryTypedField
  7. Product1
  8. Product
  9. Equals
  10. Field
  11. TypedField
  12. OwnedField
  13. BaseField
  14. BaseField
  15. FieldContainer
  16. SettableField
  17. SettableValueHolder
  18. Settable
  19. ReadableField
  20. Bindable
  21. ValueHolder
  22. FieldIdentifier
  23. AnyRef
  24. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StringRefField(rec: OwnerType, refMeta: MongoMetaRecord[RefType], maxLen: Int)

    Permalink

Type Members

  1. type MyType = String

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

    Permalink
    Definition Classes
    TypedField
  3. type ValueType = String

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def _1: MyType

    Permalink
    Definition Classes
    MandatoryTypedField → Product1
  5. def allFields: Seq[BaseField]

    Permalink
    Definition Classes
    BaseFieldFieldContainer
  6. def apply(in: Box[MyType]): OwnerType

    Permalink
    Definition Classes
    Field
  7. def apply(in: MyType): OwnerType

    Permalink
    Definition Classes
    Field
  8. def asHtml: NodeSeq

    Permalink

    Default read-only rendering of field

    Default read-only rendering of field

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

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

    Permalink

    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
  11. def asJValue: JValue

    Permalink

    Encode the field value into a JValue

    Encode the field value into a JValue

    Definition Classes
    StringTypedFieldBaseField
  12. def asJs: JsExp with Product with Serializable

    Permalink

    Returns the field's value as a valid JavaScript expression

    Returns the field's value as a valid JavaScript expression

    Definition Classes
    StringTypedFieldBaseField
  13. def asString: String

    Permalink

    Convert the field to a String...

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

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

    Permalink

    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
  15. implicit def boxNodeFuncToFieldError(in: (Box[MyType]) ⇒ Box[Node]): (Box[MyType]) ⇒ List[FieldError]

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

    Permalink
    Attributes
    protected
    Definition Classes
    TypedField
  17. def boxStrToValType(in: Box[String]): ValueType

    Permalink
    Attributes
    protected
    Definition Classes
    StringFieldStringValidators
  18. def buildDisplayList: List[(Box[MyType], String)]

    Permalink
    Definition Classes
    MongoRefField
  19. def cached_?: Boolean

    Permalink
    Definition Classes
    MongoRefField
  20. def canEqual(a: Any): Boolean

    Permalink
    Definition Classes
    MandatoryTypedField → Equals
  21. def canRead_?: Boolean

    Permalink

    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
  22. def canWrite_?: Boolean

    Permalink

    Can the value of this field be written?

    Can the value of this field be written?

    Definition Classes
    BaseField
  23. def checkCanRead_?: Boolean

    Permalink

    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
  24. def checkCanWrite_?: Boolean

    Permalink

    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
  25. def clear: Unit

    Permalink

    Clear the value of this field

    Clear the value of this field

    Definition Classes
    TypedField
  26. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def crop(in: ValueType): ValueType

    Permalink
    Definition Classes
    StringValidators
  28. def defaultValue: String

    Permalink
    Definition Classes
    StringTypedField
  29. def defaultValueBox: Box[MyType]

    Permalink

    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
  30. def dirty_?: Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    BaseField
  32. def displayHtml: NodeSeq

    Permalink
    Definition Classes
    ReadableField
  33. def displayName: String

    Permalink

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

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

    Definition Classes
    OwnedFieldReadableField
  34. def displayNameHtml: Box[NodeSeq]

    Permalink
    Definition Classes
    ReadableField
  35. def emptyOptionLabel: String

    Permalink

    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.

    Definition Classes
    MongoRefField
  36. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink

    A unique 'id' for the field for form generation

    A unique 'id' for the field for form generation

    Definition Classes
    SettableField
  39. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  40. def find: Box[RefType]

    Permalink

    Find the referenced object

    Find the referenced object

    Definition Classes
    MongoRefField
  41. def forceDirty_?: Boolean

    Permalink

    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
  42. def formElemAttrs: Seq[http.SHtml.ElemAttr]

    Permalink

    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
  43. def formInputType: String

    Permalink

    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
  44. final def genericSetFromAny(in: Any)(implicit m: Manifest[MyType]): Box[MyType]

    Permalink

    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
  45. def get: MyType

    Permalink

    get the value

    get the value

    Definition Classes
    MandatoryTypedFieldValueHolder
  46. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    SettableField
  49. def ignoreField_?: Boolean

    Permalink

    Should the field be ignored by the OR Mapper?

    Should the field be ignored by the OR Mapper?

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

    Permalink
    Definition Classes
    Any
  51. def label: NodeSeq

    Permalink
    Definition Classes
    BaseField
  52. def liftSetFilterToBox(in: Box[MyType]): Box[MyType]

    Permalink

    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
  53. def maxLen: Int

    Permalink
    Definition Classes
    StringTypedFieldStringValidators
  54. val maxLength: Int

    Permalink
    Definition Classes
    StringFieldStringTypedField
  55. def name: String

    Permalink

    The text name of this field

    The text name of this field

    Definition Classes
    OwnedFieldReadableField
  56. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  57. def noValueErrorMessage: String

    Permalink

    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
  58. implicit def nodeToFieldError(node: Node): List[FieldError]

    Permalink
    Attributes
    protected
    Definition Classes
    TypedField
  59. def notNull(in: ValueType): ValueType

    Permalink
    Definition Classes
    StringValidators
  60. def notOptionalErrorMessage: String

    Permalink

    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
  61. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  62. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  63. def obj: Box[RefType]

    Permalink

    Get the cacheable referenced object

    Get the cacheable referenced object

    Definition Classes
    MongoRefField
  64. def obscure(in: MyType): Box[MyType]

    Permalink
    Definition Classes
    TypedField
  65. def optional_?: Boolean

    Permalink

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

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

    Definition Classes
    MandatoryTypedFieldBaseField
  66. def options: List[(Box[MyType], String)]

    Permalink

    Options for select list *

    Options for select list *

    Definition Classes
    MongoRefField
  67. def owner: OwnerType

    Permalink

    Return the owner of this field

    Return the owner of this field

    Definition Classes
    StringFieldOwnedField
  68. def performAtomicOperation[T](f: ⇒ T): T

    Permalink

    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
  69. def primeObj(obj: Box[RefType]): Unit

    Permalink
    Definition Classes
    MongoRefField
  70. def productArity: Int

    Permalink
    Definition Classes
    Product1 → Product
  71. def productElement(n: Int): Any

    Permalink
    Definition Classes
    Product1 → Product
    Annotations
    @throws( ... )
  72. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  73. def productPrefix: String

    Permalink
    Definition Classes
    Product
  74. val refMeta: MongoMetaRecord[RefType]

    Permalink

    The MongoMetaRecord of the referenced object *

    The MongoMetaRecord of the referenced object *

    Definition Classes
    StringRefFieldMongoRefField
  75. def removeRegExChars(regEx: String)(in: ValueType): ValueType

    Permalink
    Definition Classes
    StringValidators
  76. def required_?: Boolean

    Permalink

    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
  77. def resetDirty: Unit

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

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

    Permalink

    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
  80. final def safe_?: Boolean

    Permalink

    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
  81. def set(in: MyType): MyType

    Permalink

    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
  82. def setBox(in: Box[MyType]): Box[MyType]

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

    Permalink

    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
  84. def setFilterBox: List[(Box[MyType]) ⇒ Box[MyType]]

    Permalink

    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
  85. def setFromAny(in: Any): Box[String]

    Permalink

    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
    StringTypedFieldTypedField
  86. def setFromJString(jvalue: JValue)(decode: (String) ⇒ Box[MyType]): Box[MyType]

    Permalink

    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
  87. def setFromJValue(jvalue: JValue): Box[MyType]

    Permalink

    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
    StringTypedFieldTypedField
  88. def setFromString(s: String): Box[String]

    Permalink

    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
    StringTypedFieldTypedField
  89. def set_!(in: Box[MyType]): Box[MyType]

    Permalink
    Attributes
    protected
    Definition Classes
    TypedField
  90. def shouldDisplay_?: Boolean

    Permalink

    Given the current context, should this field be displayed

    Given the current context, should this field be displayed

    Definition Classes
    ReadableField
  91. def show_?: Boolean

    Permalink

    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
  92. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  93. def tabIndex: Int

    Permalink
    Definition Classes
    BaseField
  94. def toBoxMyType(in: ValueType): Full[ValueType]

    Permalink
    Definition Classes
    MandatoryTypedFieldTypedField
  95. def toForm: Box[NodeSeq]

    Permalink

    Generate a form control for the field

    Generate a form control for the field

    Definition Classes
    MongoRefFieldBaseFieldSettableField
  96. def toLower(in: ValueType): ValueType

    Permalink
    Definition Classes
    StringValidators
  97. def toString(): String

    Permalink
    Definition Classes
    MandatoryTypedField → AnyRef → Any
  98. def toUpper(in: ValueType): ValueType

    Permalink
    Definition Classes
    StringValidators
  99. def toValueType(in: Box[MyType]): MyType

    Permalink
    Definition Classes
    MandatoryTypedFieldTypedField
  100. def toXHtml: NodeSeq

    Permalink

    Convert the field value to an XHTML representation

    Convert the field value to an XHTML representation

    Definition Classes
    BaseField
  101. def trim(in: ValueType): ValueType

    Permalink
    Definition Classes
    StringValidators
  102. def uniqueFieldId: Box[String]

    Permalink
    Definition Classes
    BaseFieldFieldIdentifier
  103. def uploadField_?: Boolean

    Permalink

    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
  104. def valMaxLen(len: Int, msg: ⇒ String)(value: ValueType): List[FieldError]

    Permalink

    A validation helper.

    A validation helper. Make sure the string is no more than a particular length and generate a validation issue if not.

    Definition Classes
    StringValidators
  105. def valMinLen(len: Int, msg: ⇒ String)(value: ValueType): List[FieldError]

    Permalink

    A validation helper.

    A validation helper. Make sure the string is at least a particular length and generate a validation issue if not.

    Definition Classes
    StringValidators
  106. def valRegex(pat: Pattern, msg: ⇒ String)(value: ValueType): List[FieldError]

    Permalink

    Make sure the field matches a regular expression

    Make sure the field matches a regular expression

    Definition Classes
    StringValidators
  107. def validate: List[FieldError]

    Permalink

    Validate this field's setting, returning any errors found

    Validate this field's setting, returning any errors found

    Definition Classes
    TypedFieldSettableField
  108. def validations: List[ValidationFunction]

    Permalink
    Definition Classes
    TypedFieldSettableField
  109. def value: MyType

    Permalink
    Definition Classes
    MandatoryTypedField
  110. def valueBox: Box[MyType]

    Permalink
    Definition Classes
    TypedField
  111. def valueTypeToBoxString(in: ValueType): Box[String]

    Permalink
    Attributes
    protected
    Definition Classes
    StringFieldStringValidators
  112. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MongoRefField[RefType, String]

Inherited from StringField[OwnerType]

Inherited from StringTypedField

Inherited from StringValidators

Inherited from MandatoryTypedField[String]

Inherited from Product1[String]

Inherited from Product

Inherited from Equals

Inherited from Field[String, OwnerType]

Inherited from TypedField[String]

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