com.avaje.ebean.bean

Class EntityBeanIntercept

java.lang.Object

com.avaje.ebean.bean.EntityBeanIntercept

All Implemented Interfaces:

Serializable

public final class EntityBeanIntercept
extends Object
implements Serializable

This is the object added to every entity bean using byte code enhancement.

This provides the mechanisms to support deferred fetching of reference beans and oldValues generation for concurrency checking.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EntityBeanIntercept(Object ownerBean) Create a intercept with a given entity.

Method Summary

Modifier and Type	Method and Description
int	addDirtyPropertyHash(int hash) Add and return a dirty property hash recursing into embedded beans.
void	addDirtyPropertyNames(Set<String> props, String prefix) Recursively add dirty properties.
void	addDirtyPropertyValues(Map<String,ValuePair> dirtyValues, String prefix) Recursively add dirty properties.
void	addPropertyChangeListener(PropertyChangeListener listener) Add a property change listener for this entity bean.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Add a property change listener for this entity bean for a specific property.
protected boolean	areEqual(Object obj1, Object obj2) Helper method to check if two objects are equal.
int	findProperty(String propertyName) Finds the index position of a given property.
boolean[]	getChanged() Return the set of property names for changed properties.
boolean[]	getDirtyProperties() Return the array of flags indicating the dirty properties.
int	getDirtyPropertyHash() Return a dirty property hash taking into account embedded beans.
Set<String>	getDirtyPropertyNames() Return the set of dirty properties.
Map<String,ValuePair>	getDirtyValues() Return a map of dirty properties with their new and old values.
Object	getEmbeddedOwner() Return the owning bean for an embedded bean.
int	getEmbeddedOwnerIndex() Return the property index (for the parent) of this embedded bean.
String	getLazyLoadProperty() Return the property that triggered the lazy load.
int	getLazyLoadPropertyIndex() Return the index of the property that triggered the lazy load.
boolean[]	getLoaded()
int	getLoadedPropertyHash() Return a loaded property hash.
Set<String>	getLoadedPropertyNames() Return the set of property names for a partially loaded bean.
Object	getOrigValue(int propertyIndex) Return the original value that was changed via an update.
EntityBean	getOwner() Return the 'owning' entity bean.
PersistenceContext	getPersistenceContext() Return the persistenceContext.
String	getProperty(int propertyIndex) Return the property name for the given property.
int	getPropertyLength() Return the number of properties.s
boolean	hasDirtyProperty(Set<String> propertyNames) Return true if any of the given property names are dirty.
boolean	hasIdOnly(int idIndex) Return true if only the Id property has been loaded.
void	initialisedMany(int propertyIndex) Called when a BeanCollection is initialised automatically.
boolean	isChangedProperty(int propertyIndex) Return true if the property is considered changed.
boolean	isDirty() Return true if this bean has been directly modified (it has oldValues) or if any embedded beans are either new or dirty (and hence need saving).
boolean	isDirtyProperty(int propertyIndex) Return true if the property was changed or if it is embedded and one of its embedded properties is dirty.
boolean	isDisableLazyLoad() Return true if lazy loading is disabled.
boolean	isEmbeddedNewOrDirty(Object embeddedBean) Return true if the embedded bean is new or dirty and hence needs saving.
boolean	isFullyLoadedBean()
boolean	isLazyLoadFailure() Return true if the bean is marked as having failed lazy loading.
boolean	isLoaded() Return true if the entity has been loaded.
boolean	isLoadedProperty(int propertyIndex) Return true if the property is loaded.
boolean	isNew() Return true if this entity bean is new and not yet saved.
boolean	isNewOrDirty() Return true if the entity bean is new or dirty (and should be saved).
boolean	isPartial() Check each property to see if the bean is partially loaded.
boolean	isReadOnly() Return true if the bean should be treated as readOnly.
boolean	isReference() Return true if the entity is a reference.
protected void	loadBean(int loadProperty) Load the bean when it is a reference.
void	markPropertyAsChanged(int propertyIndex) Explicitly mark a property as having been changed.
void	postSetter(PropertyChangeEvent event) Called for "enhancement" postSetter processing.
void	postSetter(PropertyChangeEvent event, Object newValue) Called for "subclassed" postSetter processing.
void	preGetter(int propertyIndex) Method that is called prior to a getter method on the actual entity.
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, boolean oldValue, boolean newValue) Check for primitive boolean.
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, byte[] oldValue, byte[] newValue) byte[].
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, byte oldValue, byte newValue) byte.
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, char[] oldValue, char[] newValue) char[].
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, char oldValue, char newValue) char.
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, double oldValue, double newValue) double.
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, float oldValue, float newValue) float.
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, int oldValue, int newValue) Check for primitive int.
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, long oldValue, long newValue) long.
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, Object oldValue, Object newValue) Check to see if the values are not equal.
PropertyChangeEvent	preSetter(boolean intercept, int propertyIndex, short oldValue, short newValue) short.
PropertyChangeEvent	preSetterMany(boolean interceptField, int propertyIndex, Object oldValue, Object newValue) OneToMany and ManyToMany don't have any interception so just check for PropertyChangeSupport.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove a property change listener for this entity bean.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Remove a property change listener for this entity bean for a specific property.
void	setBeanLoader(BeanLoader beanLoader) Set the BeanLoader.
void	setBeanLoader(BeanLoader beanLoader, PersistenceContext ctx) Set the BeanLoader with PersistenceContext.
void	setChangedProperty(int propertyIndex)
void	setDirty(boolean dirty)
void	setDisableLazyLoad(boolean disableLazyLoad) Set true to turn off lazy loading.
void	setEmbeddedDirty(int embeddedProperty) Called by an embedded bean onto its owner.
void	setEmbeddedLoaded(Object embeddedBean) Set the loaded status for the embedded bean.
void	setEmbeddedOwner(EntityBean parentBean, int embeddedOwnerIndex) Set the embedded beans owning bean.
void	setFullyLoadedBean(boolean fullyLoadedBean)
void	setLazyLoadFailure(Object ownerId) Set lazy load failure flag.
void	setLoaded() Set the loaded state to true.
void	setLoadedLazy() When finished loading for lazy or refresh on an already partially populated bean.
void	setLoadedProperty(int propertyIndex) Set the property to be loaded.
void	setNewBeanForUpdate() For forced update on a 'New' bean set all the loaded properties to changed.
void	setNodeUsageCollector(NodeUsageCollector usageCollector) Turn on profile collection.
void	setPersistenceContext(PersistenceContext persistenceContext) Set the persistenceContext.
void	setPropertyLoaded(String propertyName, boolean loaded) Set the loaded state of the property given it's name.
void	setPropertyUnloaded(int propertyIndex) Set the property to be treated as unloaded.
void	setReadOnly(boolean readOnly) Set the readOnly status.
void	setReference(int idPos) Set this as a reference object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityBeanIntercept

public EntityBeanIntercept(Object ownerBean)

Create a intercept with a given entity.

Refer to agent ProxyConstructor.

Method Detail

getOwner

public EntityBean getOwner()

Return the 'owning' entity bean.

getPersistenceContext

public PersistenceContext getPersistenceContext()

Return the persistenceContext.

setPersistenceContext

public void setPersistenceContext(PersistenceContext persistenceContext)

Set the persistenceContext.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a property change listener for this entity bean.

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

Add a property change listener for this entity bean for a specific property.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove a property change listener for this entity bean.

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

Remove a property change listener for this entity bean for a specific property.

setNodeUsageCollector

public void setNodeUsageCollector(NodeUsageCollector usageCollector)

Turn on profile collection.

getEmbeddedOwner

public Object getEmbeddedOwner()

Return the owning bean for an embedded bean.

getEmbeddedOwnerIndex

public int getEmbeddedOwnerIndex()

Return the property index (for the parent) of this embedded bean.

setEmbeddedOwner

public void setEmbeddedOwner(EntityBean parentBean,
                             int embeddedOwnerIndex)

Set the embedded beans owning bean.

setBeanLoader

public void setBeanLoader(BeanLoader beanLoader,
                          PersistenceContext ctx)

Set the BeanLoader with PersistenceContext.

setBeanLoader

public void setBeanLoader(BeanLoader beanLoader)

Set the BeanLoader.

isFullyLoadedBean

public boolean isFullyLoadedBean()

setFullyLoadedBean

public void setFullyLoadedBean(boolean fullyLoadedBean)

isPartial

public boolean isPartial()

Check each property to see if the bean is partially loaded.

isDirty

public boolean isDirty()

Return true if this bean has been directly modified (it has oldValues) or if any embedded beans are either new or dirty (and hence need saving).

setEmbeddedDirty

public void setEmbeddedDirty(int embeddedProperty)

Called by an embedded bean onto its owner.

setDirty

public void setDirty(boolean dirty)

isNew

public boolean isNew()

Return true if this entity bean is new and not yet saved.

isNewOrDirty

public boolean isNewOrDirty()

Return true if the entity bean is new or dirty (and should be saved).

hasIdOnly

public boolean hasIdOnly(int idIndex)

Return true if only the Id property has been loaded.

isReference

public boolean isReference()

Return true if the entity is a reference.

setReference

public void setReference(int idPos)

Set this as a reference object.

isReadOnly

public boolean isReadOnly()

Return true if the bean should be treated as readOnly. If a setter method is called when it is readOnly an Exception is thrown.

setReadOnly

public void setReadOnly(boolean readOnly)

Set the readOnly status. If readOnly then calls to setter methods through an exception.

isLoaded

public boolean isLoaded()

Return true if the entity has been loaded.

setLoaded

public void setLoaded()

Set the loaded state to true.

Calls to setter methods after the bean is loaded can result in 'Old Values' being created to support ConcurrencyMode.ALL

Worth noting that this is also set after a insert/update. By doing so it 'resets' the bean for making further changes and saving again.

setLoadedLazy

public void setLoadedLazy()

When finished loading for lazy or refresh on an already partially populated bean.

setLazyLoadFailure

public void setLazyLoadFailure(Object ownerId)

Set lazy load failure flag.

isLazyLoadFailure

public boolean isLazyLoadFailure()

Return true if the bean is marked as having failed lazy loading.

isDisableLazyLoad

public boolean isDisableLazyLoad()

Return true if lazy loading is disabled.

setDisableLazyLoad

public void setDisableLazyLoad(boolean disableLazyLoad)

Set true to turn off lazy loading.

Typically used to disable lazy loading on SQL based report beans.

setEmbeddedLoaded

public void setEmbeddedLoaded(Object embeddedBean)

Set the loaded status for the embedded bean.

isEmbeddedNewOrDirty

public boolean isEmbeddedNewOrDirty(Object embeddedBean)

Return true if the embedded bean is new or dirty and hence needs saving.

getOrigValue

public Object getOrigValue(int propertyIndex)

Return the original value that was changed via an update.

findProperty

public int findProperty(String propertyName)

Finds the index position of a given property. Returns -1 if the property can not be found.

getProperty

public String getProperty(int propertyIndex)

Return the property name for the given property.

getPropertyLength

public int getPropertyLength()

Return the number of properties.s

setPropertyLoaded

public void setPropertyLoaded(String propertyName,
                              boolean loaded)

Set the loaded state of the property given it's name.

setPropertyUnloaded

public void setPropertyUnloaded(int propertyIndex)

Set the property to be treated as unloaded. Used for properties initialised in default constructor.

setLoadedProperty

public void setLoadedProperty(int propertyIndex)

Set the property to be loaded.

isLoadedProperty

public boolean isLoadedProperty(int propertyIndex)

Return true if the property is loaded.

isChangedProperty

public boolean isChangedProperty(int propertyIndex)

Return true if the property is considered changed.

isDirtyProperty

public boolean isDirtyProperty(int propertyIndex)

Return true if the property was changed or if it is embedded and one of its embedded properties is dirty.

markPropertyAsChanged

public void markPropertyAsChanged(int propertyIndex)

Explicitly mark a property as having been changed.

setChangedProperty

public void setChangedProperty(int propertyIndex)

setNewBeanForUpdate

public void setNewBeanForUpdate()

For forced update on a 'New' bean set all the loaded properties to changed.

getLoadedPropertyNames

public Set<String> getLoadedPropertyNames()

Return the set of property names for a partially loaded bean.

getDirtyProperties

public boolean[] getDirtyProperties()

Return the array of flags indicating the dirty properties.

getDirtyPropertyNames

public Set<String> getDirtyPropertyNames()

Return the set of dirty properties.

addDirtyPropertyNames

public void addDirtyPropertyNames(Set<String> props,
                                  String prefix)

Recursively add dirty properties.

hasDirtyProperty

public boolean hasDirtyProperty(Set<String> propertyNames)

Return true if any of the given property names are dirty.

getDirtyValues

public Map<String,ValuePair> getDirtyValues()

Return a map of dirty properties with their new and old values.

addDirtyPropertyValues

public void addDirtyPropertyValues(Map<String,ValuePair> dirtyValues,
                                   String prefix)

Recursively add dirty properties.

getDirtyPropertyHash

public int getDirtyPropertyHash()

Return a dirty property hash taking into account embedded beans.

addDirtyPropertyHash

public int addDirtyPropertyHash(int hash)

Add and return a dirty property hash recursing into embedded beans.

getLoadedPropertyHash

public int getLoadedPropertyHash()

Return a loaded property hash.

getChanged

public boolean[] getChanged()

Return the set of property names for changed properties.

getLoaded

public boolean[] getLoaded()

getLazyLoadPropertyIndex

public int getLazyLoadPropertyIndex()

Return the index of the property that triggered the lazy load.

getLazyLoadProperty

public String getLazyLoadProperty()

Return the property that triggered the lazy load.

loadBean

protected void loadBean(int loadProperty)

Load the bean when it is a reference.

areEqual

protected boolean areEqual(Object obj1,
                           Object obj2)

Helper method to check if two objects are equal.

initialisedMany

public void initialisedMany(int propertyIndex)

Called when a BeanCollection is initialised automatically.

preGetter

public void preGetter(int propertyIndex)

Method that is called prior to a getter method on the actual entity.

postSetter

public void postSetter(PropertyChangeEvent event)

Called for "enhancement" postSetter processing. This is around a PUTFIELD so no need to check the newValue afterwards.

postSetter

public void postSetter(PropertyChangeEvent event,
                       Object newValue)

Called for "subclassed" postSetter processing. Here the newValue has to be re-fetched (and passed into this method) in case there is code inside the setter that further mutates the value.

preSetterMany

public PropertyChangeEvent preSetterMany(boolean interceptField,
                                         int propertyIndex,
                                         Object oldValue,
                                         Object newValue)

OneToMany and ManyToMany don't have any interception so just check for PropertyChangeSupport.

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     Object oldValue,
                                     Object newValue)

Check to see if the values are not equal. If they are not equal then create the old values for use with ConcurrencyMode.ALL.

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     boolean oldValue,
                                     boolean newValue)

Check for primitive boolean.

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     int oldValue,
                                     int newValue)

Check for primitive int.

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     long oldValue,
                                     long newValue)

long.

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     double oldValue,
                                     double newValue)

double.

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     float oldValue,
                                     float newValue)

float.

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     short oldValue,
                                     short newValue)

short.

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     char oldValue,
                                     char newValue)

char.

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     byte oldValue,
                                     byte newValue)

byte.

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     char[] oldValue,
                                     char[] newValue)

char[].

preSetter

public PropertyChangeEvent preSetter(boolean intercept,
                                     int propertyIndex,
                                     byte[] oldValue,
                                     byte[] newValue)

byte[].