com.avaje.ebean.common

Class AbstractBeanCollection<E>

java.lang.Object

com.avaje.ebean.common.AbstractBeanCollection<E>

All Implemented Interfaces:

BeanCollection<E>, Serializable

Direct Known Subclasses:

BeanList, BeanMap, BeanSet

public abstract class AbstractBeanCollection<E>
extends Object
implements BeanCollection<E>

Base class for List Set and Map implementations of BeanCollection.

Author:

rbygrave

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.avaje.ebean.bean.BeanCollection

BeanCollection.ModifyListenMode

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	disableLazyLoad
protected String	ebeanServerName
protected ExpressionList<?>	filterMany
protected BeanCollectionLoader	loader The EbeanServer this is associated with.
protected boolean	modifyAddListening
protected com.avaje.ebean.common.ModifyHolder<E>	modifyHolder
protected boolean	modifyListening
protected BeanCollection.ModifyListenMode	modifyListenMode
protected boolean	modifyRemoveListening
protected EntityBean	ownerBean The owning bean (used for lazy fetch).
protected String	propertyName The name of this property in the owning bean (used for lazy fetch).
protected boolean	readOnly
protected boolean	registeredWithLoadContext Flag set when registered with the batch loading context.

Constructor Summary

Constructors

Constructor and Description
AbstractBeanCollection() Constructor not non-lazy loading collection.
AbstractBeanCollection(BeanCollectionLoader loader, EntityBean ownerBean, String propertyName) Used to create deferred fetch proxy.

Method Summary

Modifier and Type	Method and Description
protected void	checkReadOnly()
ExpressionList<?>	getFilterMany() Return the filter (if any) that was used in building this collection.
Set<E>	getModifyAdditions() Return the list of objects added to the list set or map.
protected com.avaje.ebean.common.ModifyHolder<E>	getModifyHolder()
BeanCollection.ModifyListenMode	getModifyListenMode() Return the modify listening mode this collection is using.
Set<E>	getModifyRemovals() Return the list of objects removed from the list set or map.
EntityBean	getOwnerBean() Return the bean that owns this collection.
String	getPropertyName() Return the bean property name this collection represents.
boolean	holdsModifications() Return true if there are underlying additions or removals.
boolean	isReadOnly() Return true if the collection should be treated as readOnly and no elements can be added or removed etc.
boolean	isRegisteredWithLoadContext() Return true if the collection has been registered with the batch loading context.
protected void	lazyLoadCollection(boolean onlyIds)
void	modifyAddition(E bean) Add an object to the additions list.
void	modifyRemoval(Object bean) Add an object to the deletions list.
void	modifyReset() Reset the set of additions and deletions.
void	setDisableLazyLoad(boolean disableLazyLoad) Set the disableLazyLoad state.
void	setFilterMany(ExpressionList<?> filterMany) Set the filter that was used in building this collection.
void	setLoader(BeanCollectionLoader loader) Set the loader that will be used to lazy/query load this collection.
void	setModifyListening(BeanCollection.ModifyListenMode mode) set modifyListening to be on or off.
void	setReadOnly(boolean readOnly) Set to true if you want the BeanCollection to be treated as read only.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.avaje.ebean.bean.BeanCollection

addBean, checkEmptyLazyLoad, getActualDetails, getActualEntries, internalAdd, internalAddWithCheck, isEmpty, isPopulated, isReference, isSkipSave, loadFrom, removeBean, reset, size

Field Detail

readOnly

protected boolean readOnly

disableLazyLoad

protected boolean disableLazyLoad

loader

protected transient BeanCollectionLoader loader

The EbeanServer this is associated with. (used for lazy fetch).

filterMany

protected transient ExpressionList<?> filterMany

registeredWithLoadContext

protected boolean registeredWithLoadContext

Flag set when registered with the batch loading context.

ebeanServerName

protected String ebeanServerName

ownerBean

protected EntityBean ownerBean

The owning bean (used for lazy fetch).

propertyName

protected String propertyName

The name of this property in the owning bean (used for lazy fetch).

modifyHolder

protected com.avaje.ebean.common.ModifyHolder<E> modifyHolder

modifyListenMode

protected BeanCollection.ModifyListenMode modifyListenMode

modifyAddListening

protected boolean modifyAddListening

modifyRemoveListening

protected boolean modifyRemoveListening

modifyListening

protected boolean modifyListening

Constructor Detail

AbstractBeanCollection

public AbstractBeanCollection()

Constructor not non-lazy loading collection.

AbstractBeanCollection

public AbstractBeanCollection(BeanCollectionLoader loader,
                              EntityBean ownerBean,
                              String propertyName)

Used to create deferred fetch proxy.

Method Detail

getOwnerBean

public EntityBean getOwnerBean()

Description copied from interface: BeanCollection

Return the bean that owns this collection.

Specified by:

getOwnerBean in interface BeanCollection<E>

getPropertyName

public String getPropertyName()

Description copied from interface: BeanCollection

Return the bean property name this collection represents.

Specified by:

getPropertyName in interface BeanCollection<E>

getFilterMany

public ExpressionList<?> getFilterMany()

Description copied from interface: BeanCollection

Return the filter (if any) that was used in building this collection.

This is so that the filter can be applied on refresh.

Specified by:

getFilterMany in interface BeanCollection<E>

setFilterMany

public void setFilterMany(ExpressionList<?> filterMany)

Description copied from interface: BeanCollection

Set the filter that was used in building this collection.

Specified by:

setFilterMany in interface BeanCollection<E>

setDisableLazyLoad

public void setDisableLazyLoad(boolean disableLazyLoad)

Description copied from interface: BeanCollection

Set the disableLazyLoad state.

Specified by:

setDisableLazyLoad in interface BeanCollection<E>

lazyLoadCollection

protected void lazyLoadCollection(boolean onlyIds)

isRegisteredWithLoadContext

public boolean isRegisteredWithLoadContext()

Description copied from interface: BeanCollection

Return true if the collection has been registered with the batch loading context.

Specified by:

isRegisteredWithLoadContext in interface BeanCollection<E>

setLoader

public void setLoader(BeanCollectionLoader loader)

Description copied from interface: BeanCollection

Set the loader that will be used to lazy/query load this collection.

This is effectively the batch loading context this collection is registered with.

Specified by:

setLoader in interface BeanCollection<E>

isReadOnly

public boolean isReadOnly()

Description copied from interface: BeanCollection

Return true if the collection should be treated as readOnly and no elements can be added or removed etc.

Specified by:

isReadOnly in interface BeanCollection<E>

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: BeanCollection

Set to true if you want the BeanCollection to be treated as read only. This means no elements can be added or removed etc.

Specified by:

setReadOnly in interface BeanCollection<E>

checkReadOnly

protected void checkReadOnly()

setModifyListening

public void setModifyListening(BeanCollection.ModifyListenMode mode)

set modifyListening to be on or off.

Specified by:

setModifyListening in interface BeanCollection<E>

getModifyListenMode

public BeanCollection.ModifyListenMode getModifyListenMode()

Return the modify listening mode this collection is using.

getModifyHolder

protected com.avaje.ebean.common.ModifyHolder<E> getModifyHolder()

modifyAddition

public void modifyAddition(E bean)

Description copied from interface: BeanCollection

Add an object to the additions list.

This will potentially end up as an insert into a intersection table for a ManyToMany.

Specified by:

modifyAddition in interface BeanCollection<E>

modifyRemoval

public void modifyRemoval(Object bean)

Description copied from interface: BeanCollection

Add an object to the deletions list.

This will potentially end up as an delete from an intersection table for a ManyToMany.

Specified by:

modifyRemoval in interface BeanCollection<E>

modifyReset

public void modifyReset()

Description copied from interface: BeanCollection

Reset the set of additions and deletions. This is called after the additions and removals have been processed.

Specified by:

modifyReset in interface BeanCollection<E>

getModifyAdditions

public Set<E> getModifyAdditions()

Description copied from interface: BeanCollection

Return the list of objects added to the list set or map. These will used to insert rows into the intersection table of a ManyToMany.

Specified by:

getModifyAdditions in interface BeanCollection<E>

getModifyRemovals

public Set<E> getModifyRemovals()

Description copied from interface: BeanCollection

Return the list of objects removed from the list set or map. These will used to delete rows from the intersection table of a ManyToMany.

Specified by:

getModifyRemovals in interface BeanCollection<E>

holdsModifications

public boolean holdsModifications()

Return true if there are underlying additions or removals.