org.dominokit.domino.ui.tag.store

Interface TagsStore<V>

Type Parameters:

V - the type of the value

All Known Implementing Classes:

DynamicLocalTagsStore, LocalTagsStore, OrderedLocalTagsStore, SimpleLocalTagsStore

public interface TagsStore<V>

A store for saving, loading and filtering a list of items that will be used in TagsStore

Method Summary

Modifier and Type	Method and Description
TagsStore<V>	addItem(String displayValue, V item) Adds a new item with its display value
TagsStore<V>	addItems(Map<String,V> items) Adds a list of items with their display values
TagsStore<V>	clear() Clears the store
Map<String,V>	filter(String searchValue) Filters the items based on the search query
String	getDisplayValue(V value)
V	getItemByDisplayValue(String displayValue)
Map<String,V>	getItems()
TagsStore<V>	removeItem(V item) Removes item from the store

Method Detail

addItem

TagsStore<V> addItem(String displayValue,
                     V item)

Adds a new item with its display value

Parameters:

displayValue - the display value that will be presented when selecting this item

item - the item

Returns:

same instance

removeItem

TagsStore<V> removeItem(V item)

Removes item from the store

Parameters:

item - the item

Returns:

same instance

clear

TagsStore<V> clear()

Clears the store

Returns:

same instance

addItems

TagsStore<V> addItems(Map<String,V> items)

Adds a list of items with their display values

Parameters:

items - a map representing the display value and the item

Returns:

same instance

getItems

Map<String,V> getItems()

Returns:

all the items in the store with their display values

getItemByDisplayValue

V getItemByDisplayValue(String displayValue)

Parameters:

displayValue - the display value to search for

Returns:

the item represented by the displayValue

filter

Map<String,V> filter(String searchValue)

Filters the items based on the search query

Parameters:

searchValue - the query

Returns:

the filtered items with their display values

getDisplayValue

String getDisplayValue(V value)

Parameters:

value - the item to get the display value for

Returns:

the display value of the item