Represents a persistable Grails domain class.
Modifiers | Name | Description |
---|---|---|
java.lang.String |
GORM |
The name of the default ORM implementation used to map the class |
java.lang.String |
ORM_MAPPING |
Type Params | Return Type | Name and description |
---|---|---|
|
java.util.Map |
getAssociationMap() Returns this classes association map |
|
java.util.Map |
getConstrainedProperties() Returns a map of constraints applied to this domain class with the keys being the property name and the values being ConstrainedProperty instances |
|
java.lang.String |
getFieldName(java.lang.String propertyName) Returns the field name for the given property name |
|
GrailsDomainClassProperty |
getIdentifier() Returns the identifier property |
|
java.util.Map |
getMappedBy() @return The map that defines association mappings |
|
java.lang.String |
getMappingStrategy() @return The name of the ORM implementation used to map the domain class (default is "GORM") |
|
GrailsDomainClassProperty[] |
getPersistantProperties() Returns all of the persistant properties of the domain class |
|
GrailsDomainClassProperty[] |
getPersistentProperties() Returns all of the persistant properties of the domain class |
|
GrailsDomainClassProperty |
getPersistentProperty(java.lang.String name) Returns the property for the given name or null if non exists |
|
GrailsDomainClassProperty[] |
getProperties() Returns all of the properties of the domain class |
|
GrailsDomainClassProperty |
getPropertyByName(java.lang.String name) Returns the property for the given name |
|
java.lang.String |
getPropertyName() |
|
java.lang.Class |
getRelatedClassType(java.lang.String propertyName) Returns the type of the related class of the given property |
|
java.util.Set<GrailsDomainClass> |
getSubClasses() Returns the sub-classes for this class if any |
|
org.springframework.validation.Validator |
getValidator() Retreives the validator for this domain class |
|
GrailsDomainClassProperty |
getVersion() Returns the version property |
|
boolean |
hasPersistentProperty(java.lang.String propertyName) Returns true if this domain class has a persistent property for the given name |
|
boolean |
hasSubClasses() Returns true if the domain classes has sub classes |
|
boolean |
isBidirectional(java.lang.String propertyName) Returns true if the given property is a bi-directional relationship |
|
boolean |
isManyToOne(java.lang.String propertyName) Returns true if the given property is a many to one relationship |
|
boolean |
isOneToMany(java.lang.String propertyName) Returns true if the given property is a one to many relationship |
|
boolean |
isOwningClass(java.lang.Class domainClass) @param domainClass |
|
boolean |
isRoot() Whether the class is the root of a heirarchy |
|
void |
refreshConstraints() Refreshes the constraint defined on a domain class |
|
void |
setMappingStrategy(java.lang.String strategy) Sets the strategy to use for ORM mapping. |
|
void |
setValidator(org.springframework.validation.Validator validator) Sets the validator for this domain class |
Methods inherited from class | Name |
---|---|
interface GrailsClass |
getClazz, getFullName, getGrailsApplication, getLogicalPropertyName, getMetaClass, getName, getNaturalName, getPackageName, getPropertyName, getPropertyValue, getPropertyValue, getReference, getReferenceInstance, getShortName, hasProperty, isAbstract, newInstance |
interface GrailsApplicationAware |
setGrailsApplication |
The name of the default ORM implementation used to map the class
Returns this classes association map
Returns a map of constraints applied to this domain class with the keys being the property name and the values being ConstrainedProperty instances
Returns the field name for the given property name
Returns the identifier property
Returns all of the persistant properties of the domain class
Returns all of the persistant properties of the domain class
Returns the property for the given name or null if non exists
name
- The property nameReturns all of the properties of the domain class
Returns the property for the given name
name
- The property for the name
Returns the default property name of the GrailsClass. For example the property name for a class called "User" would be "user"
Returns the type of the related class of the given property
propertyName
- The name of the propertyReturns the sub-classes for this class if any
Retreives the validator for this domain class
Returns the version property
Returns true if this domain class has a persistent property for the given name
propertyName
- The property nameReturns true if the domain classes has sub classes
Returns true if the given property is a bi-directional relationship
propertyName
- The name of the propertyReturns true if the given property is a many to one relationship
propertyName
- The name of the propertyReturns true if the given property is a one to many relationship
propertyName
- The name of the property
Whether the class is the root of a heirarchy
Refreshes the constraint defined on a domain class
Sets the strategy to use for ORM mapping. Default is GORM
strategy
- The mapping strategySets the validator for this domain class
validator
- The domain class validator to set