org.squeryl.internals

FieldMetaData

class FieldMetaData extends AnyRef

go to: companion
linear super types: AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. FieldMetaData
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new FieldMetaData (parentMetaData: org.squeryl.internals.PosoMetaData[_], nameOfProperty: String, fieldType: Class[_], wrappedFieldType: Class[_], customTypeFactory: Option[(AnyRef) ⇒ Product1[Any] with AnyRef], isOption: Boolean, getter: Option[Method], setter: Option[Method], field: Option[Field], columnAnnotation: Option[Column], isOptimisticCounter: Boolean, sampleValue: Any)

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 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
  9. def canonicalEnumerationValueFor (id: Int) : Option[Value]

  10. 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
  11. def columnAttributes : Iterable[ColumnAttribute]

  12. def columnName : String

    The name of the database column

    The name of the database column

  13. val customTypeFactory : Option[(AnyRef) ⇒ Product1[Any] with AnyRef]

  14. def declaredAsPrimaryKeyInSchema : Boolean

    When true, will cause Schema generation to declare as PrimaryKey, Note that for KeyedEntity[]s, declaredAsPrimaryKeyInSchema is always true, and the cannot be made otherwise, the inverse is not true, a field can be declared as primary key in the Shema without it being the id of a KeyedEntity[], ex.

    When true, will cause Schema generation to declare as PrimaryKey, Note that for KeyedEntity[]s, declaredAsPrimaryKeyInSchema is always true, and the cannot be made otherwise, the inverse is not true, a field can be declared as primary key in the Shema without it being the id of a KeyedEntity[], ex. :

    on(myTable)(t =>declare(
      myField.is(primaryKey)  // myField doesn't need to be a KeyedEntity.id
    ))

    on(myKeyedEntityTable)(t =>declare(
      id.is(autoIncremented)  // omiting primaryKey here has no effect, it is equivalent as id.is(primaryKey,autoIncremented)
    ))

  15. def defaultValue : Option[org.squeryl.dsl.ast.ConstantExpressionNode[_]]

  16. def displayType : String

  17. 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
  18. 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
  19. def explicitDbTypeDeclaration : Option[String]

    The db column type declaration overriden in the schema, if None, it means that it is the default value for the adapter (see Correspondance of field types to database column types http://squeryl.

    The db column type declaration overriden in the schema, if None, it means that it is the default value for the adapter (see Correspondance of field types to database column types http://squeryl.org/schema-definition.html)

  20. val fieldType : Class[_]

  21. 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
  22. def get (o: AnyRef) : AnyRef

    gets the value of the field from the object.

    gets the value of the field from the object. Note that it will unwrap Option[] and return null instead of None, i.e. if converts None and Some to null and some.get respectively

  23. 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
  24. 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
  25. def isAutoIncremented : Boolean

  26. def isCustomType : Boolean

  27. def isEnumeration : Boolean

  28. def isIdFieldOfKeyedEntity : Boolean

  29. def isInsertable : Boolean

    Inserts will only set values for a column if isInsertable is true

    Inserts will only set values for a column if isInsertable is true

  30. 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
  31. val isOptimisticCounter : Boolean

  32. val isOption : Boolean

  33. def isStringType : Boolean

  34. def isUpdatable : Boolean

    Updates will only set values for a column if isUpdatable is true

    Updates will only set values for a column if isUpdatable is true

  35. def length : Int

    returns

    the length defined in org.squeryl.annotations.Column.length if it is defined, or the default length for Java primitive types. The unit of the length is dependent on the type, the convention is that numeric types have a length in byte, boolean is bits date has -1, and for string the lenght is in chars. double,long -> 8, float,int -> 4, byte -> 1, boolean -> 1 java.util.Date -> -1.

    The use of this field is to help custom schema generators select the most appropriate column type

  36. val nameOfProperty : String

  37. 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
  38. 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
  39. 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
  40. val parentMetaData : org.squeryl.internals.PosoMetaData[_]

  41. val resultSetHandler : (ResultSet, Int) ⇒ AnyRef

  42. val sampleValue : Any

  43. def scale : Int

  44. def schema : Schema

  45. def sequenceName : String

  46. def set (target: AnyRef, v: AnyRef) : Unit

    Sets the value 'v' to the object, the value will be converted to Some or None if the field is an Option[], (if isOption).

    Sets the value 'v' to the object, the value will be converted to Some or None if the field is an Option[], (if isOption).

  47. def setFromResultSet (target: AnyRef, rs: ResultSet, index: Int) : Unit

  48. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  49. 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: FieldMetaData → AnyRef → Any
  50. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef
  53. val wrappedFieldType : Class[_]

Inherited from AnyRef

Inherited from Any