net.liftweb.mapper

BaseIndexedField

trait BaseIndexedField extends BaseMappedField

linear super types: BaseMappedField, MixableMappedField, BaseField, FieldContainer, SettableField, SettableValueHolder, Settable, ReadableField, ValueHolder, FieldIdentifier, Bindable, SelectableField, AnyRef, Any
known subclasses: IndexedField, MappedLongIndex, MyMappedLongClass, id, id, MappedStringIndex, MappedIntIndex, id
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. BaseIndexedField
  2. BaseMappedField
  3. MixableMappedField
  4. BaseField
  5. FieldContainer
  6. SettableField
  7. SettableValueHolder
  8. Settable
  9. ReadableField
  10. ValueHolder
  11. FieldIdentifier
  12. Bindable
  13. SelectableField
  14. AnyRef
  15. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. type TheOwnerType <: Mapper[TheOwnerType]

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

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

    attributes: abstract
    definition classes: MixableMappedField
  2. type ValueType

    attributes: abstract
    definition classes: ValueHolder

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

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

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def _dbColumnNameLC : String

    The forced lower case column names

    The forced lower case column names

    attributes: final
    definition classes: BaseMappedField
  9. def _toForm : Box[NodeSeq]

    This is where the instance creates its "toForm" stuff.

    This is where the instance creates its "toForm" stuff. The actual toForm method wraps the information based on mode.

    attributes: abstract
    definition classes: BaseMappedField
  10. def allFields : Seq[BaseField]

    definition classes: BaseFieldFieldContainer
  11. def asHtml : NodeSeq

    Default read-only rendering of field

    Default read-only rendering of field

    definition classes: ReadableFieldBindable
  12. def asInstanceOf [T0] : T0

    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.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  13. def asJs : List[(String, JsExp)]

    definition classes: BaseMappedField
  14. def asJsExp : JsExp

    attributes: abstract
    definition classes: BaseMappedField
  15. def asJsonField : Box[JField]

    definition classes: BaseMappedField
  16. def asJsonValue : Box[JValue]

    attributes: abstract
    definition classes: BaseMappedField
  17. def asString : String

    Convert the field to its name/value pair (e.

    Convert the field to its name/value pair (e.g., name=David)

    attributes: abstract
    definition classes: BaseMappedFieldMixableMappedField
  18. 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
  19. def clone () : AnyRef

    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.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  20. 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

    attributes: abstract
    definition classes: BaseMappedField
  21. def dbAddedIndex : Box[() ⇒ Unit]

    Called when a column has indexed via Schemifier

    Called when a column has indexed via Schemifier

    attributes: abstract
    definition classes: BaseMappedField
  22. def dbAutogenerated_? : Boolean

    Is the primary key autogenerated

    Is the primary key autogenerated

    definition classes: BaseMappedField
  23. def dbColumnCount : Int

    The number of database columns that this field represents

    The number of database columns that this field represents

    attributes: abstract
    definition classes: BaseMappedFieldMixableMappedField
  24. def dbColumnName : String

    attributes: abstract
    definition classes: BaseMappedField
  25. def dbColumnNames (in: String) : List[String]

    attributes: abstract
    definition classes: BaseMappedField
  26. def dbDisplay_? : Boolean

    definition classes: BaseMappedField
  27. def dbForeignKey_? : Boolean

    Is the field a foreign key reference

    Is the field a foreign key reference

    attributes: abstract
    definition classes: BaseMappedFieldMixableMappedField
  28. def dbIgnoreSQLType_? : Boolean

    Do we ignore the targetSQLType for setObject

    Do we ignore the targetSQLType for setObject

    definition classes: BaseMappedField
  29. def dbIncludeInForm_? : Boolean

    definition classes: BaseMappedField
  30. def dbIndexed_? : Boolean

    Should the field be indexed?

    Should the field be indexed?

    attributes: abstract
    definition classes: BaseMappedFieldMixableMappedField
  31. 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: BaseMappedFieldMixableMappedField
  32. def dbPrimaryKey_? : Boolean

    Is the field the table's primary key

    Is the field the table's primary key

    attributes: abstract
    definition classes: BaseMappedFieldMixableMappedField
  33. def dbSelectString : String

    attributes: abstract
    definition classes: SelectableField
  34. def displayHtml : NodeSeq

    definition classes: ReadableField
  35. def displayName : String

    The display name of this field (e.

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

    definition classes: ReadableField
  36. def displayNameHtml : Box[NodeSeq]

    definition classes: ReadableField
  37. def doneWithSave () : Unit

    Called after the field is saved to the database

    Called after the field is saved to the database

    attributes: protected[mapper] abstract
    definition classes: BaseMappedField
  38. def eq (arg0: AnyRef) : Boolean

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

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  39. def equals (arg0: Any) : Boolean

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

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  40. def fieldCreatorString (dbType: DriverType) : List[String]

    Given the driver type, return a list of statements to create the columns in the database

    Given the driver type, return a list of statements to create the columns in the database

    attributes: abstract
    definition classes: BaseMappedField
  41. 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

    attributes: abstract
    definition classes: BaseMappedField
  42. 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
  43. def finalize () : Unit

    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 finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  44. def get : ValueType

    get the value

    get the value

    attributes: abstract
    definition classes: ValueHolder
  45. def getClass () : java.lang.Class[_]

    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.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  46. def hashCode () : Int

    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.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  47. def helpAsHtml : Box[NodeSeq]

    definition classes: SettableField
  48. def is : ValueType

    Get the value.

    Get the value. Use get.

    @deprecated

    attributes: abstract
    definition classes: ValueHolder
      deprecated:
    1. Use get

  49. def isInstanceOf [T0] : Boolean

    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.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  50. 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

    attributes: abstract
    definition classes: BaseMappedField
  51. 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

    attributes: abstract
    definition classes: BaseMappedField
  52. def name : String

    The human name of this field

    The human name of this field

    attributes: abstract
    definition classes: ReadableField
  53. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  54. def notify () : Unit

    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.

    attributes: final
    definition classes: AnyRef
  55. def notifyAll () : Unit

    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.

    attributes: final
    definition classes: AnyRef
  56. 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
  57. def renderJs_? : Boolean

    definition classes: BaseMappedField
  58. 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
  59. def set (in: ValueType) : ValueType

    attributes: abstract
    definition classes: Settable
  60. 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

    attributes: abstract
    definition classes: SettableField
  61. def shouldDisplay_? : Boolean

    Given the current context, should this field be displayed

    Given the current context, should this field be displayed

    definition classes: ReadableField
  62. def show_? : Boolean

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

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

    definition classes: SettableField
  63. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  64. def targetSQLType : Int

    Get the JDBC SQL Type for this field

    Get the JDBC SQL Type for this field

    attributes: abstract
    definition classes: BaseMappedField
  65. def targetSQLType (field: String) : Int

    Get the JDBC SQL Type for this field

    Get the JDBC SQL Type for this field

    attributes: abstract
    definition classes: BaseMappedField
  66. def toForm : Box[NodeSeq]

    Create an input field for the item

    Create an input field for the item

    attributes: abstract
    definition classes: SettableField
  67. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  68. def uniqueFieldId : Box[String]

    definition classes: FieldIdentifier
  69. 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
  70. def validate : List[FieldError]

    Validate this field and return a list of Validation Issues

    Validate this field and return a list of Validation Issues

    attributes: abstract
    definition classes: SettableField
  71. def validations : List[(ValueType) ⇒ List[FieldError]]

    attributes: abstract
    definition classes: SettableField
  72. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  73. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  74. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from BaseMappedField

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 AnyRef

Inherited from Any