de.mhus.lib.vaadin.container

Class MhuAbstractBeanContainer<IDTYPE,BEANTYPE>

java.lang.Object

com.vaadin.data.util.AbstractContainer

com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

de.mhus.lib.vaadin.container.MhuAbstractBeanContainer<IDTYPE,BEANTYPE>

Type Parameters:

IDTYPE - The type of the item identifier

BEANTYPE - The type of the Bean

All Implemented Interfaces:

com.vaadin.data.Container, com.vaadin.data.Container.Filterable, com.vaadin.data.Container.Indexed, com.vaadin.data.Container.ItemSetChangeNotifier, com.vaadin.data.Container.Ordered, com.vaadin.data.Container.PropertySetChangeNotifier, com.vaadin.data.Container.SimpleFilterable, com.vaadin.data.Container.Sortable, com.vaadin.data.Property.ValueChangeListener, Serializable

Direct Known Subclasses:

MhuBeanItemContainer

public abstract class MhuAbstractBeanContainer<IDTYPE,BEANTYPE>
extends com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>
implements com.vaadin.data.Container.Filterable, com.vaadin.data.Container.SimpleFilterable, com.vaadin.data.Container.Sortable, com.vaadin.data.Property.ValueChangeListener, com.vaadin.data.Container.PropertySetChangeNotifier

An abstract base class for in-memory containers for JavaBeans.

The properties of the container are determined automatically by introspecting the used JavaBean class and explicitly adding or removing properties is not supported. Only beans of the same type can be added to the container.

Subclasses should implement any public methods adding items to the container, typically calling the protected methods addItem(Object, Object), addItemAfter(Object, Object, Object) and addItemAt(int, Object, Object).

Since:

6.5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MhuAbstractBeanContainer.BeanIdResolver<IDTYPE,BEANTYPE> Resolver that maps beans to their (item) identifiers, removing the need to explicitly specify item identifiers when there is no need to customize this.
protected class	MhuAbstractBeanContainer.PropertyBasedBeanIdResolver A item identifier resolver that returns the value of a bean property.

Nested classes/interfaces inherited from class com.vaadin.data.util.AbstractContainer

com.vaadin.data.util.AbstractContainer.BaseItemSetChangeEvent, com.vaadin.data.util.AbstractContainer.BasePropertySetChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Container

com.vaadin.data.Container.Editor, com.vaadin.data.Container.Filter, com.vaadin.data.Container.Filterable, com.vaadin.data.Container.Hierarchical, com.vaadin.data.Container.Indexed, com.vaadin.data.Container.ItemSetChangeEvent, com.vaadin.data.Container.ItemSetChangeListener, com.vaadin.data.Container.ItemSetChangeNotifier, com.vaadin.data.Container.Ordered, com.vaadin.data.Container.PropertySetChangeEvent, com.vaadin.data.Container.PropertySetChangeListener, com.vaadin.data.Container.PropertySetChangeNotifier, com.vaadin.data.Container.SimpleFilterable, com.vaadin.data.Container.Sortable, com.vaadin.data.Container.Viewer

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedHashMap<String,MhuBeanItem.PojoPropertyDescriptor<BEANTYPE>>	model A description of the properties found in beans of type type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MhuAbstractBeanContainer(Class<? super BEANTYPE> type) Constructs a AbstractBeanContainer for beans of the given type.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAll(Collection<? extends BEANTYPE> collection) Adds all the beans from a Collection in one operation using the bean item identifier resolver.
protected MhuBeanItem<BEANTYPE>	addBean(BEANTYPE bean) Adds a bean to the container using the bean item id resolver to find its identifier.
protected MhuBeanItem<BEANTYPE>	addBeanAfter(IDTYPE previousItemId, BEANTYPE bean) Adds a bean to the container after a specified item identifier, using the bean item id resolver to find its identifier.
protected MhuBeanItem<BEANTYPE>	addBeanAt(int index, BEANTYPE bean) Adds a bean at a specified (filtered view) position in the container using the bean item id resolver to find its identifier.
void	addContainerFilter(com.vaadin.data.Container.Filter filter)
void	addContainerFilter(Object propertyId, String filterString, boolean ignoreCase, boolean onlyMatchPrefix)
boolean	addContainerProperty(Object propertyId, Class<?> type, Object defaultValue)
protected MhuBeanItem<BEANTYPE>	addItem(IDTYPE itemId, BEANTYPE bean) Adds the bean to the Container.
protected MhuBeanItem<BEANTYPE>	addItemAfter(IDTYPE previousItemId, IDTYPE newItemId, BEANTYPE bean) Adds the bean after the given bean.
protected MhuBeanItem<BEANTYPE>	addItemAt(int index, IDTYPE newItemId, BEANTYPE bean) Adds a new bean at the given index.
void	addListener(com.vaadin.data.Container.PropertySetChangeListener listener) Deprecated. As of 7.0, replaced by addPropertySetChangeListener(com.vaadin.data.Container.PropertySetChangeListener)
void	addPropertySetChangeListener(com.vaadin.data.Container.PropertySetChangeListener listener)
protected MhuBeanItem<BEANTYPE>	createBeanItem(BEANTYPE bean) Create a BeanItem for a bean using pre-parsed bean metadata (based on getBeanType()).
protected MhuAbstractBeanContainer.BeanIdResolver<IDTYPE,BEANTYPE>	createBeanPropertyResolver(Object propertyId) Create an item identifier resolver using a named bean property.
MhuAbstractBeanContainer.BeanIdResolver<IDTYPE,BEANTYPE>	getBeanIdResolver() Returns the resolver that finds the item ID for a bean.
Class<? super BEANTYPE>	getBeanType() Returns the type of beans this Container can contain.
Collection<com.vaadin.data.Container.Filter>	getContainerFilters()
com.vaadin.data.Property	getContainerProperty(Object itemId, Object propertyId)
Collection<String>	getContainerPropertyIds()
MhuBeanItem<BEANTYPE>	getItem(Object itemId)
List<IDTYPE>	getItemIds()
com.vaadin.data.util.ItemSorter	getItemSorter()
Collection<?>	getSortableContainerPropertyIds()
Class<?>	getType(Object propertyId)
protected MhuBeanItem<BEANTYPE>	getUnfilteredItem(Object itemId)
boolean	hasContainerFilters()
protected boolean	mergeAll(Collection<? extends BEANTYPE> collection, boolean removeOverlapping, Comparator<IDTYPE> comparator) Merge all the beans from a Collection in one operation using the bean item identifier resolver.
protected void	registerNewItem(int position, IDTYPE itemId, MhuBeanItem<BEANTYPE> item)
void	removeAllContainerFilters()
boolean	removeAllItems()
void	removeContainerFilter(com.vaadin.data.Container.Filter filter)
void	removeContainerFilters(Object propertyId)
boolean	removeItem(Object itemId)
void	removeListener(com.vaadin.data.Container.PropertySetChangeListener listener) Deprecated. As of 7.0, replaced by removePropertySetChangeListener(com.vaadin.data.Container.PropertySetChangeListener)
void	removePropertySetChangeListener(com.vaadin.data.Container.PropertySetChangeListener listener)
protected IDTYPE	resolveBeanId(BEANTYPE bean) Use the bean resolver to get the identifier for a bean.
protected void	setBeanIdResolver(MhuAbstractBeanContainer.BeanIdResolver<IDTYPE,BEANTYPE> beanIdResolver) Sets the resolver that finds the item id for a bean, or null not to use automatic resolving.
void	setItemSorter(com.vaadin.data.util.ItemSorter itemSorter)
void	sort(Object[] propertyId, boolean[] ascending)
void	valueChange(com.vaadin.data.Property.ValueChangeEvent event) Re-filter the container when one of the monitored properties changes.

Methods inherited from class com.vaadin.data.util.AbstractInMemoryContainer

addFilter, addItem, addItem, addItemAfter, addItemAfter, addItemAt, addItemAt, addItemSetChangeListener, addListener, containsId, doFilterContainer, doSort, filterAll, fireItemAdded, fireItemRemoved, firstItemId, getAllItemIds, getFilteredItemIds, getFilters, getIdByIndex, getItemIds, getSortablePropertyIds, getVisibleItemIds, indexOfId, internalAddItemAfter, internalAddItemAt, internalAddItemAtEnd, internalRemoveAllItems, internalRemoveItem, isFiltered, isFirstId, isLastId, isPropertyFiltered, lastItemId, nextItemId, passesFilters, prevItemId, removeAllFilters, removeContainerProperty, removeFilter, removeFilters, removeItemSetChangeListener, removeListener, setAllItemIds, setFilteredItemIds, setFilters, size, sortContainer

Methods inherited from class com.vaadin.data.util.AbstractContainer

fireContainerPropertySetChange, fireContainerPropertySetChange, fireItemSetChange, fireItemSetChange, getItemSetChangeListeners, getListeners, getPropertySetChangeListeners, setItemSetChangeListeners, setPropertySetChangeListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.data.Container.Ordered

addItemAfter, addItemAfter, firstItemId, isFirstId, isLastId, lastItemId, nextItemId, prevItemId

Methods inherited from interface com.vaadin.data.Container

addItem, addItem, containsId, removeContainerProperty, size

Field Detail

model

protected LinkedHashMap<String,MhuBeanItem.PojoPropertyDescriptor<BEANTYPE>> model

A description of the properties found in beans of type type. Determines the property ids that are present in the container.

Constructor Detail

MhuAbstractBeanContainer

protected MhuAbstractBeanContainer(Class<? super BEANTYPE> type)

Constructs a AbstractBeanContainer for beans of the given type.

Parameters:

type - the type of the beans that will be added to the container.

Throws:

IllegalArgumentException - If type is null

Method Detail

getType

public Class<?> getType(Object propertyId)

Specified by:

getType in interface com.vaadin.data.Container

createBeanItem

protected MhuBeanItem<BEANTYPE> createBeanItem(BEANTYPE bean)

Create a BeanItem for a bean using pre-parsed bean metadata (based on getBeanType()).

Parameters:

bean -

Returns:

created MhuBeanItem or null if bean is null

getBeanType

public Class<? super BEANTYPE> getBeanType()

Returns the type of beans this Container can contain. This comes from the bean type constructor parameter, and bean metadata (including container properties) is based on this.

Returns:

getContainerPropertyIds

public Collection<String> getContainerPropertyIds()

Specified by:

getContainerPropertyIds in interface com.vaadin.data.Container

removeAllItems

public boolean removeAllItems()

Specified by:

removeAllItems in interface com.vaadin.data.Container

Overrides:

removeAllItems in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

getItem

public MhuBeanItem<BEANTYPE> getItem(Object itemId)

Specified by:

getItem in interface com.vaadin.data.Container

Overrides:

getItem in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

getUnfilteredItem

protected MhuBeanItem<BEANTYPE> getUnfilteredItem(Object itemId)

Specified by:

getUnfilteredItem in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

getItemIds

public List<IDTYPE> getItemIds()

Specified by:

getItemIds in interface com.vaadin.data.Container

Overrides:

getItemIds in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

getContainerProperty

public com.vaadin.data.Property getContainerProperty(Object itemId,
                                            Object propertyId)

Specified by:

getContainerProperty in interface com.vaadin.data.Container

removeItem

public boolean removeItem(Object itemId)

Specified by:

removeItem in interface com.vaadin.data.Container

Overrides:

removeItem in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

valueChange

public void valueChange(com.vaadin.data.Property.ValueChangeEvent event)

Re-filter the container when one of the monitored properties changes.

Specified by:

valueChange in interface com.vaadin.data.Property.ValueChangeListener

addContainerFilter

public void addContainerFilter(Object propertyId,
                      String filterString,
                      boolean ignoreCase,
                      boolean onlyMatchPrefix)

Specified by:

addContainerFilter in interface com.vaadin.data.Container.SimpleFilterable

removeAllContainerFilters

public void removeAllContainerFilters()

Specified by:

removeAllContainerFilters in interface com.vaadin.data.Container.Filterable

Specified by:

removeAllContainerFilters in interface com.vaadin.data.Container.SimpleFilterable

removeContainerFilters

public void removeContainerFilters(Object propertyId)

Specified by:

removeContainerFilters in interface com.vaadin.data.Container.SimpleFilterable

addContainerFilter

public void addContainerFilter(com.vaadin.data.Container.Filter filter)
                        throws com.vaadin.data.util.filter.UnsupportedFilterException

Specified by:

addContainerFilter in interface com.vaadin.data.Container.Filterable

Throws:

com.vaadin.data.util.filter.UnsupportedFilterException

removeContainerFilter

public void removeContainerFilter(com.vaadin.data.Container.Filter filter)

Specified by:

removeContainerFilter in interface com.vaadin.data.Container.Filterable

hasContainerFilters

public boolean hasContainerFilters()

Overrides:

hasContainerFilters in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

getContainerFilters

public Collection<com.vaadin.data.Container.Filter> getContainerFilters()

Specified by:

getContainerFilters in interface com.vaadin.data.Container.Filterable

Overrides:

getContainerFilters in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

getSortableContainerPropertyIds

public Collection<?> getSortableContainerPropertyIds()

Specified by:

getSortableContainerPropertyIds in interface com.vaadin.data.Container.Sortable

sort

public void sort(Object[] propertyId,
        boolean[] ascending)

Specified by:

sort in interface com.vaadin.data.Container.Sortable

getItemSorter

public com.vaadin.data.util.ItemSorter getItemSorter()

Overrides:

getItemSorter in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

setItemSorter

public void setItemSorter(com.vaadin.data.util.ItemSorter itemSorter)

Overrides:

setItemSorter in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

registerNewItem

protected void registerNewItem(int position,
                   IDTYPE itemId,
                   MhuBeanItem<BEANTYPE> item)

Overrides:

registerNewItem in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

addItem

protected MhuBeanItem<BEANTYPE> addItem(IDTYPE itemId,
                            BEANTYPE bean)

Adds the bean to the Container. Note: the behavior of this method changed in Vaadin 6.6 - now items are added at the very end of the unfiltered container and not after the last visible item if filtering is used.

See Also:

Container.addItem(Object)

addItemAfter

protected MhuBeanItem<BEANTYPE> addItemAfter(IDTYPE previousItemId,
                                 IDTYPE newItemId,
                                 BEANTYPE bean)

Adds the bean after the given bean.

See Also:

Container.Ordered.addItemAfter(Object, Object)

addItemAt

protected MhuBeanItem<BEANTYPE> addItemAt(int index,
                              IDTYPE newItemId,
                              BEANTYPE bean)

Adds a new bean at the given index. The bean is used both as the item contents and as the item identifier.

Parameters:

index - Index at which the bean should be added.

newItemId - The item id for the bean to add to the container.

bean - The bean to add to the container.

Returns:

Returns the new BeanItem or null if the operation fails.

addBean

protected MhuBeanItem<BEANTYPE> addBean(BEANTYPE bean)
                                 throws IllegalStateException,
                                        IllegalArgumentException

Adds a bean to the container using the bean item id resolver to find its identifier. A bean id resolver must be set before calling this method.

Parameters:

bean - the bean to add

Returns:

BeanItem item added or null

Throws:

IllegalStateException - if no bean identifier resolver has been set

IllegalArgumentException - if an identifier cannot be resolved for the bean

See Also:

addItem(Object, Object)

addBeanAfter

protected MhuBeanItem<BEANTYPE> addBeanAfter(IDTYPE previousItemId,
                                 BEANTYPE bean)
                                      throws IllegalStateException,
                                             IllegalArgumentException

Adds a bean to the container after a specified item identifier, using the bean item id resolver to find its identifier. A bean id resolver must be set before calling this method.

Parameters:

previousItemId - the identifier of the bean after which this bean should be added, null to add to the beginning

bean - the bean to add

Returns:

BeanItem item added or null

Throws:

IllegalStateException - if no bean identifier resolver has been set

IllegalArgumentException - if an identifier cannot be resolved for the bean

See Also:

addItemAfter(Object, Object, Object)

addBeanAt

protected MhuBeanItem<BEANTYPE> addBeanAt(int index,
                              BEANTYPE bean)
                                   throws IllegalStateException,
                                          IllegalArgumentException

Adds a bean at a specified (filtered view) position in the container using the bean item id resolver to find its identifier. A bean id resolver must be set before calling this method.

Parameters:

index - the index (in the filtered view) at which to add the item

bean - the bean to add

Returns:

BeanItem item added or null

Throws:

IllegalStateException - if no bean identifier resolver has been set

IllegalArgumentException - if an identifier cannot be resolved for the bean

See Also:

addItemAfter(Object, Object, Object)

addAll

protected void addAll(Collection<? extends BEANTYPE> collection)
               throws IllegalStateException,
                      IllegalArgumentException

Adds all the beans from a Collection in one operation using the bean item identifier resolver. More efficient than adding them one by one. A bean id resolver must be set before calling this method. Note: the behavior of this method changed in Vaadin 6.6 - now items are added at the very end of the unfiltered container and not after the last visible item if filtering is used.

Parameters:

collection - The collection of beans to add. Must not be null.

Throws:

IllegalStateException - if no bean identifier resolver has been set

IllegalArgumentException - if the resolver returns a null itemId for one of the beans in the collection

resolveBeanId

protected IDTYPE resolveBeanId(BEANTYPE bean)

Use the bean resolver to get the identifier for a bean.

Parameters:

bean -

Returns:

resolved bean identifier, null if could not be resolved

Throws:

IllegalStateException - if no bean resolver is set

setBeanIdResolver

protected void setBeanIdResolver(MhuAbstractBeanContainer.BeanIdResolver<IDTYPE,BEANTYPE> beanIdResolver)

Sets the resolver that finds the item id for a bean, or null not to use automatic resolving. Methods that add a bean without specifying an id must not be called if no resolver has been set. Note that methods taking an explicit id can be used whether a resolver has been defined or not.

Parameters:

beanIdResolver - to use or null to disable automatic id resolution

getBeanIdResolver

public MhuAbstractBeanContainer.BeanIdResolver<IDTYPE,BEANTYPE> getBeanIdResolver()

Returns the resolver that finds the item ID for a bean.

Returns:

resolver used or null if automatic item id resolving is disabled

createBeanPropertyResolver

protected MhuAbstractBeanContainer.BeanIdResolver<IDTYPE,BEANTYPE> createBeanPropertyResolver(Object propertyId)

Create an item identifier resolver using a named bean property.

Parameters:

propertyId - property identifier, which must map to a getter in BEANTYPE

Returns:

created resolver

addListener

@Deprecated
public void addListener(com.vaadin.data.Container.PropertySetChangeListener listener)

Deprecated. As of 7.0, replaced by addPropertySetChangeListener(com.vaadin.data.Container.PropertySetChangeListener)

Specified by:

addListener in interface com.vaadin.data.Container.PropertySetChangeNotifier

Overrides:

addListener in class com.vaadin.data.util.AbstractContainer

addPropertySetChangeListener

public void addPropertySetChangeListener(com.vaadin.data.Container.PropertySetChangeListener listener)

Specified by:

addPropertySetChangeListener in interface com.vaadin.data.Container.PropertySetChangeNotifier

Overrides:

addPropertySetChangeListener in class com.vaadin.data.util.AbstractContainer

removeListener

@Deprecated
public void removeListener(com.vaadin.data.Container.PropertySetChangeListener listener)

Deprecated. As of 7.0, replaced by removePropertySetChangeListener(com.vaadin.data.Container.PropertySetChangeListener)

Specified by:

removeListener in interface com.vaadin.data.Container.PropertySetChangeNotifier

Overrides:

removeListener in class com.vaadin.data.util.AbstractContainer

removePropertySetChangeListener

public void removePropertySetChangeListener(com.vaadin.data.Container.PropertySetChangeListener listener)

Specified by:

removePropertySetChangeListener in interface com.vaadin.data.Container.PropertySetChangeNotifier

Overrides:

removePropertySetChangeListener in class com.vaadin.data.util.AbstractContainer

addContainerProperty

public boolean addContainerProperty(Object propertyId,
                           Class<?> type,
                           Object defaultValue)
                             throws UnsupportedOperationException

Specified by:

addContainerProperty in interface com.vaadin.data.Container

Overrides:

addContainerProperty in class com.vaadin.data.util.AbstractInMemoryContainer<IDTYPE,String,MhuBeanItem<BEANTYPE>>

Throws:

UnsupportedOperationException

mergeAll

protected boolean mergeAll(Collection<? extends BEANTYPE> collection,
               boolean removeOverlapping,
               Comparator<IDTYPE> comparator)
                    throws IllegalStateException,
                           IllegalArgumentException

Merge all the beans from a Collection in one operation using the bean item identifier resolver. A bean id resolver must be set before calling this method.

Parameters:

collection - The collection of beans to add. Must not be null.

removeOverlapping - Remove beans out of the list which not included in the collection.

comparator - Comparator to compare bean ids. Can be null to use default and maybe faster contains() method.

Returns:

true if the list was modified by the merge

Throws:

IllegalStateException - if no bean identifier resolver has been set

IllegalArgumentException - if the resolver returns a null itemId for one of the beans in the collection