| java.lang.Object | |
| ↳ | org.hibernate.engine.CascadingAction |
Class Overview
A session action that may be cascaded from parent entity to its children
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| DELETE | |||||||||||
| EVICT | |||||||||||
| LOCK | |||||||||||
| MERGE | |||||||||||
| PERSIST | |||||||||||
| PERSIST_ON_FLUSH | Execute persist during flush time | ||||||||||
| REFRESH | |||||||||||
| REPLICATE | |||||||||||
| SAVE_UPDATE | |||||||||||
| SAVE_UPDATE_COPY | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Cascade the action to the child object.
| |||||||||||
Does this action potentially extrapolate to orphan deletes?
| |||||||||||
Given a collection, get an iterator of the children upon which the
current cascading action should be visited.
| |||||||||||
Iterate just the elements of the collection that are already there.
| |||||||||||
Called (in the case of
requiresNoCascadeChecking() returning true) to validate
that no cascade on the given property is considered a valid semantic. | |||||||||||
Should this action be performed (or noCascade consulted) in the case of lazy properties.
| |||||||||||
Does the specified cascading action require verification of no cascade validity?
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Fields
public static final CascadingAction REPLICATE
Public Methods
public abstract void cascade (EventSource session, Object child, String entityName, Object anything, boolean isCascadeDeleteEnabled)
Cascade the action to the child object.
Parameters
| session | The session within which the cascade is occuring. |
|---|---|
| child | The child to which cascading should be performed. |
| entityName | The child's entity name |
| anything | Anything ;) Typically some form of cascade-local cache which is specific to each CascadingAction type |
| isCascadeDeleteEnabled | Are cascading deletes enabled. |
Throws
| HibernateException |
|---|
public abstract boolean deleteOrphans ()
Does this action potentially extrapolate to orphan deletes?
Returns
- True if this action can lead to deletions of orphans.
public abstract Iterator getCascadableChildrenIterator (EventSource session, CollectionType collectionType, Object collection)
Given a collection, get an iterator of the children upon which the current cascading action should be visited.
Parameters
| session | The session within which the cascade is occuring. |
|---|---|
| collectionType | The mapping type of the collection. |
| collection | The collection instance. |
Returns
- The children iterator.
public static Iterator getLoadedElementsIterator (SessionImplementor session, CollectionType collectionType, Object collection)
Iterate just the elements of the collection that are already there. Don't load any new elements from the database.
public void noCascade (EventSource session, Object child, Object parent, EntityPersister persister, int propertyIndex)
Called (in the case of requiresNoCascadeChecking() returning true) to validate
that no cascade on the given property is considered a valid semantic.
Parameters
| session | The session witin which the cascade is occurring. |
|---|---|
| child | The property value |
| parent | The property value owner |
| persister | The entity persister for the owner |
| propertyIndex | The index of the property within the owner. |
public boolean performOnLazyProperty ()
Should this action be performed (or noCascade consulted) in the case of lazy properties.
public boolean requiresNoCascadeChecking ()
Does the specified cascading action require verification of no cascade validity?
Returns
- True if this action requires no-cascade verification; false otherwise.