Package org.dellroad.stuff.vaadin7

Class SelfKeyedContainer<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>

org.dellroad.stuff.vaadin7.SimpleKeyedContainer<T,T>

org.dellroad.stuff.vaadin7.SelfKeyedContainer<T>

Type Parameters:

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:

EnumContainer, VaadinSessionContainer

public class SelfKeyedContainer<T>
extends SimpleKeyedContainer<T,T>

A SimpleKeyedContainer where the item IDs are the underlying container objects themselves.

Restriction: instances can't contain two objects that are equal() to each other.

See Also:

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
	SelfKeyedContainer()	Constructor.
	SelfKeyedContainer(Class<? super T> type)	Constructor.
protected	SelfKeyedContainer(Collection<? extends PropertyDef<?>> propertyDefs)	Constructor.
	SelfKeyedContainer(PropertyExtractor<? super T> propertyExtractor)	Constructor.
	SelfKeyedContainer(PropertyExtractor<? super T> propertyExtractor, Collection<? extends PropertyDef<?>> propertyDefs)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected T	getKeyFor(T obj)	Get the key to be used as item ID for the given object.

Methods inherited from class org.dellroad.stuff.vaadin7.SimpleKeyedContainer

generateItemId, getItemIdFor, getItemIdForSame, getJavaObject, resetItemIds

Methods inherited from class org.dellroad.stuff.vaadin7.AbstractSimpleContainer

addContainerFilter, addContainerFilter, afterReload, connect, createBackedItem, disconnect, getContainerFilters, getContainerProperty, getContainerPropertyIds, getItemIds, getPropertyExtractor, getPropertyValue, getSortableContainerPropertyIds, getType, getUnfilteredItem, internalRemoveAllItems, load, load, removeAllContainerFilters, removeContainerFilter, removeContainerFilters, setProperties, setProperty, setPropertyExtractor, sort

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

SelfKeyedContainer

public SelfKeyedContainer()

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.

SelfKeyedContainer

public SelfKeyedContainer(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()

SelfKeyedContainer

protected SelfKeyedContainer(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

SelfKeyedContainer

public SelfKeyedContainer(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

SelfKeyedContainer

public SelfKeyedContainer(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

getKeyFor

protected T getKeyFor(T obj)

Get the key to be used as item ID for the given object.

The implementation in SelfKeyedContainer always returns obj.

Specified by:

getKeyFor in class SimpleKeyedContainer<T,T>

Parameters:

obj - underlying container object

Returns:

key for object