Association (GORM 7.3.4)

org.grails.datastore.mapping.model.types.Association

Models an association between one class and another
Authors:
Graeme Rocher
Since:
1.0

Constructor Summary

Constructors
Constructor and description
`Association (PersistentEntity owner, MappingContext context, java.beans.PropertyDescriptor descriptor)`
`Association (PersistentEntity owner, MappingContext context, java.lang.String name, java.lang.Class type)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`doesCascade(javax.persistence.CascadeType cascadeOperation)` Returns true if the this association cascade for the given cascade operation
	`boolean`	`doesCascade(javax.persistence.CascadeType... cascadeOperations)` Returns true if this association cascades for the given cascade operation
	`boolean`	`doesCascadeValidate(java.lang.Object associatedObject)` Returns true if this association should cascade validation to the given entity.
	`PersistentEntity`	`getAssociatedEntity()` @return The entity associated with the this association
	`protected java.util.Set<javax.persistence.CascadeType>`	`getCascadeOperations()`
	`protected CascadeValidateType`	`getCascadeValidateOperation()`
	`javax.persistence.FetchType`	`getFetchStrategy()` @return The fetch strategy for the association
	`Association`	`getInverseSide()` @return The inverse side or null if the association is not bidirectional
	`java.lang.String`	`getReferencedPropertyName()` @return Returns the name of the inverse property or null if this association is unidirectional
	`boolean`	`isBasic()` @return Whether this association is embedded
	`boolean`	`isBidirectional()` @return True if the association is bidirectional
	`boolean`	`isCircular()` @return Whether the association is circular
	`boolean`	`isEmbedded()` @return Whether this association is embedded
	`boolean`	`isList()` @return Whether the association is a List
	`boolean`	`isOrphanRemoval()` @return Whether orphaned entities should be removed when cascading deletes to this association
	`boolean`	`isOwningSide()` Returns whether this side owns the relationship.
	`void`	`setAssociatedEntity(PersistentEntity associatedEntity)` Sets the associated entity
	`void`	`setOwningSide(boolean owningSide)` Sets whether this association is the owning side
	`void`	`setReferencedPropertyName(java.lang.String referencedPropertyName)` Sets the name of the inverse property
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractPersistentProperty`	`getWriter, isNullable, toString, getName, isInherited, getType, getOwner, getReader, getCapitilizedName, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll, getMapping`
`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()`

- Constructor Detail
  - public Association(PersistentEntity owner, MappingContext context, java.beans.PropertyDescriptor descriptor)
  - public Association(PersistentEntity owner, MappingContext context, java.lang.String name, java.lang.Class type)
- Method Detail
  - public boolean doesCascade(javax.persistence.CascadeType cascadeOperation)
    
    Returns true if the this association cascade for the given cascade operation
    Returns:
    True if it does
    Parameters:
    cascadeOperation - The cascadeOperation
  - public boolean doesCascade(javax.persistence.CascadeType... cascadeOperations)
    
    Returns true if this association cascades for the given cascade operation
    Returns:
    True if it does
    Parameters:
    cascadeOperations - The cascadeOperations
  - public boolean doesCascadeValidate(java.lang.Object associatedObject)
    
    Returns true if this association should cascade validation to the given entity. Note that if the object state is persisted, it may still be validated as part of the object graph.
    Returns:
    True if validation should cascade
    Parameters:
    associatedObject - The associated object that may or may not be validated further
  - public PersistentEntity getAssociatedEntity()
    
    Returns:
    The entity associated with the this association
  - protected java.util.Set<javax.persistence.CascadeType> getCascadeOperations()
  - protected CascadeValidateType getCascadeValidateOperation()
  - public javax.persistence.FetchType getFetchStrategy()
    
    Returns:
    The fetch strategy for the association
  - public Association getInverseSide()
    
    Returns:
    The inverse side or null if the association is not bidirectional
  - public java.lang.String getReferencedPropertyName()
    
    Returns:
    Returns the name of the inverse property or null if this association is unidirectional
  - public boolean isBasic()
    
    Returns:
    Whether this association is embedded
  - public boolean isBidirectional()
    
    Returns:
    True if the association is bidirectional
  - public boolean isCircular()
    
    Returns:
    Whether the association is circular
  - public boolean isEmbedded()
    
    Returns:
    Whether this association is embedded
  - public boolean isList()
    
    Returns:
    Whether the association is a List
  - public boolean isOrphanRemoval()
    
    Returns:
    Whether orphaned entities should be removed when cascading deletes to this association
  - public boolean isOwningSide()
    
    Returns whether this side owns the relationship. This controls the default cascading behavior if none is specified
    Returns:
    True if this property is the owning side
  - public void setAssociatedEntity(PersistentEntity associatedEntity)
    
    Sets the associated entity
    Parameters:
    associatedEntity - The associated entity
  - public void setOwningSide(boolean owningSide)
    
    Sets whether this association is the owning side
    Parameters:
    owningSide - True if it is
  - public void setReferencedPropertyName(java.lang.String referencedPropertyName)
    
    Sets the name of the inverse property
    Parameters:
    referencedPropertyName - The referenced property name
  - @java.lang.Override public java.lang.String toString()

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class Association<T extends Property>

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public Association(PersistentEntity owner, MappingContext context, java.beans.PropertyDescriptor descriptor)

public Association(PersistentEntity owner, MappingContext context, java.lang.String name, java.lang.Class type)

Method Detail

public boolean doesCascade(javax.persistence.CascadeType cascadeOperation)

public boolean doesCascade(javax.persistence.CascadeType... cascadeOperations)

public boolean doesCascadeValidate(java.lang.Object associatedObject)

public PersistentEntity getAssociatedEntity()

protected java.util.Set<javax.persistence.CascadeType> getCascadeOperations()

protected CascadeValidateType getCascadeValidateOperation()

public javax.persistence.FetchType getFetchStrategy()

public Association getInverseSide()

public java.lang.String getReferencedPropertyName()

public boolean isBasic()

public boolean isBidirectional()

public boolean isCircular()

public boolean isEmbedded()

public boolean isList()

public boolean isOrphanRemoval()

public boolean isOwningSide()

public void setAssociatedEntity(PersistentEntity associatedEntity)

public void setOwningSide(boolean owningSide)

public void setReferencedPropertyName(java.lang.String referencedPropertyName)

@java.lang.Override public java.lang.String toString()