PropertyConfig (GORM for Hibernate 5

org.grails.orm.hibernate.cfg.PropertyConfig

```
@groovy.transform.CompileStatic
@groovy.transform.builder.Builder(builderStrategy: SimpleStrategy, prefix: )
class PropertyConfig
extends Property
```
Custom mapping for a single domain property. Note that a property can have multiple columns via a component or a user type.
Since:
1.0.4
Authors:
pledbrook

Properties Summary

Properties
Type	Name and description
`java.lang.Integer`	`batchSize` The batch size used for lazy loading
`CacheConfig`	`cache` The cache configuration
`java.util.List<ColumnConfig>`	`columns` The columns
`boolean`	`explicitSaveUpdateCascade`
`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` The join table configuration
`java.lang.String`	`order` The default sort order
`int`	`scale`
`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`	`unique`
`boolean`	`updatable` Whether or not this column is updatable by hibernate

Constructor Summary

Constructors
Constructor and description
`PropertyConfig ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`PropertyConfig`	`cache(groovy.lang.Closure cacheConfig)` Define the cache config
	`PropertyConfig`	`cache(java.util.Map cacheConfig)` Define the cache config
	`protected void`	`checkHasSingleColumn()`
	`PropertyConfig`	`clone()`
	`PropertyConfig`	`column(groovy.lang.Closure columnDef)` Configure a column
	`PropertyConfig`	`column(java.util.Map columnDef)` Configure a column
	`PropertyConfig`	`column(java.lang.String columnDef)` Configure a column
	`static PropertyConfig`	`configureExisting(PropertyConfig property, java.util.Map config)` Configures an existing PropertyConfig instance
	`static PropertyConfig`	`configureExisting(PropertyConfig property, groovy.lang.Closure config)` Configures an existing PropertyConfig instance
	`static PropertyConfig`	`configureNew(groovy.lang.Closure config)` Configures a new PropertyConfig instance
	`static PropertyConfig`	`configureNew(java.util.Map config)` Configures a new PropertyConfig instance
	`java.lang.String`	`getColumn()` Shortcut to get the column name for this property.
	`java.lang.String`	`getEnumType()`
	`org.hibernate.FetchMode`	`getFetchMode()` Returns: The Hibernate org.hibernate.FetchMode
	`java.lang.String`	`getIndexName()` 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`	`getUpdateable()` Whether or not this column is updatable by hibernate
	`PropertyConfig`	`indexColumn(groovy.lang.Closure indexColumnConfig)` The column used to produce the index for index based collections (lists and maps)
	`boolean`	`isUnique()` Shortcut to determine whether the property's column is configured to be unique.
	`PropertyConfig`	`joinTable(groovy.lang.Closure joinTableDef)` The join table configuration
	`PropertyConfig`	`joinTable(java.lang.String tableName)` The join table configuration
	`PropertyConfig`	`joinTable(java.util.Map joinTableDef)` The join table configuration
	`void`	`setFetch(org.hibernate.FetchMode fetch)` Parameters: `fetch` - The Hibernate org.hibernate.FetchMode
	`void`	`setScale(int scale)`
	`void`	`setUnique(boolean unique)`
	`void`	`setUpdateable(boolean updateable)` Whether or not this column is updatable by hibernate
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Property`	`clone, configureExisting, configureExisting, fetch, fetch, getEnumType, getEnumTypeObject, getLazy, getName, getUniquenessGroup, isLazy, isUnique, isUniqueWithinGroup, name, setEnumType, setEnumType, setFetch, setLazy, setName, setRange, setSize, setUnique, setUnique, setUnique, setUniquenessGroup, unique, unique, unique`

- Property Detail
  - java.lang.Integer batchSize
    
    The batch size used for lazy loading
  - CacheConfig cache
    
    The cache configuration
  - java.util.List<ColumnConfig> columns
    
    The columns
  - boolean explicitSaveUpdateCascade
  - 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
    
    The join table configuration
  - java.lang.String order
    
    The default sort order
  - int scale
  - 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 unique
  - boolean updatable
    
    Whether or not this column is updatable by hibernate
- Constructor Detail
  - PropertyConfig()
- Method Detail
  - PropertyConfig cache(@groovy.lang.DelegatesTo(value: CacheConfig) groovy.lang.Closure cacheConfig)
    
    Define the cache config
    Parameters:
    cacheConfig - The cache config
    Returns:
    This mapping
  - PropertyConfig cache(java.util.Map cacheConfig)
    
    Define the cache config
    Parameters:
    cacheConfig - The cache config
    Returns:
    This mapping
  - protected void checkHasSingleColumn()
  - @java.lang.Override PropertyConfig clone()
  - PropertyConfig column(@groovy.lang.DelegatesTo(value: ColumnConfig) groovy.lang.Closure columnDef)
    
    Configure a column
    Parameters:
    columnDef - The column definition
    Returns:
    This property config
  - PropertyConfig column(java.util.Map columnDef)
    
    Configure a column
    Parameters:
    columnDef - The column definition
    Returns:
    This property config
  - PropertyConfig column(java.lang.String columnDef)
    
    Configure a column
    Parameters:
    columnDef - The column definition
    Returns:
    This property config
  - static PropertyConfig configureExisting(PropertyConfig property, java.util.Map config)
    
    Configures an existing PropertyConfig instance
    Parameters:
    config - The configuration
    Returns:
    The new instance
  - static PropertyConfig configureExisting(PropertyConfig property, @groovy.lang.DelegatesTo(value: PropertyConfig) groovy.lang.Closure config)
    
    Configures an existing PropertyConfig instance
    Parameters:
    config - The configuration
    Returns:
    The new instance
  - static PropertyConfig configureNew(@groovy.lang.DelegatesTo(value: PropertyConfig) groovy.lang.Closure config)
    
    Configures a new PropertyConfig instance
    Parameters:
    config - The configuration
    Returns:
    The new instance
  - static PropertyConfig configureNew(java.util.Map config)
    
    Configures a new PropertyConfig instance
    Parameters:
    config - The configuration
    Returns:
    The new instance
  - 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 getFetchMode()
    
    Returns:
    The Hibernate org.hibernate.FetchMode
  - java.lang.String getIndexName()
    
    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.
  - @java.lang.Deprecated boolean getUpdateable()
    
    Whether or not this column is updatable by hibernate
    deprecated:
    Use updatable instead
  - PropertyConfig indexColumn(@groovy.lang.DelegatesTo(value: PropertyConfig) groovy.lang.Closure indexColumnConfig)
    
    The column used to produce the index for index based collections (lists and maps)
  - 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.
  - PropertyConfig joinTable(@groovy.lang.DelegatesTo(value: JoinTable) groovy.lang.Closure joinTableDef)
    
    The join table configuration
  - PropertyConfig joinTable(java.lang.String tableName)
    
    The join table configuration
  - PropertyConfig joinTable(java.util.Map joinTableDef)
    
    The join table configuration
  - void setFetch(org.hibernate.FetchMode fetch)
    
    Parameters:
    fetch - The Hibernate org.hibernate.FetchMode
  - @java.lang.Override void setScale(int scale)
  - @java.lang.Override void setUnique(boolean unique)
  - @java.lang.Deprecated void setUpdateable(boolean updateable)
    
    Whether or not this column is updatable by hibernate
    deprecated:
    Use updatable instead
  - java.lang.String toString()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class PropertyConfig

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.Integer batchSize

CacheConfig cache

java.util.List<ColumnConfig> columns

boolean explicitSaveUpdateCascade

boolean ignoreNotFound

PropertyConfig indexColumn

boolean insertable

JoinTable joinTable

java.lang.String order

int scale

java.lang.String sort

java.lang.Object type

java.util.Properties typeParams

boolean unique

boolean updatable

Constructor Detail

PropertyConfig()

Method Detail

PropertyConfig cache(@groovy.lang.DelegatesTo(value: CacheConfig) groovy.lang.Closure cacheConfig)

PropertyConfig cache(java.util.Map cacheConfig)

protected void checkHasSingleColumn()

@java.lang.Override PropertyConfig clone()

PropertyConfig column(@groovy.lang.DelegatesTo(value: ColumnConfig) groovy.lang.Closure columnDef)

PropertyConfig column(java.util.Map columnDef)

PropertyConfig column(java.lang.String columnDef)

static PropertyConfig configureExisting(PropertyConfig property, java.util.Map config)

static PropertyConfig configureExisting(PropertyConfig property, @groovy.lang.DelegatesTo(value: PropertyConfig) groovy.lang.Closure config)

static PropertyConfig configureNew(@groovy.lang.DelegatesTo(value: PropertyConfig) groovy.lang.Closure config)

static PropertyConfig configureNew(java.util.Map config)

java.lang.String getColumn()

java.lang.String getEnumType()

org.hibernate.FetchMode getFetchMode()

java.lang.String getIndexName()

int getLength()

int getPrecision()

int getScale()

java.lang.String getSqlType()

@java.lang.Deprecated boolean getUpdateable()

PropertyConfig indexColumn(@groovy.lang.DelegatesTo(value: PropertyConfig) groovy.lang.Closure indexColumnConfig)

boolean isUnique()

PropertyConfig joinTable(@groovy.lang.DelegatesTo(value: JoinTable) groovy.lang.Closure joinTableDef)

PropertyConfig joinTable(java.lang.String tableName)

PropertyConfig joinTable(java.util.Map joinTableDef)

void setFetch(org.hibernate.FetchMode fetch)

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

@java.lang.Override void setUnique(boolean unique)

@java.lang.Deprecated void setUpdateable(boolean updateable)

java.lang.String toString()