Package io.jmix.ui.data.impl

Class ContainerDataProvider

java.lang.Object

io.jmix.ui.data.impl.ContainerDataProvider

All Implemented Interfaces:

DataProvider, HasMetaClass, Serializable

public class ContainerDataProvider
extends Object
implements DataProvider, HasMetaClass

Data provider which contains CollectionContainer with items.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<DataChangeListener>	changeListeners
protected final Consumer<CollectionContainer.CollectionChangeEvent>	collectionChangeListener
protected final CollectionContainer	dataContainer

Constructor Summary

Constructors

Constructor	Description
ContainerDataProvider(CollectionContainer dataContainer)

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(DataChangeListener listener)	Adds listener to the data provider events.
void	addItem(DataItem item)	Unsupported.
void	addItems(Collection<? extends DataItem> items)	Unsupported.
protected void	fireCollectionChangeListener(DataChangeOperation operation, Collection changedItems)
CollectionContainer	getCollectionContainer()
DataItem	getItem(Object id)
List<DataItem>	getItems()
MetaClass	getMetaClass()
void	removeAll()	Removes all items from the data provider.
void	removeChangeListener(DataChangeListener listener)	Removes listener to data provider events
void	removeItem(DataItem item)	Unsupported.
void	updateItem(DataItem item)	Unsupported.

Methods inherited from class java.lang.Object

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

Field Details

dataContainer

protected final CollectionContainer dataContainer

collectionChangeListener

protected final Consumer<CollectionContainer.CollectionChangeEvent> collectionChangeListener

changeListeners

protected final List<DataChangeListener> changeListeners

Constructor Details

ContainerDataProvider

public ContainerDataProvider(CollectionContainer dataContainer)

Method Details

fireCollectionChangeListener

protected void fireCollectionChangeListener(DataChangeOperation operation,
 Collection changedItems)

getItems

public List<DataItem> getItems()

Specified by:

getItems in interface DataProvider

Returns:

list of all items.

getItem

public DataItem getItem(Object id)

Specified by:

getItem in interface DataProvider

Parameters:

id - id of data item

Returns:

data item by id

addItem

public void addItem(DataItem item)

Unsupported. Always throws an UnsupportedOperationException. Use CollectionContainer for changing data items of ContainerDataProvider

Specified by:

addItem in interface DataProvider

Parameters:

item - an item to be added

Throws:

UnsupportedOperationException - use CollectionContainer for changing data items of ContainerDataProvider

addItems

public void addItems(Collection<? extends DataItem> items)

Unsupported. Always throws an UnsupportedOperationException. Use CollectionContainer for changing data items of ContainerDataProvider

Specified by:

addItems in interface DataProvider

Parameters:

items - a collection of data items to be added

Throws:

UnsupportedOperationException - use CollectionContainer for changing data items of ContainerDataProvider

updateItem

public void updateItem(DataItem item)

Unsupported. Always throws an UnsupportedOperationException. Use CollectionContainer for changing data items of ContainerDataProvider

Specified by:

updateItem in interface DataProvider

Parameters:

item - an item to be updated

Throws:

UnsupportedOperationException - use CollectionContainer for changing data items of ContainerDataProvider

removeItem

public void removeItem(DataItem item)

Unsupported. Always throws an UnsupportedOperationException. Use CollectionContainer for changing data items of ContainerDataProvider

Specified by:

removeItem in interface DataProvider

Parameters:

item - an item to be removed

Throws:

UnsupportedOperationException - use CollectionContainer for changing data items of ContainerDataProvider

removeAll

public void removeAll()

Description copied from interface: DataProvider

Removes all items from the data provider.

Specified by:

removeAll in interface DataProvider

addChangeListener

public void addChangeListener(DataChangeListener listener)

Description copied from interface: DataProvider

Adds listener to the data provider events.

Specified by:

addChangeListener in interface DataProvider

Parameters:

listener - listener to be added

removeChangeListener

public void removeChangeListener(DataChangeListener listener)

Description copied from interface: DataProvider

Removes listener to data provider events

Specified by:

removeChangeListener in interface DataProvider

Parameters:

listener - listener to be removed

getMetaClass

public MetaClass getMetaClass()

Specified by:

getMetaClass in interface HasMetaClass

Returns:

entity MetaClass

getCollectionContainer

public CollectionContainer getCollectionContainer()

Returns:

CollectionContainer instance