com.xdev.ui.paging

Class XdevEntityLazyQueryContainer

java.lang.Object

com.xdev.ui.paging.XdevEntityLazyQueryContainer

All Implemented Interfaces:

Buffered, Container, Container.Filterable, Container.Indexed, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeNotifier, Container.Sortable, Serializable

Direct Known Subclasses:

ExtendableLazyEntityContainer

public class XdevEntityLazyQueryContainer
extends Object
implements Container.Indexed, Container.Sortable, Container.ItemSetChangeNotifier, Container.PropertySetChangeNotifier, Buffered, Container.Filterable, Serializable

LazyQueryContainer provides lazy loading of items from business services. See package level documentation for detailed description. This implements event notification functionality and delegates other methods to QueryView aggregate.

See Also:

Serialized Form

Nested Class Summary

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

Container.Indexed.ItemAddEvent, Container.Indexed.ItemRemoveEvent

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.Buffered

Buffered.SourceException

Constructor Summary

Constructors

Constructor and Description
XdevEntityLazyQueryContainer(EntityLazyQueryView queryView) Constructs LazyQueryContainer with the given QueryView.
XdevEntityLazyQueryContainer(org.vaadin.addons.lazyquerycontainer.QueryDefinition queryDefinition, org.vaadin.addons.lazyquerycontainer.QueryFactory queryFactory) Constructs LazyQueryContainer with LazyQueryView and given queryFactory and queryDefinition.
XdevEntityLazyQueryContainer(org.vaadin.addons.lazyquerycontainer.QueryFactory queryFactory, Object idPropertyId, int batchSize, boolean compositeItems) Constructs LazyQueryContainer with LazyQueryView and given queryFactory.

Method Summary

Modifier and Type	Method and Description
void	addContainerFilter(Container.Filter filter)
boolean	addContainerProperty(Object propertyId, Class<?> type, Object defaultValue) Adds a new property to the definition.
boolean	addContainerProperty(Object propertyId, Class<?> type, Object defaultValue, boolean readOnly, boolean sortable) Adds a new property to the definition.
void	addDefaultFilter(Container.Filter filter) Adds default filter to underlying QueryDefinition.
Object	addItem() Constructs and adds new item.
Item	addItem(Object itemId) Not supported.
Object	addItemAfter(Object previousItemId) Not supported.
Item	addItemAfter(Object previousItemId, Object newItemId) Not supported.
Object	addItemAt(int index) Not supported.
Item	addItemAt(int index, Object newItemId) Not supported.
void	addItemSetChangeListener(Container.ItemSetChangeListener listener)
void	addListener(Container.ItemSetChangeListener listener) Deprecated.
void	addListener(Container.PropertySetChangeListener listener) Deprecated.
void	addPropertySetChangeListener(Container.PropertySetChangeListener listener)
void	commit() Commits changed and refreshes container.
boolean	containsId(Object itemId) True if container contains the given index.
void	discard() Discards changes and refreshes container.
Object	firstItemId()
Collection<Container.Filter>	getContainerFilters()
Property<?>	getContainerProperty(Object itemId, Object propertyId) Gets property of an item.
Collection<?>	getContainerPropertyIds() Lists of the property IDs queried.
Object	getIdByIndex(int index) Gets ID of given index.
Item	getItem(Object itemId) Gets item at given index.
Collection<?>	getItemIds() Gets list of item indexes in the container.
List<?>	getItemIds(int startIndex, int numberOfItems)
EntityLazyQueryView	getQueryView()
Collection<?>	getSortableContainerPropertyIds() List of the property IDs which can be sorted.
Class<?>	getType(Object propertyId) Gets the property value class of the given property.
int	indexOfId(Object itemId) Gets index of given ID.
boolean	isBuffered()
boolean	isFirstId(Object itemId) Check if given index is first i.e.
boolean	isLastId(Object itemId) Check if given index is first i.e.
boolean	isModified()
Object	lastItemId()
Object	nextItemId(Object itemId)
Object	prevItemId(Object itemId)
void	refresh() Refreshes container.
void	removeAllContainerFilters()
boolean	removeAllItems() Removes all items.
void	removeContainerFilter(Container.Filter filter)
boolean	removeContainerProperty(Object propertyId) Removes the given property from the definition.
void	removeDefaultFilter(Container.Filter filter) Removes default filter from underlying QueryDefinition.
void	removeDefaultFilters() Removes all default filters from underlying QueryDefinition.
boolean	removeItem(Object itemId) Removes Item at given index.
void	removeItemSetChangeListener(Container.ItemSetChangeListener listener)
void	removeListener(Container.ItemSetChangeListener listener) Deprecated.
void	removeListener(Container.PropertySetChangeListener listener) Deprecated.
void	removePropertySetChangeListener(Container.PropertySetChangeListener listener)
void	setBuffered(boolean buffered)
int	size() Number of items in the container.
void	sort(Object[] sortPropertyIds, boolean[] ascendingStates) Sets new sort state and refreshes container.

Methods inherited from class java.lang.Object

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

Constructor Detail

XdevEntityLazyQueryContainer

public XdevEntityLazyQueryContainer(org.vaadin.addons.lazyquerycontainer.QueryFactory queryFactory,
                                    Object idPropertyId,
                                    int batchSize,
                                    boolean compositeItems)

Constructs LazyQueryContainer with LazyQueryView and given queryFactory.

Parameters:

queryFactory - The query factory to be used.

idPropertyId - The ID of the ID property or null if item index is used as ID.

batchSize - The batch size to be used when loading data.

compositeItems - True if items are wrapped to CompositeItems.

XdevEntityLazyQueryContainer

public XdevEntityLazyQueryContainer(org.vaadin.addons.lazyquerycontainer.QueryDefinition queryDefinition,
                                    org.vaadin.addons.lazyquerycontainer.QueryFactory queryFactory)

Constructs LazyQueryContainer with LazyQueryView and given queryFactory and queryDefinition.

Parameters:

queryFactory - The query factory to be used.

queryDefinition - The query definition to be used.

XdevEntityLazyQueryContainer

public XdevEntityLazyQueryContainer(EntityLazyQueryView queryView)

Constructs LazyQueryContainer with the given QueryView. This constructor role is to enable use of custom view implementations.

Parameters:

queryView - The query view to be used.

Method Detail

sort

public final void sort(Object[] sortPropertyIds,
                       boolean[] ascendingStates)

Sets new sort state and refreshes container.

Specified by:

sort in interface Container.Sortable

Parameters:

sortPropertyIds - The IDs of the properties participating in sort.

ascendingStates - The sort state of the properties participating in sort. True means ascending.

getContainerPropertyIds

public final Collection<?> getContainerPropertyIds()

Lists of the property IDs queried.

Specified by:

getContainerPropertyIds in interface Container

Returns:

A list of property IDs queried.

getSortableContainerPropertyIds

public final Collection<?> getSortableContainerPropertyIds()

List of the property IDs which can be sorted.

Specified by:

getSortableContainerPropertyIds in interface Container.Sortable

Returns:

A list of the property IDs which can be sorted.

getType

public final Class<?> getType(Object propertyId)

Gets the property value class of the given property.

Specified by:

getType in interface Container

Parameters:

propertyId - If of the property of interest.

Returns:

The value class of the given property.

addContainerProperty

public final boolean addContainerProperty(Object propertyId,
                                          Class<?> type,
                                          Object defaultValue)

Adds a new property to the definition.

Specified by:

addContainerProperty in interface Container

Parameters:

propertyId - Id of the property.

type - Value class of the property.

defaultValue - Default value of the property.

Returns:

always true.

addContainerProperty

public final boolean addContainerProperty(Object propertyId,
                                          Class<?> type,
                                          Object defaultValue,
                                          boolean readOnly,
                                          boolean sortable)

Adds a new property to the definition.

Parameters:

propertyId - Id of the property.

type - Value class of the property.

defaultValue - Default value of the property.

readOnly - Read only state of the property.

sortable - Sortable state of the property.

Returns:

always true.

removeContainerProperty

public final boolean removeContainerProperty(Object propertyId)

Removes the given property from the definition.

Specified by:

removeContainerProperty in interface Container

Parameters:

propertyId - If of the property to be removed.

Returns:

always true.

size

public final int size()

Number of items in the container.

Specified by:

size in interface Container

Returns:

number of items.

getItemIds

public final Collection<?> getItemIds()

Gets list of item indexes in the container.

Specified by:

getItemIds in interface Container

Returns:

Collection of Integers.

getItem

public Item getItem(Object itemId)

Gets item at given index.

Specified by:

getItem in interface Container

Parameters:

itemId - index of the item.

Returns:

Item at the given index.

getContainerProperty

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

Gets property of an item.

Specified by:

getContainerProperty in interface Container

Parameters:

itemId - The index of the item.

propertyId - ID of the property.

Returns:

the property corresponding to given IDs.

getIdByIndex

public final Object getIdByIndex(int index)

Gets ID of given index. In other words returns the index itself.

Specified by:

getIdByIndex in interface Container.Indexed

Parameters:

index - The index of the item.

Returns:

the object ID i.e. index.

indexOfId

public final int indexOfId(Object itemId)

Gets index of given ID. In other words returns the index itself.

Specified by:

indexOfId in interface Container.Indexed

Parameters:

itemId - the item ID.

Returns:

the index.

containsId

public final boolean containsId(Object itemId)

True if container contains the given index.

Specified by:

containsId in interface Container

Parameters:

itemId - Item index.

Returns:

true if container contains the given index.

isFirstId

public final boolean isFirstId(Object itemId)

Check if given index is first i.e. 0.

Specified by:

isFirstId in interface Container.Ordered

Parameters:

itemId - the object index.

Returns:

true if index is 0.

isLastId

public final boolean isLastId(Object itemId)

Check if given index is first i.e. size() - 1.

Specified by:

isLastId in interface Container.Ordered

Parameters:

itemId - the object index.

Returns:

true if index is size() - 1.

firstItemId

public final Object firstItemId()

Specified by:

firstItemId in interface Container.Ordered

Returns:

first item ID i.e. 0.

lastItemId

public final Object lastItemId()

Specified by:

lastItemId in interface Container.Ordered

Returns:

last item ID i.e. size() - 1

nextItemId

public final Object nextItemId(Object itemId)

Specified by:

nextItemId in interface Container.Ordered

Parameters:

itemId - the item index

Returns:

itemId + 1, or null if no such item

prevItemId

public final Object prevItemId(Object itemId)

Specified by:

prevItemId in interface Container.Ordered

Parameters:

itemId - the item index

Returns:

itemId - 1, or null if no such item

addItemAt

public final Object addItemAt(int index)

Not supported.

Specified by:

addItemAt in interface Container.Indexed

Parameters:

index - item index

Returns:

new item ID.

addItemAfter

public final Object addItemAfter(Object previousItemId)

Not supported.

Specified by:

addItemAfter in interface Container.Ordered

Parameters:

previousItemId - ID of previous item.

Returns:

new item ID.

addItemAt

public final Item addItemAt(int index,
                            Object newItemId)

Not supported.

Specified by:

addItemAt in interface Container.Indexed

Parameters:

index - item index

newItemId - ID of new item

Returns:

new Item

addItemAfter

public final Item addItemAfter(Object previousItemId,
                               Object newItemId)

Not supported.

Specified by:

addItemAfter in interface Container.Ordered

Parameters:

previousItemId - ID of previous item.

newItemId - ID of new item

Returns:

new Item

addItem

public final Item addItem(Object itemId)

Not supported.

Specified by:

addItem in interface Container

Parameters:

itemId - itemId

Returns:

new Item

addItem

public final Object addItem()

Constructs and adds new item.

Specified by:

addItem in interface Container

Returns:

item index.

removeItem

public final boolean removeItem(Object itemId)

Removes Item at given index.

Specified by:

removeItem in interface Container

Parameters:

itemId - Item index.

Returns:

always true.

removeAllItems

public final boolean removeAllItems()

Removes all items.

Specified by:

removeAllItems in interface Container

Returns:

always true.

addListener

@Deprecated
public final void addListener(Container.ItemSetChangeListener listener)

Deprecated.

Adds ItemSetChangeListener.

Specified by:

addListener in interface Container.ItemSetChangeNotifier

Parameters:

listener - ItemSetChangeListener to be added.

removeListener

@Deprecated
public final void removeListener(Container.ItemSetChangeListener listener)

Deprecated.

Removes ItemSetChangeListener.

Specified by:

removeListener in interface Container.ItemSetChangeNotifier

Parameters:

listener - ItemSetChangeListener to be removed.

removeItemSetChangeListener

public final void removeItemSetChangeListener(Container.ItemSetChangeListener listener)

Specified by:

removeItemSetChangeListener in interface Container.ItemSetChangeNotifier

refresh

public final void refresh()

Refreshes container.

addListener

@Deprecated
public final void addListener(Container.PropertySetChangeListener listener)

Deprecated.

Adds PropertySetChangeListener.

Specified by:

addListener in interface Container.PropertySetChangeNotifier

Parameters:

listener - PropertySetChangeListener to be added.

addItemSetChangeListener

public final void addItemSetChangeListener(Container.ItemSetChangeListener listener)

Specified by:

addItemSetChangeListener in interface Container.ItemSetChangeNotifier

addPropertySetChangeListener

public final void addPropertySetChangeListener(Container.PropertySetChangeListener listener)

Specified by:

addPropertySetChangeListener in interface Container.PropertySetChangeNotifier

removeListener

@Deprecated
public final void removeListener(Container.PropertySetChangeListener listener)

Deprecated.

Removes PropertySetChangeListener.

Specified by:

removeListener in interface Container.PropertySetChangeNotifier

Parameters:

listener - PropertySetChangeListener to be removed.

removePropertySetChangeListener

public final void removePropertySetChangeListener(Container.PropertySetChangeListener listener)

Specified by:

removePropertySetChangeListener in interface Container.PropertySetChangeNotifier

addContainerFilter

public final void addContainerFilter(Container.Filter filter)

Specified by:

addContainerFilter in interface Container.Filterable

removeContainerFilter

public final void removeContainerFilter(Container.Filter filter)

Specified by:

removeContainerFilter in interface Container.Filterable

removeAllContainerFilters

public final void removeAllContainerFilters()

Specified by:

removeAllContainerFilters in interface Container.Filterable

getContainerFilters

public Collection<Container.Filter> getContainerFilters()

Specified by:

getContainerFilters in interface Container.Filterable

addDefaultFilter

public final void addDefaultFilter(Container.Filter filter)

Adds default filter to underlying QueryDefinition.

Parameters:

filter - the default filter

removeDefaultFilter

public final void removeDefaultFilter(Container.Filter filter)

Removes default filter from underlying QueryDefinition.

Parameters:

filter - the default filter

removeDefaultFilters

public final void removeDefaultFilters()

Removes all default filters from underlying QueryDefinition.

commit

public final void commit()

Commits changed and refreshes container.

Specified by:

commit in interface Buffered

discard

public final void discard()

Discards changes and refreshes container.

Specified by:

discard in interface Buffered

isModified

public final boolean isModified()

Specified by:

isModified in interface Buffered

Returns:

true if container contains not commited modifications.

getQueryView

public final EntityLazyQueryView getQueryView()

Returns:

the queryView

setBuffered

public final void setBuffered(boolean buffered)

Specified by:

setBuffered in interface Buffered

isBuffered

public final boolean isBuffered()

Specified by:

isBuffered in interface Buffered

getItemIds

public final List<?> getItemIds(int startIndex,
                                int numberOfItems)

Specified by:

getItemIds in interface Container.Indexed