Package org.dellroad.stuff.vaadin7

Class AbstractSimpleContainer<I,T>

java.lang.Object

com.vaadin.data.util.AbstractContainer

com.vaadin.data.util.AbstractInMemoryContainer<I,String,BackedItem<T>>

org.dellroad.stuff.vaadin7.AbstractSimpleContainer<I,T>

Type Parameters:

I - the item ID type

T - the type of the Java objects that back each Item in the container

All Implemented Interfaces:

Container, Container.Filterable, Container.Indexed, Container.ItemSetChangeNotifier, Container.Ordered, Container.SimpleFilterable, Container.Sortable, Serializable, Connectable, PropertyExtractor<T>

Direct Known Subclasses:

SimpleContainer, SimpleKeyedContainer

public abstract class AbstractSimpleContainer<I,T>
extends AbstractInMemoryContainer<I,String,BackedItem<T>>
implements PropertyExtractor<T>, Container.Filterable, Container.SimpleFilterable, Container.Sortable, Connectable

Support superclass for simple read-only, in-memory Container implementations where each Item in the container is backed by a Java object.

This Container's Propertys are defined via PropertyDefs, and a PropertyExtractor is used to actually extract the property values from each underlying object (alternately, subclasses can override getPropertyValue()). However, the easist way to configure the container Propertys is to pass a @ProvidesProperty-annotated Java class to the AbstractSimpleContainer(Class) constructor.

Use load() to load or reload the container.

See Also:

SimpleItem, Serialized Form

Nested Class Summary

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

AbstractInMemoryContainer.BaseItemAddEvent, AbstractInMemoryContainer.BaseItemRemoveEvent

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

AbstractContainer.BaseItemSetChangeEvent, AbstractContainer.BasePropertySetChangeEvent

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

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

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

Container.Indexed.ItemAddEvent, Container.Indexed.ItemRemoveEvent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSimpleContainer()	Constructor.
protected	AbstractSimpleContainer(Class<? super T> type)	Constructor.
protected	AbstractSimpleContainer(Collection<? extends PropertyDef<?>> propertyDefs)	Constructor.
protected	AbstractSimpleContainer(PropertyExtractor<? super T> propertyExtractor)	Constructor.
protected	AbstractSimpleContainer(PropertyExtractor<? super T> propertyExtractor, Collection<? extends PropertyDef<?>> propertyDefs)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addContainerFilter(Container.Filter filter)
void	addContainerFilter(Object propertyId, String filterString, boolean ignoreCase, boolean onlyMatchPrefix)
protected void	afterReload()	Subclass hook invoked after each reload but prior to invoking AbstractContainer.fireItemSetChange().
void	connect()	Connect this instance to non-Vaadin resources.
protected BackedItem<T>	createBackedItem(T object, Collection<PropertyDef<?>> propertyDefs, PropertyExtractor<? super T> propertyExtractor)	Create a BackedItem for the given backing Java object.
void	disconnect()	Disconnect this instance from non-Vaadin resources.
protected abstract I	generateItemId(T obj)	Create a new, unique item ID for the given object.
Collection<Container.Filter>	getContainerFilters()
Property<?>	getContainerProperty(Object itemId, Object propertyId)
Set<String>	getContainerPropertyIds()
I	getItemIdFor(T obj)	Get the container item ID corresponding to the given underlying Java object which is wrapped by this container.
I	getItemIdForSame(T obj)	Get the container item ID corresponding to the given underlying Java object which is wrapped by this container.
List<I>	getItemIds()
abstract T	getJavaObject(Object itemId)	Get the underlying Java object corresponding to the given item ID.
PropertyExtractor<? super T>	getPropertyExtractor()	Get the configured PropertyExtractor for this container.
<V> V	getPropertyValue(T obj, PropertyDef<V> propertyDef)	Read the value of the property defined by propertyDef from the given object.
Collection<?>	getSortableContainerPropertyIds()
Class<?>	getType(Object propertyId)
BackedItem<T>	getUnfilteredItem(Object itemId)
protected void	internalRemoveAllItems()
void	load(Iterable<? extends T> contents)	Change this container's contents.
void	load(Iterator<? extends T> contents)	Change this container's contents.
void	removeAllContainerFilters()
void	removeContainerFilter(Container.Filter filter)
void	removeContainerFilters(Object propertyId)
protected abstract void	resetItemIds()	Subclass hook invoked prior to each reload.
void	setProperties(Collection<? extends PropertyDef<?>> propertyDefs)	Change the configured properties of this container.
void	setProperty(PropertyDef<?> propertyDef)	Add or replace a configured property of this container.
void	setPropertyExtractor(PropertyExtractor<? super T> propertyExtractor)	Change the configured PropertyExtractor for this container.
void	sort(Object[] propertyId, boolean[] ascending)

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

addContainerProperty, addFilter, addItem, addItem, addItemAfter, addItemAfter, addItemAt, addItemAt, addItemSetChangeListener, addListener, containsId, doFilterContainer, doSort, filterAll, fireItemAdded, fireItemRemoved, fireItemsAdded, fireItemsRemoved, firstItemId, getAllItemIds, getFilteredItemIds, getFilters, getFirstVisibleItem, getIdByIndex, getItem, getItemIds, getItemSorter, getSortablePropertyIds, getVisibleItemIds, hasContainerFilters, indexOfId, internalAddItemAfter, internalAddItemAt, internalAddItemAtEnd, internalRemoveItem, isFiltered, isFirstId, isLastId, isPropertyFiltered, lastItemId, nextItemId, passesFilters, prevItemId, registerNewItem, removeAllFilters, removeAllItems, removeContainerProperty, removeFilter, removeFilters, removeItem, removeItemSetChangeListener, removeListener, setAllItemIds, setFilteredItemIds, setFilters, setItemSorter, size, sortContainer

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

addListener, addPropertySetChangeListener, fireContainerPropertySetChange, fireContainerPropertySetChange, fireItemSetChange, fireItemSetChange, getItemSetChangeListeners, getListeners, getPropertySetChangeListeners, removeListener, removePropertySetChangeListener, 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

addContainerProperty, addItem, addItem, containsId, getItem, removeAllItems, removeContainerProperty, removeItem, size

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

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

Constructor Detail

AbstractSimpleContainer

protected AbstractSimpleContainer()

Constructor.

After using this constructor, subsequent invocations of setPropertyExtractor() and setProperties() are required to define the properties of this container and how to extract them.

AbstractSimpleContainer

protected AbstractSimpleContainer(PropertyExtractor<? super T> propertyExtractor)

Constructor.

After using this constructor, a subsequent invocation of setProperties() is required to define the properties of this container.

Parameters:

propertyExtractor - used to extract properties from the underlying Java objects; may be null but then container is not usable until one is configured via setPropertyExtractor()

AbstractSimpleContainer

protected AbstractSimpleContainer(Collection<? extends PropertyDef<?>> propertyDefs)

Constructor.

After using this constructor, a subsequent invocation of setPropertyExtractor() is required to define how to extract the properties of this container; alternately, subclasses can override getPropertyValue().

Parameters:

propertyDefs - container property definitions; null is treated like the empty set

AbstractSimpleContainer

protected AbstractSimpleContainer(PropertyExtractor<? super T> propertyExtractor,
                                  Collection<? extends PropertyDef<?>> propertyDefs)

Constructor.

Parameters:

propertyExtractor - used to extract properties from the underlying Java objects; may be null but then container is not usable until one is configured via setPropertyExtractor()

propertyDefs - container property definitions; null is treated like the empty set

AbstractSimpleContainer

protected AbstractSimpleContainer(Class<? super T> type)

Constructor.

Properties will be determined by the @ProvidesProperty and @ProvidesPropertySort annotated methods in the given class.

Parameters:

type - class to introspect for annotated methods

Throws:

IllegalArgumentException - if type is null

IllegalArgumentException - if type has two @ProvidesProperty or @ProvidesPropertySort annotated methods for the same property

IllegalArgumentException - if a @ProvidesProperty-annotated method with no property name specified has a name which cannot be interpreted as a bean property "getter" method

See Also:

ProvidesProperty, ProvidesPropertySort, ProvidesPropertyScanner

Method Detail

getPropertyExtractor

public PropertyExtractor<? super T> getPropertyExtractor()

Get the configured PropertyExtractor for this container.

Returns:

configured PropertyExtractor

setPropertyExtractor

public void setPropertyExtractor(PropertyExtractor<? super T> propertyExtractor)

Change the configured PropertyExtractor for this container. Invoking this method does not result in any container notifications.

Parameters:

propertyExtractor - used to extract properties from the underlying Java objects; may be null but the container is not usable without one

getPropertyValue

public <V> V getPropertyValue(T obj,
                              PropertyDef<V> propertyDef)

Read the value of the property defined by propertyDef from the given object.

The implementation in AbstractSimpleContainer just delegates to the configured PropertyExtractor; subclasses may override to customize property extraction.

Specified by:

getPropertyValue in interface PropertyExtractor<I>

Type Parameters:

V - value type

Parameters:

obj - Java object

propertyDef - definition of which property to read

Returns:

property value

Throws:

NullPointerException - if either parameter is null

IllegalStateException - if no PropertyExtractor is configured for this container

setProperties

public void setProperties(Collection<? extends PropertyDef<?>> propertyDefs)

Change the configured properties of this container.

Parameters:

propertyDefs - container property definitions; null is treated like the empty set

Throws:

IllegalArgumentException - if propertyDefs contains a property with a duplicate name

setProperty

public void setProperty(PropertyDef<?> propertyDef)

Add or replace a configured property of this container.

Parameters:

propertyDef - new container property definitions

Throws:

IllegalArgumentException - if propertyDef is null

load

public void load(Iterable<? extends T> contents)

Change this container's contents.

Parameters:

contents - new container contents

Throws:

IllegalArgumentException - if contents or any item in contents is null

load

public void load(Iterator<? extends T> contents)

Change this container's contents.

Parameters:

contents - new container contents

Throws:

IllegalArgumentException - if contents or any item in contents is null

internalRemoveAllItems

protected void internalRemoveAllItems()

Overrides:

internalRemoveAllItems in class AbstractInMemoryContainer<I,String,BackedItem<T>>

getItemIdFor

public I getItemIdFor(T obj)

Get the container item ID corresponding to the given underlying Java object which is wrapped by this container. Objects are tested for equality using Object.equals().

The implementation in AbstractSimpleContainer requires a linear search of the container. Some subclasses may provide a more efficient implementation.

This method is not used by this class but is defined as a convenience for subclasses.

Note: items that are filtered out will not be found.

Parameters:

obj - underlying container object

Returns:

item ID corresponding to object, or null if object is not found in this container

Throws:

IllegalArgumentException - if object is null

See Also:

getItemIdForSame(T)

getItemIdForSame

public I getItemIdForSame(T obj)

Get the container item ID corresponding to the given underlying Java object which is wrapped by this container. Objects are tested for equality using object equality, not Object.equals().

The implementation in AbstractSimpleContainer requires a linear search of the container. Some subclasses may provide a more efficient implementation.

This method is not used by this class but is defined as a convenience for subclasses.

Note: items that are filtered out will not be found.

Parameters:

obj - underlying container object

Returns:

item ID corresponding to object, or null if object is not found in this container

Throws:

IllegalArgumentException - if object is null

See Also:

getItemIdFor(T)

connect

public void connect()

Connect this instance to non-Vaadin resources.

The implementation in AbstractSimpleContainer does nothing.

Specified by:

connect in interface Connectable

Throws:

IllegalStateException - if there is no VaadinSession associated with the current thread

disconnect

public void disconnect()

Disconnect this instance from non-Vaadin resources.

The implementation in AbstractSimpleContainer does nothing.

Specified by:

disconnect in interface Connectable

Throws:

IllegalStateException - if there is no VaadinSession associated with the current thread

getItemIds

public List<I> getItemIds()

Specified by:

getItemIds in interface Container

Overrides:

getItemIds in class AbstractInMemoryContainer<I,String,BackedItem<T>>

getContainerPropertyIds

public Set<String> getContainerPropertyIds()

Specified by:

getContainerPropertyIds in interface Container

getContainerProperty

public Property<?> getContainerProperty(Object itemId,
                                        Object propertyId)

Specified by:

getContainerProperty in interface Container

getType

public Class<?> getType(Object propertyId)

Specified by:

getType in interface Container

getUnfilteredItem

public BackedItem<T> getUnfilteredItem(Object itemId)

Specified by:

getUnfilteredItem in class AbstractInMemoryContainer<I,String,BackedItem<T>>

getJavaObject

public abstract T getJavaObject(Object itemId)

Get the underlying Java object corresponding to the given item ID. This method ignores any filtering (i.e., filtered-out objects are still accessible).

Parameters:

itemId - item ID

Returns:

the corresponding Java object, or null if not found

resetItemIds

protected abstract void resetItemIds()

Subclass hook invoked prior to each reload. The subclass should reset its state (e.g., issued item IDs) as required.

generateItemId

protected abstract I generateItemId(T obj)

Create a new, unique item ID for the given object. This method is invoked during a reload operation, once for each container object. Both visible and filtered objects will be passed to this method.

The returned item ID must be unique, i.e., not returned by this method since the most recent invocation of resetItemIds().

Parameters:

obj - underlying container object, never null

Returns:

item ID, never null

afterReload

protected void afterReload()

Subclass hook invoked after each reload but prior to invoking AbstractContainer.fireItemSetChange().

The implementation in AbstractSimpleContainer does nothing.

createBackedItem

protected BackedItem<T> createBackedItem(T object,
                                         Collection<PropertyDef<?>> propertyDefs,
                                         PropertyExtractor<? super T> propertyExtractor)

Create a BackedItem for the given backing Java object.

The implementation in AbstractSimpleContainer returns new SimpleItem<T>(object, propertyDefs, propertyExtractor).

Parameters:

object - underlying Java object

propertyDefs - property definitions

propertyExtractor - extracts the property value from object

Returns:

new BackedItem

Throws:

IllegalArgumentException - if any parameter is null

sort

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

Specified by:

sort in interface Container.Sortable

addContainerFilter

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

Specified by:

addContainerFilter in interface Container.SimpleFilterable

getContainerFilters

public Collection<Container.Filter> getContainerFilters()

Specified by:

getContainerFilters in interface Container.Filterable

Overrides:

getContainerFilters in class AbstractInMemoryContainer<I,String,BackedItem<T>>

removeAllContainerFilters

public void removeAllContainerFilters()

Specified by:

removeAllContainerFilters in interface Container.Filterable

Specified by:

removeAllContainerFilters in interface Container.SimpleFilterable

removeContainerFilters

public void removeContainerFilters(Object propertyId)

Specified by:

removeContainerFilters in interface Container.SimpleFilterable

addContainerFilter

public void addContainerFilter(Container.Filter filter)

Specified by:

addContainerFilter in interface Container.Filterable

removeContainerFilter

public void removeContainerFilter(Container.Filter filter)

Specified by:

removeContainerFilter in interface Container.Filterable

getSortableContainerPropertyIds

public Collection<?> getSortableContainerPropertyIds()

Specified by:

getSortableContainerPropertyIds in interface Container.Sortable