LocalListDataStore (domino-ui 1.0.0-RC13 API)

java.lang.Object
- org.dominokit.domino.ui.datatable.store.LocalListDataStore<T>

Type Parameters:

T - the type of the data table records

All Implemented Interfaces:

TableEventListener, DataStore<T>
```
public class LocalListDataStore<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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LocalListDataStore.SortFunction<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LocalListDataStore.SortFunction<T>`

Constructor Summary

Constructors
Constructor and Description
`LocalListDataStore()` Creates an instance initialized with empty list
`LocalListDataStore(List<T> data)` Creates an instance initialized with a custom list of data

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRecord(T record)` adds a single record to the current list and updates the data table accordingly
`void`	`addRecords(Collection<T> records)` adds a list of records to the current list and updates the data table accordingly
`List<T>`	`getFilteredRecords()`
`HasPagination`	`getPagination()`
`List<T>`	`getRecords()`
`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`	`removeRecord(Collection<T> records)` Deprecated. use `removeRecords(java.util.Collection<T>)`
`void`	`removeRecord(T record)` removes a single record from the current list and updates the data table accordingly
`void`	`removeRecords(Collection<T> records)` removes a list of records from the current list and updates the data table accordingly
`LocalListDataStore<T>`	`setAutoSort(boolean autoSort)`
`LocalListDataStore<T>`	`setAutoSortBy(String autoSortBy)` set the default column name to initially sort the data list by.
`LocalListDataStore<T>`	`setAutoSortDirection(SortDirection autoSortDirection)` set the default sort direction to initially sort the data list by.
`void`	`setData(List<T> data)` sets new data list overriding the existing one, and clears all filters, then loads it in the data table
`LocalListDataStore<T>`	`setPagination(HasPagination pagination)` set the pagination component to be used by the data store
`LocalListDataStore<T>`	`setRecordsSorter(RecordsSorter<T> recordsSorter)` Sets the records sorting for this data store
`LocalListDataStore<T>`	`setRecordsSorter(RecordsSorter<T> recordsSorter, LocalListDataStore.SortFunction<T> sortFunction)`
`LocalListDataStore<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
`void`	`updateRecord(int index, T record)` updates a single record at a specific index in the current list and updates the data table accordingly
`void`	`updateRecord(T record)` updates existing record from the current list and updates the data table accordingly
`void`	`updateRecords(Collection<T> records)` updates existing records from the current list and updates the data table accordingly
`void`	`updateRecords(int startIndex, Collection<T> records)` updates records from the current list starting from a specific index and updates the data table accordingly

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LocalListDataStore
```
public LocalListDataStore()
```
    Creates an instance initialized with empty list
  - LocalListDataStore
```
public LocalListDataStore(List<T> data)
```
    Creates an instance initialized with a custom list of data
    
    Parameters:
    
    data - List of records
- Method Detail
  - 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
  - getSearchFilter
```
public SearchFilter<T> getSearchFilter()
```
    Returns:
    
    a reference to the current applied SearchFilter if exists, otherwise return null
  - setSearchFilter
```
public LocalListDataStore<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
  - setAutoSort
```
public LocalListDataStore<T> setAutoSort(boolean autoSort)
```
    Parameters:
    
    autoSort - if true the data store will automatically sort the data list list before loading it into the data table
    
    Returns:
    
    same instance
  - setAutoSortBy
```
public LocalListDataStore<T> setAutoSortBy(String autoSortBy)
```
    set the default column name to initially sort the data list by.
    
    Parameters:
    
    autoSortBy - String, the name of initial sort column
    
    Returns:
    
    same instance
  - setAutoSortDirection
```
public LocalListDataStore<T> setAutoSortDirection(SortDirection autoSortDirection)
```
    set the default sort direction to initially sort the data list by.
    
    Parameters:
    
    autoSortDirection - SortDirection
    
    Returns:
    
    same instance
  - getPagination
```
public HasPagination getPagination()
```
    Returns:
    
    the HasPagination component used in this data store
  - setPagination
```
public LocalListDataStore<T> setPagination(HasPagination pagination)
```
    set the pagination component to be used by the data store
    
    Parameters:
    
    pagination - HasPagination
    
    Returns:
    
    same instance
  - getRecordsSorter
```
public RecordsSorter<T> getRecordsSorter()
```
    Returns:
    
    the RecordsSorter used in this data store
  - setRecordsSorter
```
public LocalListDataStore<T> setRecordsSorter(RecordsSorter<T> recordsSorter)
```
    Sets the records sorting for this data store
    
    Parameters:
    
    recordsSorter - RecordsSorter
    
    Returns:
    
    same instance
  - setRecordsSorter
```
public LocalListDataStore<T> setRecordsSorter(RecordsSorter<T> recordsSorter,
                                              LocalListDataStore.SortFunction<T> sortFunction)
```
  - 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
  - handleEvent
```
public void handleEvent(TableEvent event)
```
    this store will listen to the following events
```
SearchEvent
```
```
SortEvent
```
```
TablePageChangeEvent
```
    Specified by:
    
    handleEvent in interface TableEventListener
    
    Parameters:
    
    event - the TableEvent being received
  - load
```
public void load()
```
    loads the data into the data table
    
    Specified by:
    
    load in interface DataStore<T>
  - addRecord
```
public void addRecord(T record)
```
    adds a single record to the current list and updates the data table accordingly
    
    Parameters:
    
    record - T the new record being added
  - removeRecord
```
public void removeRecord(T record)
```
    removes a single record from the current list and updates the data table accordingly
    
    Parameters:
    
    record - T the record being removed
  - updateRecord
```
public void updateRecord(T record)
```
    updates existing record from the current list and updates the data table accordingly
    
    Parameters:
    
    record - T the record being updated
  - updateRecord
```
public void updateRecord(int index,
                         T record)
```
    updates a single record at a specific index in the current list and updates the data table accordingly
    
    Parameters:
    
    record - T the record being updated
    
    index - the index of the record to be updated
  - updateRecords
```
public void updateRecords(Collection<T> records)
```
    updates existing records from the current list and updates the data table accordingly
    
    Parameters:
    
    records - records to be updated
  - updateRecords
```
public void updateRecords(int startIndex,
                          Collection<T> records)
```
    updates records from the current list starting from a specific index and updates the data table accordingly
    While updating the records, if the index is out of range then the process will stop.
    
    Parameters:
    
    records - records to be updated
  - addRecords
```
public void addRecords(Collection<T> records)
```
    adds a list of records to the current list and updates the data table accordingly
    
    Parameters:
    
    records - Collection of records
  - removeRecord
```
@Deprecated
public void removeRecord(Collection<T> records)
```
    Deprecated. use removeRecords(java.util.Collection<T>)
  - removeRecords
```
public void removeRecords(Collection<T> records)
```
    removes a list of records from the current list and updates the data table accordingly
    
    Parameters:
    
    records - Collection of records
  - getRecords
```
public List<T> getRecords()
```
    Returns:
    
    an immutable list obtained from the data records from the data store
  - getFilteredRecords
```
public List<T> getFilteredRecords()
```
    Returns:
    
    an immutable list obtained from the data records from the data store that match the current applied filters

Class LocalListDataStore<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocalListDataStore

LocalListDataStore

Method Detail

setData

getSearchFilter

setSearchFilter

setAutoSort

setAutoSortBy

setAutoSortDirection

getPagination

setPagination

getRecordsSorter

setRecordsSorter

setRecordsSorter

onDataChanged

removeDataChangeListener

handleEvent

load

addRecord

removeRecord

updateRecord

updateRecord

updateRecords

updateRecords

addRecords

removeRecord

removeRecords

getRecords

getFilteredRecords