org.dominokit.domino.ui.datatable.store

Class LocalListScrollingDataSource<T>

java.lang.Object

org.dominokit.domino.ui.datatable.store.LocalListScrollingDataSource<T>

Type Parameters:

T - the type of the data table records

All Implemented Interfaces:

TableEventListener, DataStore<T>

public class LocalListScrollingDataSource<T>
extends Object
implements DataStore<T>

An implementation of the DataStore that wraps an in-memory/local list of records allowing the data table to use features like pagination and sorting and will keep load data into the data table in append mode as we scroll to the bottom of the data table

Constructor Summary

Constructors

Constructor and Description
LocalListScrollingDataSource(int pageSize) Creates and instance with a custom page size and empty data list
LocalListScrollingDataSource(List<T> data, int pageSize) Creates and instance with an initial data list and a custom page size

Method Summary

Modifier and Type	Method and Description
List<T>	getFiltered()
RecordsSorter<T>	getRecordsSorter()
SearchFilter<T>	getSearchFilter()
void	handleEvent(TableEvent event) this store will listen to the following events
void	load() loads the data into the data table
void	onDataChanged(StoreDataChangeListener<T> dataChangeListener) Adds a listener to handle the DataChangedEvent events
void	removeDataChangeListener(StoreDataChangeListener<T> dataChangeListener) removes the listener
void	setData(List<T> data) sets new data list overriding the existing one, and clears all filters, then loads it in the data table
LocalListScrollingDataSource<T>	setRecordsSorter(RecordsSorter<T> recordsSorter) Sets the records sorting for this data store
LocalListScrollingDataSource<T>	setSearchFilter(SearchFilter<T> searchFilter) Sets a search filter, when ever the data store receives a SearchEvent it will use this search filter to filter the data list

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalListScrollingDataSource

public LocalListScrollingDataSource(int pageSize)

Creates and instance with a custom page size and empty data list

Parameters:

pageSize - int, Page size

LocalListScrollingDataSource

public LocalListScrollingDataSource(List<T> data,
                                    int pageSize)

Creates and instance with an initial data list and a custom page size

Parameters:

data - List of records

pageSize - int

Method Detail

getSearchFilter

public SearchFilter<T> getSearchFilter()

Returns:

a reference to the current applied SearchFilter if exists, otherwise return null

setSearchFilter

public LocalListScrollingDataSource<T> setSearchFilter(SearchFilter<T> searchFilter)

Sets a search filter, when ever the data store receives a SearchEvent it will use this search filter to filter the data list

Parameters:

searchFilter - SearchFilter

Returns:

same instance

getRecordsSorter

public RecordsSorter<T> getRecordsSorter()

Returns:

the RecordsSorter used in this data store

setRecordsSorter

public LocalListScrollingDataSource<T> setRecordsSorter(RecordsSorter<T> recordsSorter)

Sets the records sorting for this data store

Parameters:

recordsSorter - RecordsSorter

Returns:

same instance

setData

public void setData(List<T> data)

sets new data list overriding the existing one, and clears all filters, then loads it in the data table

Parameters:

data - the new List of records

onDataChanged

public void onDataChanged(StoreDataChangeListener<T> dataChangeListener)

Adds a listener to handle the DataChangedEvent events

Specified by:

onDataChanged in interface DataStore<T>

Parameters:

dataChangeListener - StoreDataChangeListener

removeDataChangeListener

public void removeDataChangeListener(StoreDataChangeListener<T> dataChangeListener)

removes the listener

Specified by:

removeDataChangeListener in interface DataStore<T>

Parameters:

dataChangeListener - StoreDataChangeListener

load

public void load()

loads the data into the data table

Specified by:

load in interface DataStore<T>

handleEvent

public void handleEvent(TableEvent event)

this store will listen to the following events

BodyScrollEvent

SortEvent

TablePageChangeEvent

Specified by:

handleEvent in interface TableEventListener

Parameters:

event - the TableEvent being received

getFiltered

public List<T> getFiltered()

Returns:

an immutable list obtained from the data records from the data store that match the current applied filters