Module is.codion.common.model

Package is.codion.common.model.filter

Interface FilterModel.Items<T>

Type Parameters:

T - the item type

All Known Subinterfaces:

FilterComboBoxModel.ComboBoxItems<T>

Enclosing interface:

FilterModel<T>

public static interface FilterModel.Items<T>

Manages the items in FilterModel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FilterModel.Items.Builder<T>	Builds a FilterModel.Items instance

Method Summary

Modifier and Type	Method	Description
void	add(Collection<T> items)	Adds the given items to this model.
void	add(T item)	Adds the given item to this model.
static FilterModel.Items.Builder.RefresherStep	builder()
void	clear()	Clears the items
boolean	contains(T item)	Returns true if the model contain the given item, as included or filtered.
void	filter()	Filters the items according to the FilterModel.IncludedItems.predicate().
FilterModel.FilteredItems<T>	filtered()
Collection<T>	get()
FilterModel.IncludedItems<T>	included()
void	refresh()	Refreshes the data in this model using its FilterModel.Refresher.
void	refresh(Consumer<Collection<T>> onResult)	Refreshes the data in this model using its FilterModel.Refresher.
FilterModel.Refresher<T>	refresher()
void	remove(Collection<T> items)	Removes the given items from this model.
void	remove(Predicate<T> predicate)	Removes the items fulfilling the given predicate from this model.
void	remove(T item)	Removes the given item from this model.
void	replace(Map<T,T> replacements)	Replaces the given map keys with their respective values.
void	replace(T item, T replacement)	Replaces the first occurrence of the given item.
void	set(Collection<T> items)	It is up to the implementation whether the included items are sorted when the items are set.
int	size()

Method Details

refresher

FilterModel.Refresher<T> refresher()

Returns:

this models FilterModel.Refresher instance

refresh

void refresh()

Refreshes the data in this model using its FilterModel.Refresher.

Retains the selection and filtering. Sorts the refreshed data.

See Also:

• FilterModel.Refresher.active()
• FilterModel.Refresher.result()
• FilterModel.Refresher.async()

refresh

void refresh(Consumer<Collection<T>> onResult)

Refreshes the data in this model using its FilterModel.Refresher.

Retains the selection and filtering. Sorts the refreshed data.

Parameters:

onResult - called on the EDT after a successful refresh

See Also:

• FilterModel.Refresher.active()
• FilterModel.Refresher.result()
• FilterModel.Refresher.async()

get

Collection<T> get()

Returns:

all items, included and filtered, in no particular order

set

void set(Collection<T> items)

It is up to the implementation whether the included items are sorted when the items are set.

Parameters:

items - the items

add

void add(T item)

Adds the given item to this model.

If the item passes the FilterModel.IncludedItems.predicate() it is appended to the included items, which are then sorted if sorting is enabled.

If the item does not pass the FilterModel.IncludedItems.predicate(), it will be filtered right away.

Parameters:

item - the item to add

add

void add(Collection<T> items)

Adds the given items to this model.

Items that pass the FilterModel.IncludedItems.predicate() are is appended to the included items, which are then sorted if sorting is enabled.

If no items pass the FilterModel.IncludedItems.predicate(), they will be filtered right away.

Parameters:

items - the items to add

remove

void remove(T item)

Removes the given item from this model.

Parameters:

item - the item to remove from the model

remove

void remove(Collection<T> items)

Removes the given items from this model.

Parameters:

items - the items to remove from the model

remove

void remove(Predicate<T> predicate)

Removes the items fulfilling the given predicate from this model.

Parameters:

predicate - the Predicate specifying the items to remove from the model

replace

void replace(T item,
 T replacement)

Replaces the first occurrence of the given item. If the item is not found this method has no effect.

Note that this method respects the include predicate, so a currently filtered item may be replaced with an included item and vice verse.

If the included items change they are sorted if sorting is enabled.

Parameters:

item - the item to replace

replacement - the replacement item

See Also:

• FilterModel.IncludedItems.predicate()

replace

void replace(Map<T,T> replacements)

Replaces the given map keys with their respective values.

Note that this method respects the include predicate, so a currently filtered item may be replaced with an included item and vice verse.

If the included items change they are sorted if sorting is enabled.

Parameters:

replacements -

clear

void clear()

Clears the items

included

FilterModel.IncludedItems<T> included()

Returns:

a FilterModel.IncludedItems providing access to the included items, in the order they appear in the model

filtered

FilterModel.FilteredItems<T> filtered()

Returns:

a FilterModel.FilteredItems providing access to the filtered items

contains

boolean contains(T item)

Returns true if the model contain the given item, as included or filtered.

Parameters:

item - the item

Returns:

true if this model contains the item

size

int size()

Returns:

the total number of items, included and filtered

filter

void filter()

Filters the items according to the FilterModel.IncludedItems.predicate().

If no predicate is specified calling this method has no effect.

This method does not interfere with the internal ordering of the included items.

See Also:

• FilterModel.IncludedItems.predicate()

builder

static FilterModel.Items.Builder.RefresherStep builder()

Returns:

a new FilterModel.Items.Builder.RefresherStep instance