squeryl
API
Generated with
squeryl/org.squeryl/org.squeryl.internals/FieldMetaData

FieldMetaData

org.squeryl.internals.FieldMetaData
See theFieldMetaData companion object
class FieldMetaData(val parentMetaData: PosoMetaData[_], val nameOfProperty: String, val fieldType: Class[_], val wrappedFieldType: Class[_], val customTypeFactory: Option[AnyRef => Product1[Any] & AnyRef], val isOption: Boolean, getter: Option[Method], setter: Option[Method], field: Option[Field], columnAnnotation: Option[Column], val isOptimisticCounter: Boolean, val sampleValue: Any)

Attributes

Companion
object
Source
FieldMetaData.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def canonicalEnumerationValueFor(id: Int): Value

Attributes

Source
FieldMetaData.scala
def columnAttributes: Iterable[ColumnAttribute]

Attributes

Source
FieldMetaData.scala
def columnName: String

The name of the database column

The name of the database column

Attributes

Source
FieldMetaData.scala
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)  // omitting primaryKey here has no effect, it is equivalent as id.is(primaryKey,autoIncremented)
))

Attributes

Source
FieldMetaData.scala
def defaultValue: Option[ConstantTypedExpression[_, _]]

Attributes

Source
FieldMetaData.scala
def displayType: String

Attributes

Source
FieldMetaData.scala
def explicitDbTypeCast: Boolean

If explicit db type case has been requested

If explicit db type case has been requested

Attributes

Source
FieldMetaData.scala
def explicitDbTypeDeclaration: Option[String]

The db column type declaration overridden 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)

The db column type declaration overridden 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)

Attributes

Source
FieldMetaData.scala
def get(o: AnyRef): AnyRef

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

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

Value parameters

o

the object that owns the field

Attributes

Source
FieldMetaData.scala
def getNativeJdbcValue(o: AnyRef): AnyRef

Attributes

Source
FieldMetaData.scala
def isAutoIncremented: Boolean

Attributes

Source
FieldMetaData.scala
def isCustomType: Boolean

Attributes

Source
FieldMetaData.scala
def isIdFieldOfKeyedEntity: Boolean

Attributes

Source
FieldMetaData.scala
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

Attributes

Source
FieldMetaData.scala
def isStringType: Boolean

Attributes

Source
FieldMetaData.scala
def isTransient: Boolean

Attributes

Source
FieldMetaData.scala
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

Attributes

Source
FieldMetaData.scala
def length: Int

Attributes

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 length 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

Source
FieldMetaData.scala
def nativeJdbcType: Class[_]

Attributes

Source
FieldMetaData.scala
def scale: Int

Attributes

Source
FieldMetaData.scala
def schema: Schema

Attributes

Source
FieldMetaData.scala
def sequenceName: String

Attributes

Source
FieldMetaData.scala
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).

Attributes

Source
FieldMetaData.scala
def setFromResultSet(target: AnyRef, rs: ResultSet, index: Int): Unit

Attributes

Source
FieldMetaData.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
FieldMetaData.scala

Concrete fields

val customTypeFactory: Option[AnyRef => Product1[Any] & AnyRef]

Attributes

Source
FieldMetaData.scala
val enumeration: Option[Enumeration]

None if this FieldMetaData is not an enumeration, Some(theParentEnumeration) otherwise

None if this FieldMetaData is not an enumeration, Some(theParentEnumeration) otherwise

Attributes

Source
FieldMetaData.scala
val fieldType: Class[_]

Attributes

Source
FieldMetaData.scala
val isOptimisticCounter: Boolean

Attributes

Source
FieldMetaData.scala
val isOption: Boolean

Attributes

Source
FieldMetaData.scala
val nameOfProperty: String

Attributes

Source
FieldMetaData.scala
val parentMetaData: PosoMetaData[_]

Attributes

Source
FieldMetaData.scala
val resultSetHandler: (ResultSet, Int) => AnyRef

Attributes

Source
FieldMetaData.scala
val sampleValue: Any

Attributes

Source
FieldMetaData.scala
val wrappedFieldType: Class[_]

Attributes

Source
FieldMetaData.scala
Generated with