com.whitestein.lsps.vaadin.forms.datasource

Interface IVaadinContainerDataSourceAdapter

All Superinterfaces:

Serializable

All Known Implementing Classes:

EmptyVaadinContainerDataSourceAdapter, VaadinContainerDataSourceAdapter

public interface IVaadinContainerDataSourceAdapter
extends Serializable

Adapts forms::DataSource and provides Vaadin Container which can be asked for tabular data. Initially the container will contain no properties (columns) - you will probably want to call addProperty(Serializable, ValueProvider, boolean, boolean) first, to register properties (columns) to the container.

The LSPS row objects (returned by forms::DataSource) are not necessarily stored in ItemIDs: use getRowObjectForItemId(Serializable) and getItemIdForRowObject(Object) to convert from row object to ItemIDs and vice versa.

Author:

mvy

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IVaadinContainerDataSourceAdapter.FilterConfigProvider Converts filter propertyId to FilterConfig id.
static interface	IVaadinContainerDataSourceAdapter.FullyCapableContainer An interface for container that can do everything VaadinContainerDataSourceAdapter needs.
static interface	IVaadinContainerDataSourceAdapter.UnconvertableLoadedDataFilter Filters that implement are impossible to convert into data filters.

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.

Method Detail

getFilterConfigProvider

IVaadinContainerDataSourceAdapter.FilterConfigProvider getFilterConfigProvider()

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

Returns:

filter config provider, never null

setFilterConfigProvider

void setFilterConfigProvider(IVaadinContainerDataSourceAdapter.FilterConfigProvider filterConfigProvider)

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

Parameters:

filterConfigProvider -

addProperty

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

Adds a property (column) to this data source.

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

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

Adds a property (column) to this data source.

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

void removeProperty(Serializable id)

Removes a property (column) from this data source.

Parameters:

id - the property ID, not null.

getValueProvider

ValueProvider getValueProvider(Serializable id)

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

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

ValueProvider getFilterValueProvider(Serializable id)

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

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

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

Returns:

property id to filter value provider type map.

getSortTypesMap

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

Returns:

property id to sort value provider type map.

getSortValueProvider

ValueProvider getSortValueProvider(Serializable id)

A value provider used by column sort to obtain values.

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

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

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

Returns:

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

getDefinition

RecordHolder getDefinition()

forms::DataSource

Returns:

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

refresh

void refresh()

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

getRowObjectForItemId

Object getRowObjectForItemId(Serializable itemId)

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.

Parameters:

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

Returns:

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

Throws:

IllegalArgumentException - if the itemId is not present in the container.

getItemIdForRowObject

Serializable getItemIdForRowObject(Object rowObject)

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

Parameters:

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

Returns:

the ItemID

Throws:

IllegalArgumentException - if the row object was not obtained yet from forms::DataSource.