org.dominokit.domino.ui.datatable.model

Class SearchContext<T>

java.lang.Object

org.dominokit.domino.ui.datatable.model.SearchContext<T>

Type Parameters:

T - the type of data table records

public class SearchContext<T>
extends Object

A class to represent the current search and filter state of the datatable

Constructor Summary

Constructors

Constructor and Description
SearchContext(DataTable<T> dataTable) Initialize the context with a datatable

Method Summary

Modifier and Type	Method and Description
SearchContext	add(Filter filter) Adds a new filter to the search context
void	addBeforeSearchHandler(Consumer<SearchContext<T>> handler) Adds a new BeforeSearch handler
SearchContext	clear() Remove all filters and fires the SearchClearedEvent
boolean	contains(Filter filter) Checks if the context contains the specified filter
void	fireSearchEvent() Call all the before search handlers and then fire the SearchEvent
List<Filter>	get(String fieldName)
List<Filter>	listAll()
SearchContext	remove(Filter filter) Removes a filter from the context
SearchContext	remove(String fieldName) Removes all filters associated with the specified field name from the context
SearchContext	remove(String fieldName, Category category) Removes all filters associated with the specified field name and of the specified category from the context
void	removeBeforeSearchHandler(Consumer<SearchContext<T>> handler) removes a BeforeSearch handler
SearchContext	removeByCategory(Category category) Removes all filters of the specified category from the context

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchContext

public SearchContext(DataTable<T> dataTable)

Initialize the context with a datatable

Parameters:

dataTable - the DataTable that is linked to this context

Method Detail

add

public SearchContext add(Filter filter)

Adds a new filter to the search context

Parameters:

filter - Filter

Returns:

same SearchContext instance

remove

public SearchContext remove(Filter filter)

Removes a filter from the context

Parameters:

filter - Filter

Returns:

same SearchContext instance

remove

public SearchContext remove(String fieldName)

Removes all filters associated with the specified field name from the context

Parameters:

fieldName - String field name

Returns:

same SearchContext instance

remove

public SearchContext remove(String fieldName,
                            Category category)

Removes all filters associated with the specified field name and of the specified category from the context

Parameters:

fieldName - String field name

category - Category

Returns:

same SearchContext instance

removeByCategory

public SearchContext removeByCategory(Category category)

Removes all filters of the specified category from the context

Parameters:

category - Category

Returns:

same SearchContext instance

clear

public SearchContext clear()

Remove all filters and fires the SearchClearedEvent

Returns:

same SearchContext instance

get

public List<Filter> get(String fieldName)

Parameters:

fieldName - String field name

Returns:

a List of all Filters associated with the specified field name

listAll

public List<Filter> listAll()

Returns:

a new List of all filters

contains

public boolean contains(Filter filter)

Checks if the context contains the specified filter

Parameters:

filter - Filter

Returns:

boolean, true if the context contains the filter, otherwise false

fireSearchEvent

public void fireSearchEvent()

Call all the before search handlers and then fire the SearchEvent

addBeforeSearchHandler

public void addBeforeSearchHandler(Consumer<SearchContext<T>> handler)

Adds a new BeforeSearch handler

Parameters:

handler - Consumer of SearchContext

removeBeforeSearchHandler

public void removeBeforeSearchHandler(Consumer<SearchContext<T>> handler)

removes a BeforeSearch handler

Parameters:

handler - Consumer of SearchContext