Property (GORM 7.3.4)

org.grails.datastore.mapping.config.Property

All Implemented Interfaces and Traits:: java.lang.Cloneable

@groovy.transform.CompileStatic
@groovy.transform.builder.Builder(builderStrategy = SimpleStrategy, prefix = '')
class Property
extends java.lang.Object

Base class for classes returned from PropertyMapping.getMappedForm

Authors:: Graeme Rocher

Since:: 1.0

Properties Summary

Properties
Type	Name and description
`javax.persistence.AccessType`	`accessType` @return The default access type to use to read and write property values
`java.lang.String`	`cascade` Cascading strategy for this property.
`java.lang.String`	`cascadeValidate` Cascade validation for associations that are not owned by the parent entity.
`java.util.List<javax.persistence.CascadeType>`	`cascades` For specifying the cascade type using javax.persistence.CascadeType
`boolean`	`derived` @return Whether the property is derived or not
`javax.persistence.FetchType`	`fetchStrategy` @return The strategy to use to fetch the property (lazy or eager)
`java.lang.String`	`formula` The formula used to build the property
`java.lang.String`	`generator` Set the id generator name or class.
`java.util.List<java.lang.String>`	`inList` @return List of valid values
`boolean`	`index` @return Whether this property is index
`java.lang.Boolean`	`lazy` Whether to use lazy proxies for each association.
`java.lang.Comparable`	`max` @return The maximum value
`java.lang.Number`	`maxSize` @return The maximum size
`java.lang.Comparable`	`min` @return The minimum value
`java.lang.Number`	`minSize` @return The minimum size
`boolean`	`nullable` @return Whether the property is nullable
`boolean`	`orphanRemoval` Whether an entity of an orphaned association should be removed
`boolean`	`reference` @return Whether this property is a database reference such as a foreign key
`int`	`scale` @return The scale
`java.lang.String`	`targetName` The target to map to, could be a database column, document attribute, or hash key

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Property`	`clone()`
`<T extends Property>`	`static T`	`configureExisting(T property, groovy.lang.Closure config)` Configures an existing PropertyConfig instance
`<T extends Property>`	`static T`	`configureExisting(T property, java.util.Map config)` Configures an existing PropertyConfig instance
	`Property`	`fetch(java.lang.String name)` Configure the fetch strategy
	`Property`	`fetch(javax.persistence.FetchType type)` Configure the fetch strategy
	`java.lang.String`	`getEnumType()` @return The type of the enum, either ordinal or string
	`javax.persistence.EnumType`	`getEnumTypeObject()` @return The type of the enum, either ordinal or string
	`java.lang.Boolean`	`getLazy()`
	`java.lang.String`	`getName()` @return The name of the property this property mapping relates to
	`java.util.List<java.lang.String>`	`getUniquenessGroup()`
	`java.lang.Boolean`	`isLazy()`
	`boolean`	`isUnique()` @return Whether the property should be unique
	`boolean`	`isUniqueWithinGroup()` @return Whether the property is unique within a group
	`Property`	`name(java.lang.String propertyName)` @return The name of the property this property mapping relates to
	`void`	`setEnumType(javax.persistence.EnumType enumType)`
	`void`	`setEnumType(java.lang.String enumType)`
	`void`	`setFetch(java.lang.String name)` Makes it easier to configure the fetch strategy
	`void`	`setLazy(java.lang.Boolean lazy)`
	`void`	`setName(java.lang.String propertyName)`
	`void`	`setRange(groovy.lang.ObjectRange range)`
	`void`	`setSize(groovy.lang.IntRange maxSize)`
	`void`	`setUnique(boolean unique)`
	`void`	`setUnique(java.lang.String name)`
	`void`	`setUnique(java.util.List<java.lang.String> names)`
	`protected void`	`setUniquenessGroup(java.util.List<java.lang.String> uniquenessGroup)`
	`void`	`unique(boolean unique)`
	`void`	`unique(java.lang.String name)`
	`void`	`unique(java.util.List<java.lang.String> names)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`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
  - javax.persistence.AccessType accessType
    
    Returns:
    The default access type to use to read and write property values
  - java.lang.String cascade
    
    Cascading strategy for this property. Only makes sense if the property is an association or collection.
  - java.lang.String cascadeValidate
    
    Cascade validation for associations that are not owned by the parent entity. Only makes sense if the property is an association.
  - java.util.List<javax.persistence.CascadeType> cascades
    
    For specifying the cascade type using javax.persistence.CascadeType
  - boolean derived
    
    Returns:
    Whether the property is derived or not
  - javax.persistence.FetchType fetchStrategy
    
    Returns:
    The strategy to use to fetch the property (lazy or eager)
  - java.lang.String formula
    
    The formula used to build the property
  - java.lang.String generator
    
    Set the id generator name or class.
    Parameters:
    generator - name or class
  - java.util.List<java.lang.String> inList
    
    Returns:
    List of valid values
  - boolean index
    
    Returns:
    Whether this property is index
  - java.lang.Boolean lazy
    
    Whether to use lazy proxies for each association. This has no effect if getFetchStrategy() returns FetchType.EAGER, however if FetchType is LAZY and lazy is set to true then for collection types each element of the collection will be a proxy. If lazy is false the collection will be fetched lazily, but fully initialized objects will be loaded for each element.
    Returns:
    Whether to use lazy proxies for collection elements
  - java.lang.Comparable max
    
    Returns:
    The maximum value
  - java.lang.Number maxSize
    
    Returns:
    The maximum size
  - java.lang.Comparable min
    
    Returns:
    The minimum value
  - java.lang.Number minSize
    
    Returns:
    The minimum size
  - boolean nullable
    
    Returns:
    Whether the property is nullable
  - boolean orphanRemoval
    
    Whether an entity of an orphaned association should be removed
  - boolean reference
    
    Returns:
    Whether this property is a database reference such as a foreign key
  - int scale
    
    Returns:
    The scale
  - java.lang.String targetName
    
    The target to map to, could be a database column, document attribute, or hash key
    Returns:
    The target name
- Method Detail
  - @java.lang.Override Property clone()
  - <T extends Property> static T configureExisting(T property, @groovy.lang.DelegatesTo(Property) groovy.lang.Closure config)
    
    Configures an existing PropertyConfig instance
    Returns:
    The new instance
    Parameters:
    config - The configuration
  - <T extends Property> static T configureExisting(T property, java.util.Map config)
    
    Configures an existing PropertyConfig instance
    Returns:
    The new instance
    Parameters:
    config - The configuration
  - Property fetch(java.lang.String name)
    
    Configure the fetch strategy
    Returns:
    Parameters:
    name - The name of the fetch strategy
  - Property fetch(javax.persistence.FetchType type)
    
    Configure the fetch strategy
    Returns:
    Parameters:
    type - The type of the fetch strategy
  - java.lang.String getEnumType()
    
    Returns:
    The type of the enum, either ordinal or string
  - javax.persistence.EnumType getEnumTypeObject()
    
    Returns:
    The type of the enum, either ordinal or string
  - java.lang.Boolean getLazy()
  - java.lang.String getName()
    
    Returns:
    The name of the property this property mapping relates to
  - java.util.List<java.lang.String> getUniquenessGroup()
  - java.lang.Boolean isLazy()
  - boolean isUnique()
    
    Returns:
    Whether the property should be unique
  - boolean isUniqueWithinGroup()
    
    Returns:
    Whether the property is unique within a group
  - Property name(java.lang.String propertyName)
    
    Returns:
    The name of the property this property mapping relates to
  - void setEnumType(javax.persistence.EnumType enumType)
  - void setEnumType(java.lang.String enumType)
  - void setFetch(java.lang.String name)
    
    Makes it easier to configure the fetch strategy
    Parameters:
    name - The name of the fetch strategy
  - void setLazy(java.lang.Boolean lazy)
  - void setName(java.lang.String propertyName)
  - @groovy.transform.CompileDynamic void setRange(groovy.lang.ObjectRange range)
  - @groovy.transform.CompileDynamic void setSize(groovy.lang.IntRange maxSize)
  - void setUnique(boolean unique)
  - void setUnique(java.lang.String name)
  - void setUnique(java.util.List<java.lang.String> names)
  - protected void setUniquenessGroup(java.util.List<java.lang.String> uniquenessGroup)
  - void unique(boolean unique)
  - void unique(java.lang.String name)
  - void unique(java.util.List<java.lang.String> names)

Summary:
Property
Method

| Detail:
Property
Method

[Groovy] Class Property

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

javax.persistence.AccessType accessType

java.lang.String cascade

java.lang.String cascadeValidate

java.util.List<javax.persistence.CascadeType> cascades

boolean derived

javax.persistence.FetchType fetchStrategy

java.lang.String formula

java.lang.String generator

java.util.List<java.lang.String> inList

boolean index

java.lang.Boolean lazy

java.lang.Comparable max

java.lang.Number maxSize

java.lang.Comparable min

java.lang.Number minSize

boolean nullable

boolean orphanRemoval

boolean reference

int scale

java.lang.String targetName

Method Detail

@java.lang.Override Property clone()

<T extends Property> static T configureExisting(T property, @groovy.lang.DelegatesTo(Property) groovy.lang.Closure config)

<T extends Property> static T configureExisting(T property, java.util.Map config)

Property fetch(java.lang.String name)

Property fetch(javax.persistence.FetchType type)

java.lang.String getEnumType()

javax.persistence.EnumType getEnumTypeObject()

java.lang.Boolean getLazy()

java.lang.String getName()

java.util.List<java.lang.String> getUniquenessGroup()

java.lang.Boolean isLazy()

boolean isUnique()

boolean isUniqueWithinGroup()

Property name(java.lang.String propertyName)

void setEnumType(javax.persistence.EnumType enumType)

void setEnumType(java.lang.String enumType)

void setFetch(java.lang.String name)

void setLazy(java.lang.Boolean lazy)

void setName(java.lang.String propertyName)

@groovy.transform.CompileDynamic void setRange(groovy.lang.ObjectRange range)

@groovy.transform.CompileDynamic void setSize(groovy.lang.IntRange maxSize)

void setUnique(boolean unique)

void setUnique(java.lang.String name)

void setUnique(java.util.List<java.lang.String> names)

protected void setUniquenessGroup(java.util.List<java.lang.String> uniquenessGroup)

void unique(boolean unique)

void unique(java.lang.String name)

void unique(java.util.List<java.lang.String> names)