Package org.dellroad.stuff.vaadin7

Class SimpleItem<T>

java.lang.Object

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

Type Parameters:

T - the type of the underlying Java object

All Implemented Interfaces:

Item, Serializable, BackedItem<T>

public class SimpleItem<T>
extends Object
implements BackedItem<T>

Simple read-only Item implementation backed by a Java object.

Item Propertys are defined by PropertyDefs and retrieved by a PropertyExtractor.

Although the item properties are read-only from "above", they can be made mutable from "below" by modifying the backing object and invoking fireValueChange().

See Also:

AbstractQueryContainer, AbstractSimpleContainer, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SimpleItem.Property<V>	SimpleItem.Property implementation used by SimpleItem.

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

Item.Editor, Item.PropertySetChangeEvent, Item.PropertySetChangeListener, Item.PropertySetChangeNotifier, Item.Viewer

Field Summary

Fields

Modifier and Type	Field	Description
protected T	object
protected PropertyExtractor<? super T>	propertyExtractor

Constructor Summary

Constructors

Constructor	Description
SimpleItem(T object, Collection<? extends PropertyDef<?>> propertyDefs, PropertyExtractor<? super T> propertyExtractor)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	addItemProperty(Object id, Property property)
protected <V> SimpleItem.Property<V>	createProperty(PropertyDef<V> propertyDef)	Create a SimpleItem.Property to be used for the given property definition.
void	fireValueChange()	Issue Property.ValueChangeEvents to all Property.ValueChangeListeners registered on any property of this item.
void	fireValueChange(String propertyName)	Issue Property.ValueChangeEvents to all Property.ValueChangeListeners registered on the specified property of this item.
SimpleItem.Property<?>	getItemProperty(Object id)
Set<String>	getItemPropertyIds()
T	getObject()	Retrieve the underlying Java object.
boolean	removeItemProperty(Object id)

Methods inherited from class java.lang.Object

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

Field Detail

object

protected final T object

propertyExtractor

protected final PropertyExtractor<? super T> propertyExtractor

Constructor Detail

SimpleItem

public SimpleItem(T object,
                  Collection<? extends PropertyDef<?>> propertyDefs,
                  PropertyExtractor<? super T> propertyExtractor)

Constructor.

Parameters:

object - underlying Java object

propertyDefs - property definitions

propertyExtractor - extracts the property value from object

Throws:

IllegalArgumentException - if any parameter is null

Method Detail

getObject

public T getObject()

Description copied from interface: BackedItem

Retrieve the underlying Java object.

Specified by:

getObject in interface BackedItem<T>

Returns:

underlying Java object, never null

getItemProperty

public SimpleItem.Property<?> getItemProperty(Object id)

Specified by:

getItemProperty in interface Item

getItemPropertyIds

public Set<String> getItemPropertyIds()

Specified by:

getItemPropertyIds in interface Item

addItemProperty

public boolean addItemProperty(Object id,
                               Property property)

Specified by:

addItemProperty in interface Item

Throws:

UnsupportedOperationException - always

removeItemProperty

public boolean removeItemProperty(Object id)

Specified by:

removeItemProperty in interface Item

Throws:

UnsupportedOperationException - always

fireValueChange

public void fireValueChange(String propertyName)

Issue Property.ValueChangeEvents to all Property.ValueChangeListeners registered on the specified property of this item.

Does nothing if propertyName is not one of this item's properties.

Parameters:

propertyName - property ID

fireValueChange

public void fireValueChange()

Issue Property.ValueChangeEvents to all Property.ValueChangeListeners registered on any property of this item.

createProperty

protected <V> SimpleItem.Property<V> createProperty(PropertyDef<V> propertyDef)

Create a SimpleItem.Property to be used for the given property definition. This method will be invoked at most once for any property; the returned value is cached.

The implementation in SimpleItem returns new Property<V>(propertyDef).

Type Parameters:

V - property type

Parameters:

propertyDef - property definition

Returns:

new property

Throws:

IllegalArgumentException - if propertyDef is null