Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractEntityTreeModelBuilder<B extends EntityTreeModel.Builder<B>>

java.lang.Object

is.codion.framework.model.AbstractEntityTreeModelBuilder<B>

Type Parameters:

B - the builder type

All Implemented Interfaces:

FilterTreeModel.Builder<Entity,B>, EntityTreeModel.Builder<B>

public abstract class AbstractEntityTreeModelBuilder<B extends EntityTreeModel.Builder<B>>
extends Object
implements EntityTreeModel.Builder<B>

A base class for EntityTreeModel.Builder implementations. A toolkit builder extends this class, overriding build() to build its own model, based on AbstractEntityTreeModel.

See Also:

• AbstractEntityTreeModel

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.framework.model.EntityTreeModel.Builder

EntityTreeModel.Builder.Children, EntityTreeModel.Builder.ConnectionStep, EntityTreeModel.Builder.Roots, EntityTreeModel.Builder.RootsStep

Nested classes/interfaces inherited from interface is.codion.common.model.component.tree.FilterTreeModel.Builder

FilterTreeModel.Builder.ChildrenStep<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityTreeModelBuilder(EntityType rootType, Consumer<EntityTreeModel.Builder.Roots> roots, EntityConnection connection)

Method Summary

Modifier and Type	Method	Description
EntityTreeModel	build()
final B	children(ForeignKey foreignKey)	Adds the entities referencing a node via the given foreign key as its children, for the nodes of the referenced entity type.
final B	children(ForeignKey foreignKey, Consumer<EntityTreeModel.Builder.Children> children)	Adds the entities referencing a node via the given foreign key as its children, see EntityTreeModel.Builder.children(ForeignKey), configuring the query selecting them.
final B	comparator(@Nullable Comparator<Entity> comparator)	Specifies the comparator for the roots, and the children via each foreign key, which specify neither a comparator nor an order by, in place of the comparator of their entity type, null for the query order.
final B	comparators(Function<NodePath<Entity>,@Nullable Comparator<Entity>> comparators)	Replaces the ordering of siblings entirely, the roots, the foreign key comparators and order bys, and the entity type comparators.
final B	included(Predicate<NodePath<Entity>> included)
final B	leaf(Predicate<NodePath<Entity>> leaf)	Replaces the default leaf detection, see EntityTreeModel.Builder.leaves(Function), with a function deciding node by node, based on a domain attribute for example.
final B	leaves(Function<List<NodePath<Entity>>,Collection<NodePath<Entity>>> leaves)	Replaces the default leaf detection, which queries for the siblings referenced via the configured foreign keys, a node of an entity type no configured foreign key references always being a leaf.
final B	onLoadException(Consumer<Exception> onLoadException)	By default, exceptions during loading are rethrown, use this method to handle async exceptions differently
final B	onSelectedIndex(Consumer<Integer> index)
final B	onSelectedIndexes(Consumer<List<Integer>> indexes)
final B	onSelectedItem(Consumer<Entity> item)
final B	onSelectedItems(Consumer<List<Entity>> items)
final B	onSelectedPath(Consumer<NodePath<Entity>> path)
final B	onSelectedPaths(Consumer<List<NodePath<Entity>>> paths)
final B	onSelectionChanged(Runnable listener)
final B	path(Function<Entity,@Nullable NodePath<Entity>> path)	The path function, the inverse of the children function, providing the path of the node holding an item, so that an item not yet in the model, its parent not loaded, can be selected via TreeSelection.item() or TreeSelection.items(), which expand its ancestors, loading them, as for an item below a collapsed ancestor.
final B	refresh(boolean refresh)
protected final B	self()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEntityTreeModelBuilder

protected AbstractEntityTreeModelBuilder(EntityType rootType,
 Consumer<EntityTreeModel.Builder.Roots> roots,
 EntityConnection connection)

Parameters:

rootType - the type of the root entities

roots - configures the roots

connection - the connection

Method Details

children

public final B children(ForeignKey foreignKey)

Description copied from interface: EntityTreeModel.Builder

Adds the entities referencing a node via the given foreign key as its children, for the nodes of the referenced entity type. A foreign key referencing its own entity type applies at every level.

Specified by:

children in interface EntityTreeModel.Builder<B extends EntityTreeModel.Builder<B>>

Parameters:

foreignKey - the foreign key

Returns:

this builder instance

See Also:

• EntityTreeModel.Builder.build()

children

public final B children(ForeignKey foreignKey,
 Consumer<EntityTreeModel.Builder.Children> children)

Description copied from interface: EntityTreeModel.Builder

Adds the entities referencing a node via the given foreign key as its children, see EntityTreeModel.Builder.children(ForeignKey), configuring the query selecting them. A condition is combined with the foreign key condition, and applies when finding which nodes have children as well.

builder.children(Employee.REPORTSTO_FK, children -> children
        .condition(() -> Employee.EMAIL.isNotNull())
        .select(select -> select.referenceDepth(0)));

Specified by:

children in interface EntityTreeModel.Builder<B extends EntityTreeModel.Builder<B>>

Parameters:

foreignKey - the foreign key

children - configures the query selecting the children

Returns:

this builder instance

See Also:

• EntityTreeModel.Builder.Children

leaves

public final B leaves(Function<List<NodePath<Entity>>,Collection<NodePath<Entity>>> leaves)

Description copied from interface: EntityTreeModel.Builder

Replaces the default leaf detection, which queries for the siblings referenced via the configured foreign keys, a node of an entity type no configured foreign key references always being a leaf.

The leaves function decides which nodes not yet loaded are leaves, a loaded node being a leaf when it has no included children. Without one, a node not yet loaded is not a leaf, so a view displays an expand handle until it is loaded.

It is given the nodes not yet loaded among the items the roots supplier or the children function return, all of a node's children at once, so it can find the leaves among them with a single query, and returns those which are leaves. It is called along with the children function, so on a background thread when loading asynchronously, its result kept until a refresh reaches the nodes. A view asking whether a node is a leaf does not call it, so it may be slow. FilterTreeModel.Nodes.add(NodePath, Collection) calls it with the nodes added, and FilterTreeModel.Nodes.replace(NodePath, Object) with the node replaced, on the calling thread.

A node not yet loaded, which the leaves function reports as a leaf, is not loaded when expanded, so the children function is not called for it, nor when refreshed, unless the leaves function, called for it again, no longer reports it as a leaf, see FilterTreeModel.Nodes.refresh(NodePath).

Replaces the function set via FilterTreeModel.Builder.leaf(Predicate), the same option.

Specified by:

leaves in interface EntityTreeModel.Builder<B extends EntityTreeModel.Builder<B>>

Specified by:

leaves in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

leaves - the leaves function

Returns:

this builder instance

See Also:

• FilterTreeModel.Nodes.leaf(NodePath)

leaf

public final B leaf(Predicate<NodePath<Entity>> leaf)

Description copied from interface: EntityTreeModel.Builder

Replaces the default leaf detection, see EntityTreeModel.Builder.leaves(Function), with a function deciding node by node, based on a domain attribute for example.

The leaves function, node by node, for when a node can tell whether it is a leaf on its own, from its item for example, see FilterTreeModel.Builder.leaves(Function).

Replaces the function set via FilterTreeModel.Builder.leaves(Function), the same option.

Specified by:

leaf in interface EntityTreeModel.Builder<B extends EntityTreeModel.Builder<B>>

Specified by:

leaf in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

leaf - the leaf function

Returns:

this builder instance

See Also:

• FilterTreeModel.Nodes.leaf(NodePath)

path

public final B path(Function<Entity,@Nullable NodePath<Entity>> path)

Description copied from interface: FilterTreeModel.Builder

The path function, the inverse of the children function, providing the path of the node holding an item, so that an item not yet in the model, its parent not loaded, can be selected via TreeSelection.item() or TreeSelection.items(), which expand its ancestors, loading them, as for an item below a collapsed ancestor.

Called on the UI thread, for the items not in the model only. The item is selected right away when loading synchronously, while loading asynchronously only its ancestors are expanded, TreeSelection.set(NodePath) selecting a node once it is loaded.

Specified by:

path in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

path - returns the path of the node holding the given item, null in case it is not in the tree

Returns:

this builder instance

See Also:

• TreeSelection.item()

comparator

public final B comparator(@Nullable Comparator<Entity> comparator)

Description copied from interface: EntityTreeModel.Builder

Specifies the comparator for the roots, and the children via each foreign key, which specify neither a comparator nor an order by, in place of the comparator of their entity type, null for the query order. Siblings of different entity types are ordered by type, in the order their foreign keys were configured.

Replaces the comparators specified via EntityTreeModel.Builder.comparators(Function), the last one set winning.

Specified by:

comparator in interface EntityTreeModel.Builder<B extends EntityTreeModel.Builder<B>>

Specified by:

comparator in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

comparator - the comparator, null for the query order

Returns:

this builder instance

See Also:

• EntityTreeModel.Builder.Roots.comparator(Comparator)
• EntityTreeModel.Builder.Children.comparator(Comparator)

comparators

public final B comparators(Function<NodePath<Entity>,@Nullable Comparator<Entity>> comparators)

Description copied from interface: EntityTreeModel.Builder

Replaces the ordering of siblings entirely, the roots, the foreign key comparators and order bys, and the entity type comparators.

Specifies the comparator to use when sorting the children of each parent, given the path of the parent, the root path for the top level, a null comparator leaving the children in the order the children function returned them in.

Called each time the children of a parent are sorted, when they are loaded, added, replaced, refreshed or excluded, or when the sort order changes. Sets the same option as FilterTreeModel.Builder.comparator(Comparator), so the last one set wins.

Specified by:

comparators in interface EntityTreeModel.Builder<B extends EntityTreeModel.Builder<B>>

Specified by:

comparators in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

comparators - provides the comparator for the children of a parent, given its path

Returns:

this builder instance

See Also:

• FilterTreeModel.sort()

included

public final B included(Predicate<NodePath<Entity>> included)

Specified by:

included in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

included - the predicate controlling which nodes are included

Returns:

this builder instance

See Also:

• FilterTreeModel.Nodes.predicate()

onLoadException

public final B onLoadException(Consumer<Exception> onLoadException)

Description copied from interface: FilterTreeModel.Builder

By default, exceptions during loading are rethrown, use this method to handle async exceptions differently

Specified by:

onLoadException in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

onLoadException - the exception handler to use during loading

Returns:

this builder instance

refresh

public final B refresh(boolean refresh)

Specified by:

refresh in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

refresh - true if the model should be refreshed on initialization, false by default

Returns:

this builder instance

onSelectionChanged

public final B onSelectionChanged(Runnable listener)

Specified by:

onSelectionChanged in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

listener - the selection listener

Returns:

this builder instance

onSelectedItem

public final B onSelectedItem(Consumer<Entity> item)

Specified by:

onSelectedItem in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

item - receives the item of the selected node

Returns:

this builder instance

See Also:

• TreeSelection.item()

onSelectedItems

public final B onSelectedItems(Consumer<List<Entity>> items)

Specified by:

onSelectedItems in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

items - receives the items of the selected nodes

Returns:

this builder instance

See Also:

• TreeSelection.items()

onSelectedPath

public final B onSelectedPath(Consumer<NodePath<Entity>> path)

Specified by:

onSelectedPath in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

path - receives the path of the selected node

Returns:

this builder instance

See Also:

• TreeSelection.path()

onSelectedPaths

public final B onSelectedPaths(Consumer<List<NodePath<Entity>>> paths)

Specified by:

onSelectedPaths in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

paths - receives the paths of the selected nodes

Returns:

this builder instance

See Also:

• TreeSelection.paths()

onSelectedIndex

public final B onSelectedIndex(Consumer<Integer> index)

Specified by:

onSelectedIndex in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

index - receives the selected index

Returns:

this builder instance

onSelectedIndexes

public final B onSelectedIndexes(Consumer<List<Integer>> indexes)

Specified by:

onSelectedIndexes in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Parameters:

indexes - receives the selected indexes

Returns:

this builder instance

build

public EntityTreeModel build()

Specified by:

build in interface EntityTreeModel.Builder<B extends EntityTreeModel.Builder<B>>

Specified by:

build in interface FilterTreeModel.Builder<Entity,B extends EntityTreeModel.Builder<B>>

Returns:

a new EntityTreeModel instance

self

protected final B self()

Returns:

this builder instance