Association (GORM for Rx 8.1.2)

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

@java.lang.SuppressWarnings("rawtypes")
public abstract class Association<T extends Property>
extends AbstractPersistentProperty

Models an association between one class and another

Authors:: Graeme Rocher

Since:: 1.0

Field Summary

Fields
Modifiers	Name	Description
`private static java.util.Set<javax.persistence.CascadeType>`	`DEFAULT_CHILD_CASCADE`
`private static java.util.Set<javax.persistence.CascadeType>`	`DEFAULT_OWNER_CASCADE`
`private PersistentEntity`	`associatedEntity`
`private java.util.Set<javax.persistence.CascadeType>`	`cascadeOperations`
`private static java.util.Map<java.lang.String, javax.persistence.CascadeType>`	`cascadeTypeConversions`
`private CascadeValidateType`	`cascadeValidateType`
`private boolean`	`orphanRemoval`
`private boolean`	`owningSide`
`private java.lang.String`	`referencedPropertyName`

Inherited fields
Fields inherited from class	Fields
`class AbstractPersistentProperty`	`context, inherited, name, owner, reader, type, writer`

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
	`private void`	`buildCascadeOperations()` It is possible this method could be called multiple times in some threaded initialization scenarios.
	`public boolean`	`doesCascade(javax.persistence.CascadeType cascadeOperation)` Returns true if the this association cascade for the given cascade operation
	`public boolean`	`doesCascade(javax.persistence.CascadeType cascadeOperations)` Returns true if this association cascades for the given cascade operation
	`public boolean`	`doesCascadeValidate(java.lang.Object associatedObject)` Returns true if this association should cascade validation to the given entity.
	`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
	`private CascadeValidateType`	`initializeCascadeValidateType()` It is possible this method could be called multiple times in some threaded initialization scenarios.
	`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.
	`public void`	`setAssociatedEntity(PersistentEntity associatedEntity)` Sets the associated entity
	`public void`	`setOwningSide(boolean owningSide)` Sets whether this association is the owning side
	`public void`	`setReferencedPropertyName(java.lang.String referencedPropertyName)` Sets the name of the inverse property
	`public java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractPersistentProperty`	`getCapitilizedName, getName, getOwner, getReader, getType, getWriter, isInherited, isNullable, toString`

- Field Detail
  - private static final java.util.Set<javax.persistence.CascadeType> DEFAULT_CHILD_CASCADE
  - private static final java.util.Set<javax.persistence.CascadeType> DEFAULT_OWNER_CASCADE
  - private PersistentEntity associatedEntity
  - private java.util.Set<javax.persistence.CascadeType> cascadeOperations
  - private static final java.util.Map<java.lang.String, javax.persistence.CascadeType> cascadeTypeConversions
  - private CascadeValidateType cascadeValidateType
  - private boolean orphanRemoval
  - private boolean owningSide
  - private java.lang.String referencedPropertyName
- 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
  - private void buildCascadeOperations()
    
    It is possible this method could be called multiple times in some threaded initialization scenarios. It needs to either remain idempotent or have the synchronization beefed up if that precondition ever changes.
  - public boolean doesCascade(javax.persistence.CascadeType cascadeOperation)
    
    Returns true if the this association cascade for the given cascade operation
    Parameters:
    cascadeOperation - The cascadeOperation
    Returns:
    True if it does
  - public boolean doesCascade(javax.persistence.CascadeType cascadeOperations)
    
    Returns true if this association cascades for the given cascade operation
    Parameters:
    cascadeOperations - The cascadeOperations
    Returns:
    True if it does
  - 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.
    Parameters:
    associatedObject - The associated object that may or may not be validated further
    Returns:
    True if validation should cascade
  - 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
  - private CascadeValidateType initializeCascadeValidateType()
    
    It is possible this method could be called multiple times in some threaded initialization scenarios. It needs to either remain idempotent or have the synchronization beefed up if that precondition ever changes.
  - 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:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class Association<T extends Property>

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final java.util.Set<javax.persistence.CascadeType> DEFAULT_CHILD_CASCADE

private static final java.util.Set<javax.persistence.CascadeType> DEFAULT_OWNER_CASCADE

private PersistentEntity associatedEntity

private java.util.Set<javax.persistence.CascadeType> cascadeOperations

private static final java.util.Map<java.lang.String, javax.persistence.CascadeType> cascadeTypeConversions

private CascadeValidateType cascadeValidateType

private boolean orphanRemoval

private boolean owningSide

private java.lang.String referencedPropertyName

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

private void buildCascadeOperations()

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()

private CascadeValidateType initializeCascadeValidateType()

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()