de.mhus.lib.vaadin.container

Class MhuBeanItemContainer<BEANTYPE>

java.lang.Object

com.vaadin.data.util.AbstractContainer

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

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

de.mhus.lib.vaadin.container.MhuBeanItemContainer<BEANTYPE>

Type Parameters:

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

public class MhuBeanItemContainer<BEANTYPE>
extends MhuAbstractBeanContainer<BEANTYPE,BEANTYPE>

An in-memory container for JavaBeans.

The properties of the container are determined automatically by introspecting the used JavaBean class. Only beans of the same type can be added to the container.

BeanItemContainer uses the beans themselves as identifiers. The Object.hashCode() of a bean is used when storing and looking up beans so it must not change during the lifetime of the bean (it should not depend on any part of the bean that can be modified). Typically this restricts the implementation of Object.equals(Object) as well in order for it to fulfill the contract between equals() and hashCode().

To add items to the container, use the methods addBean(Object), MhuAbstractBeanContainer.addBeanAfter(Object, Object) and MhuAbstractBeanContainer.addBeanAt(int, Object). Also addItem(Object), addItemAfter(Object, Object) and addItemAt(int, Object) can be used as synonyms for them.

It is not possible to add additional properties to the container.

Since:

5.4

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.mhus.lib.vaadin.container.MhuAbstractBeanContainer

MhuAbstractBeanContainer.BeanIdResolver<IDTYPE,BEANTYPE>, MhuAbstractBeanContainer.PropertyBasedBeanIdResolver

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 inherited from class de.mhus.lib.vaadin.container.MhuAbstractBeanContainer

model

Constructor Summary

Constructors

Constructor and Description
MhuBeanItemContainer(Class<? super BEANTYPE> type) Constructs a BeanItemContainer for beans of the given type.
MhuBeanItemContainer(Class<? super BEANTYPE> type, Collection<? extends BEANTYPE> collection) Constructs a BeanItemContainer and adds the given beans to it.
MhuBeanItemContainer(Collection<? extends BEANTYPE> collection) Deprecated. As of 6.5, use #BeanItemContainer(Class, Collection) instead

Method Summary

Methods

Modifier and Type	Method and Description
void	addAll(Collection<? extends BEANTYPE> collection) Adds all the beans from a Collection in one go.
MhuBeanItem<BEANTYPE>	addBean(BEANTYPE bean) Adds the bean to the Container.
MhuBeanItem<BEANTYPE>	addItem(Object itemId) Adds the bean to the Container.
MhuBeanItem<BEANTYPE>	addItemAfter(Object previousItemId, Object newItemId) Adds the bean after the given bean.
MhuBeanItem<BEANTYPE>	addItemAt(int index, Object newItemId) Adds a new bean at the given index.
void	configureTableByAnnotations(com.vaadin.ui.Table table, String schema, de.mhus.lib.core.util.MNls nls)
static com.vaadin.ui.Table.Align	mapToVaadin(de.mhus.lib.annotations.vaadin.Align align)
boolean	mergeAll(Collection<? extends BEANTYPE> collection, boolean remove, Comparator<BEANTYPE> comparator) Merge all the beans from a Collection in one operation using the bean item identifier resolver.
void	refresh()
protected void	setBeanIdResolver(MhuAbstractBeanContainer.BeanIdResolver<BEANTYPE,BEANTYPE> beanIdResolver) Unsupported in BeanItemContainer.

Methods inherited from class de.mhus.lib.vaadin.container.MhuAbstractBeanContainer

addBeanAfter, addBeanAt, addContainerFilter, addContainerFilter, addContainerProperty, addItem, addItemAfter, addItemAt, addListener, addPropertySetChangeListener, createBeanItem, createBeanPropertyResolver, getBeanIdResolver, getBeanType, getContainerFilters, getContainerProperty, getContainerPropertyIds, getItem, getItemIds, getItemSorter, getSortableContainerPropertyIds, getType, getUnfilteredItem, hasContainerFilters, registerNewItem, removeAllContainerFilters, removeAllItems, removeContainerFilter, removeContainerFilters, removeItem, removeListener, removePropertySetChangeListener, resolveBeanId, setItemSorter, sort, valueChange

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

addFilter, addItem, addItemAfter, 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, firstItemId, isFirstId, isLastId, lastItemId, nextItemId, prevItemId

Methods inherited from interface com.vaadin.data.Container

addItem, containsId, removeContainerProperty, size

Constructor Detail

MhuBeanItemContainer

public MhuBeanItemContainer(Class<? super BEANTYPE> type)
                     throws IllegalArgumentException

Constructs a BeanItemContainer 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

MhuBeanItemContainer

@Deprecated
public MhuBeanItemContainer(Collection<? extends BEANTYPE> collection)
                     throws IllegalArgumentException

Deprecated. As of 6.5, use #BeanItemContainer(Class, Collection) instead

Constructs a BeanItemContainer and adds the given beans to it. The collection must not be empty. MhuBeanItemContainer#BeanItemContainer(Class) can be used for creating an initially empty BeanItemContainer. Note that when using this constructor, the actual class of the first item in the collection is used to determine the bean properties supported by the container instance, and only beans of that class or its subclasses can be added to the collection. If this is problematic or empty collections need to be supported, use #BeanItemContainer(Class) and addAll(Collection) instead.

Parameters:

collection - a non empty Collection of beans.

Throws:

IllegalArgumentException - If the collection is null or empty.

MhuBeanItemContainer

public MhuBeanItemContainer(Class<? super BEANTYPE> type,
                    Collection<? extends BEANTYPE> collection)
                     throws IllegalArgumentException

Constructs a BeanItemContainer and adds the given beans to it.

Parameters:

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

collection - a Collection of beans (can be empty or null).

Throws:

IllegalArgumentException - If type is null

Method Detail

refresh

public void refresh()

configureTableByAnnotations

public void configureTableByAnnotations(com.vaadin.ui.Table table,
                               String schema,
                               de.mhus.lib.core.util.MNls nls)

mapToVaadin

public static com.vaadin.ui.Table.Align mapToVaadin(de.mhus.lib.annotations.vaadin.Align align)

addAll

public void addAll(Collection<? extends BEANTYPE> collection)

Adds all the beans from a Collection in one go. More efficient than adding them one by one.

Overrides:

addAll in class MhuAbstractBeanContainer<BEANTYPE,BEANTYPE>

Parameters:

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

addItemAfter

public MhuBeanItem<BEANTYPE> addItemAfter(Object previousItemId,
                                 Object newItemId)
                                   throws IllegalArgumentException

Adds the bean after the given bean. The bean is used both as the item contents and as the item identifier.

Specified by:

addItemAfter in interface com.vaadin.data.Container.Ordered

Overrides:

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

Parameters:

previousItemId - the bean (of type BT) after which to add newItemId

newItemId - the bean (of type BT) to add (not null)

Throws:

IllegalArgumentException

See Also:

Container.Ordered.addItemAfter(Object, Object)

addItemAt

public MhuBeanItem<BEANTYPE> addItemAt(int index,
                              Object newItemId)
                                throws IllegalArgumentException

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

Specified by:

addItemAt in interface com.vaadin.data.Container.Indexed

Overrides:

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

Parameters:

index - Index at which the bean should be added.

newItemId - The bean to add to the container.

Returns:

Returns the new BeanItem or null if the operation fails.

Throws:

IllegalArgumentException

addItem

public MhuBeanItem<BEANTYPE> addItem(Object itemId)

Adds the bean to the Container. The bean is used both as the item contents and as the item identifier.

Specified by:

addItem in interface com.vaadin.data.Container

Overrides:

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

See Also:

Container.addItem(Object)

addBean

public MhuBeanItem<BEANTYPE> addBean(BEANTYPE bean)

Adds the bean to the Container. The bean is used both as the item contents and as the item identifier.

Overrides:

addBean in class MhuAbstractBeanContainer<BEANTYPE,BEANTYPE>

Parameters:

bean - the bean to add

Returns:

BeanItem item added or null

See Also:

Container.addItem(Object)

setBeanIdResolver

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

Unsupported in BeanItemContainer.

Overrides:

setBeanIdResolver in class MhuAbstractBeanContainer<BEANTYPE,BEANTYPE>

Parameters:

beanIdResolver - to use or null to disable automatic id resolution

Throws:

UnsupportedOperationException

mergeAll

public boolean mergeAll(Collection<? extends BEANTYPE> collection,
               boolean remove,
               Comparator<BEANTYPE> comparator)

Description copied from class: MhuAbstractBeanContainer

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.

Overrides:

mergeAll in class MhuAbstractBeanContainer<BEANTYPE,BEANTYPE>

Parameters:

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

remove - 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