com.whitestein.lsps.vaadin.forms.datasource

Class EmptyVaadinContainerDataSourceAdapter

java.lang.Object

com.whitestein.lsps.vaadin.forms.datasource.EmptyVaadinContainerDataSourceAdapter

All Implemented Interfaces:

IVaadinContainerDataSourceAdapter, Serializable

public class EmptyVaadinContainerDataSourceAdapter
extends Object
implements IVaadinContainerDataSourceAdapter

A simple implementation which always provides zero results (the container is empty).

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.whitestein.lsps.vaadin.forms.datasource.IVaadinContainerDataSourceAdapter

IVaadinContainerDataSourceAdapter.FilterConfigProvider, IVaadinContainerDataSourceAdapter.FullyCapableContainer, IVaadinContainerDataSourceAdapter.UnconvertableLoadedDataFilter

Constructor Summary

Constructors

Constructor and Description
EmptyVaadinContainerDataSourceAdapter()

Method Summary

Modifier and Type	Method and Description
void	addProperty(Serializable id, ValueProvider valueProvider, boolean sortable, boolean readOnly) Adds a property (column) to this data source.
void	addProperty(Serializable id, ValueProvider valueProvider, ValueProvider filterVP, ValueProvider sortVP, boolean sortable, boolean readonly) Adds a property (column) to this data source.
com.vaadin.data.Container.Indexed	getContainer() Returns the Vaadin Container.
RecordHolder	getDefinition() forms::DataSource
IVaadinContainerDataSourceAdapter.FilterConfigProvider	getFilterConfigProvider() Returned object provides information about configured filters.
Hashtable<Object,Class<?>>	getFilterTypesMap()
ValueProvider	getFilterValueProvider(Serializable id) A value provider used by a column filter to obtain column values.
Serializable	getItemIdForRowObject(Object rowObject) Returns the Container ItemID for particular row object.
Object	getRowObjectForItemId(Serializable itemId) Returns the row object for given row ID.
Hashtable<Object,Class<?>>	getSortTypesMap()
ValueProvider	getSortValueProvider(Serializable id) A value provider used by column sort to obtain values.
ValueProvider	getValueProvider(Serializable id) A value provider used by a column to obtain column values.
void	refresh() Polls the data again.
void	removeProperty(Serializable id) Removes a property (column) from this data source.
void	setFilterConfigProvider(IVaadinContainerDataSourceAdapter.FilterConfigProvider filterConfigProvider) Sets filter config provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyVaadinContainerDataSourceAdapter

public EmptyVaadinContainerDataSourceAdapter()

Method Detail

addProperty

public void addProperty(Serializable id,
                        ValueProvider valueProvider,
                        boolean sortable,
                        boolean readOnly)

Description copied from interface: IVaadinContainerDataSourceAdapter

Adds a property (column) to this data source.

Specified by:

addProperty in interface IVaadinContainerDataSourceAdapter

Parameters:

id - the property ID, not null.

valueProvider - provides cell value for this column. The produced value is passed to the renderer; the provider is also used for filtering and sorting.

sortable - true if this column should be sortable

readOnly - true if this column should be editable

addProperty

public void addProperty(Serializable id,
                        ValueProvider valueProvider,
                        ValueProvider filterVP,
                        ValueProvider sortVP,
                        boolean sortable,
                        boolean readonly)

Description copied from interface: IVaadinContainerDataSourceAdapter

Adds a property (column) to this data source.

Specified by:

addProperty in interface IVaadinContainerDataSourceAdapter

Parameters:

id - the property ID, not null.

valueProvider - provides cell value for this column. The produced value is passed to the renderer; the provider is also used for filtering and sorting.

filterVP - provides column value for filtering purposes. E.g. column filter will see this value.

sortVP - provides column value for sorting purposes. E.g. column sort will see this value.

sortable - true if this column should be sortable

readonly - true if this column should be editable

removeProperty

public void removeProperty(Serializable id)

Description copied from interface: IVaadinContainerDataSourceAdapter

Removes a property (column) from this data source.

Specified by:

removeProperty in interface IVaadinContainerDataSourceAdapter

Parameters:

id - the property ID, not null.

getValueProvider

public ValueProvider getValueProvider(Serializable id)

Description copied from interface: IVaadinContainerDataSourceAdapter

A value provider used by a column to obtain column values.

Specified by:

getValueProvider in interface IVaadinContainerDataSourceAdapter

Parameters:

id - the property ID of the column, not null

Returns:

the column value provider or null if the column does not use any value provider for obtaining column values.

getFilterValueProvider

public ValueProvider getFilterValueProvider(Serializable id)

Description copied from interface: IVaadinContainerDataSourceAdapter

A value provider used by a column filter to obtain column values.

Specified by:

getFilterValueProvider in interface IVaadinContainerDataSourceAdapter

Parameters:

id - the property ID of the column, not null

Returns:

the column filter value provider or null if the column does not use any value provider for obtaining filter values.

getFilterTypesMap

public Hashtable<Object,Class<?>> getFilterTypesMap()

Specified by:

getFilterTypesMap in interface IVaadinContainerDataSourceAdapter

Returns:

property id to filter value provider type map.

getSortTypesMap

public Hashtable<Object,Class<?>> getSortTypesMap()

Specified by:

getSortTypesMap in interface IVaadinContainerDataSourceAdapter

Returns:

property id to sort value provider type map.

getSortValueProvider

public ValueProvider getSortValueProvider(Serializable id)

Description copied from interface: IVaadinContainerDataSourceAdapter

A value provider used by column sort to obtain values.

Specified by:

getSortValueProvider in interface IVaadinContainerDataSourceAdapter

Parameters:

id - the property ID of the column, not null

Returns:

the column sort value provider or null if the column does not use any value provider for obtaining sort values.

getContainer

public com.vaadin.data.Container.Indexed getContainer()

Description copied from interface: IVaadinContainerDataSourceAdapter

Returns the Vaadin Container. The container is constructed once and will not change. Calling IVaadinContainerDataSourceAdapter.addProperty(Serializable, ValueProvider, boolean, boolean) will add properties to this container as well.

Specified by:

getContainer in interface IVaadinContainerDataSourceAdapter

Returns:

the container, not null. Must also implement Container.Filterable.

getDefinition

public RecordHolder getDefinition()

Description copied from interface: IVaadinContainerDataSourceAdapter

forms::DataSource

Specified by:

getDefinition in interface IVaadinContainerDataSourceAdapter

Returns:

original forms::DataSource or null if this DS is not backed by forms::DataSource

refresh

public void refresh()

Description copied from interface: IVaadinContainerDataSourceAdapter

Polls the data again. If the container changes, the change must be propagated by firing Container.ItemSetChangeListener.

Specified by:

refresh in interface IVaadinContainerDataSourceAdapter

getItemIdForRowObject

public Serializable getItemIdForRowObject(Object rowObject)

Description copied from interface: IVaadinContainerDataSourceAdapter

Returns the Container ItemID for particular row object. Used for example to select a particular row in a Grid.

Specified by:

getItemIdForRowObject in interface IVaadinContainerDataSourceAdapter

Parameters:

rowObject - the row object as produced by the forms::DataSource

Returns:

the ItemID

getRowObjectForItemId

public Object getRowObjectForItemId(Serializable itemId)

Description copied from interface: IVaadinContainerDataSourceAdapter

Returns the row object for given row ID. Used by renderers, for example to identify which row object has been clicked upon; also used by tables to invoke the closure which creates UI components for particular cells.

Specified by:

getRowObjectForItemId in interface IVaadinContainerDataSourceAdapter

Parameters:

itemId - Vaadin itemId; the item must be present in IVaadinContainerDataSourceAdapter.getContainer()!

Returns:

row object, may be null. Never a Variant, always a Java type or a ValueHolder, RecordHolder or the like.

getFilterConfigProvider

public IVaadinContainerDataSourceAdapter.FilterConfigProvider getFilterConfigProvider()

Description copied from interface: IVaadinContainerDataSourceAdapter

Returned object provides information about configured filters. It allows mapping between vaadin and lsps filters.

Specified by:

getFilterConfigProvider in interface IVaadinContainerDataSourceAdapter

Returns:

filter config provider, never null

setFilterConfigProvider

public void setFilterConfigProvider(IVaadinContainerDataSourceAdapter.FilterConfigProvider filterConfigProvider)

Description copied from interface: IVaadinContainerDataSourceAdapter

Sets filter config provider. The argument can not be null.

Specified by:

setFilterConfigProvider in interface IVaadinContainerDataSourceAdapter