PropertyConfig (GORM 5.0.8)

org.grails.orm.hibernate.cfg.PropertyConfig

Custom mapping for a single domain property. Note that a property can have multiple columns via a component or a user type.
Authors:
pledbrook
Since:
1.0.4

Properties Summary

Properties
Type	Name and description
`java.lang.Integer`	`batchSize` The batch size used for lazy loading
`CacheConfig`	`cache`
`java.lang.String`	`cascade` Cascading strategy for this property.
`java.util.List<ColumnConfig>`	`columns`
`boolean`	`derived` Whether the property is derived
`boolean`	`explicitSaveUpdateCascade`
`org.hibernate.FetchMode`	`fetch` The fetch strategy for this property.
`java.lang.String`	`formula`
`boolean`	`ignoreNotFound` Whether to ignore ObjectNotFoundException
`PropertyConfig`	`indexColumn` The column used to produce the index for index based collections (lists and maps)
`boolean`	`insertable` Whether or not this is column is insertable by hibernate
`JoinTable`	`joinTable`
`java.lang.String`	`order` The default sort order
`java.lang.String`	`sort` The default sort property name
`java.lang.Object`	`type` The Hibernate type or user type of the property.
`java.util.Properties`	`typeParams` The parameters for the property that can be used to configure a Hibernate ParameterizedType implementation.
`boolean`	`updateable` Whether or not this column is updateable by hibernate

Methods Summary

Methods
Type	Name and description
`protected void`	`checkHasSingleColumn()`
`PropertyConfig`	`clone()`
`java.lang.String`	`getColumn()` Shortcut to get the column name for this property.
`java.lang.String`	`getEnumType()`
`org.hibernate.FetchMode`	`getFetch()`
`java.lang.String`	`getIndex()` Shortcut to get the index setting for this property's column.
`int`	`getLength()` Shortcut to get the length of this property's column.
`int`	`getPrecision()` Shortcut to get the precision of this property's column.
`int`	`getScale()` Shortcut to get the scale of this property's column.
`java.lang.String`	`getSqlType()` Shortcut to get the SQL type of the corresponding column.
`boolean`	`isUnique()` Shortcut to determine whether the property's column is configured to be unique.
`void`	`setFetch(org.hibernate.FetchMode fetch)`
`void`	`setScale(int scale)`
`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Property`	`clone, getEnumType, getEnumTypeObject, getFetchStrategy, getGenerator, getInList, getLazy, getMax, getMaxSize, getMin, getMinSize, getName, getScale, getTargetName, getUniquenessGroup, isIndex, isLazy, isNullable, isUnique, isUniqueWithinGroup, setEnumType, setEnumType, setFetch, setFetchStrategy, setGenerator, setInList, setIndex, setLazy, setMax, setMaxSize, setMin, setMinSize, setName, setNullable, setRange, setScale, setSize, setTargetName, setUnique, setUnique, setUnique`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.lang.Integer batchSize
    
    The batch size used for lazy loading
  - CacheConfig cache
  - java.lang.String cascade
    
    Cascading strategy for this property. Only makes sense if the property is an association or collection.
  - java.util.List<ColumnConfig> columns
  - boolean derived
    
    Whether the property is derived
  - boolean explicitSaveUpdateCascade
  - org.hibernate.FetchMode fetch
    
    The fetch strategy for this property.
  - java.lang.String formula
  - boolean ignoreNotFound
    
    Whether to ignore ObjectNotFoundException
  - PropertyConfig indexColumn
    
    The column used to produce the index for index based collections (lists and maps)
  - boolean insertable
    
    Whether or not this is column is insertable by hibernate
  - JoinTable joinTable
  - java.lang.String order
    
    The default sort order
  - java.lang.String sort
    
    The default sort property name
  - java.lang.Object type
    
    The Hibernate type or user type of the property. This can be a string or a class.
  - java.util.Properties typeParams
    
    The parameters for the property that can be used to configure a Hibernate ParameterizedType implementation.
  - boolean updateable
    
    Whether or not this column is updateable by hibernate
- Method Detail
  - protected void checkHasSingleColumn()
  - @java.lang.Override PropertyConfig clone()
  - java.lang.String getColumn()
    
    Shortcut to get the column name for this property.
    throws:
    RuntimeException if this property maps to more than one column.
  - java.lang.String getEnumType()
  - org.hibernate.FetchMode getFetch()
  - java.lang.String getIndex()
    
    Shortcut to get the index setting for this property's column.
    throws:
    RuntimeException if this property maps to more than one column.
  - int getLength()
    
    Shortcut to get the length of this property's column.
    throws:
    RuntimeException if this property maps to more than one column.
  - int getPrecision()
    
    Shortcut to get the precision of this property's column.
    throws:
    RuntimeException if this property maps to more than one column.
  - int getScale()
    
    Shortcut to get the scale of this property's column.
    throws:
    RuntimeException if this property maps to more than one column.
  - java.lang.String getSqlType()
    
    Shortcut to get the SQL type of the corresponding column.
    throws:
    RuntimeException if this property maps to more than one column.
  - boolean isUnique()
    
    Shortcut to determine whether the property's column is configured to be unique.
    throws:
    RuntimeException if this property maps to more than one column.
  - void setFetch(org.hibernate.FetchMode fetch)
  - @java.lang.Override void setScale(int scale)
  - java.lang.String toString()

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class PropertyConfig

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.Integer batchSize

CacheConfig cache

java.lang.String cascade

java.util.List<ColumnConfig> columns

boolean derived

boolean explicitSaveUpdateCascade

org.hibernate.FetchMode fetch

java.lang.String formula

boolean ignoreNotFound

PropertyConfig indexColumn

boolean insertable

JoinTable joinTable

java.lang.String order

java.lang.String sort

java.lang.Object type

java.util.Properties typeParams

boolean updateable

Method Detail

protected void checkHasSingleColumn()

@java.lang.Override PropertyConfig clone()

java.lang.String getColumn()

java.lang.String getEnumType()

org.hibernate.FetchMode getFetch()

java.lang.String getIndex()

int getLength()

int getPrecision()

int getScale()

java.lang.String getSqlType()

boolean isUnique()

void setFetch(org.hibernate.FetchMode fetch)

@java.lang.Override void setScale(int scale)

java.lang.String toString()