Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractEntityTreeModel<M extends FilterTreeModel<Entity>>

java.lang.Object

is.codion.framework.model.AbstractEntityTreeModel<M>

Type Parameters:

M - the type of the underlying tree model

All Implemented Interfaces:

FilterTreeModel<Entity>, EntityTreeModel

public abstract class AbstractEntityTreeModel<M extends FilterTreeModel<Entity>>
extends Object
implements EntityTreeModel

A base class for EntityTreeModel implementations, based on a tree model built by a toolkit, a javax.swing.tree.TreeModel based one for example, the entity tree logic, the queries, living here.

The FilterTreeModel methods delegate to the tree model, see treeModel().

See Also:

• AbstractEntityTreeModelBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractEntityTreeModel.TreeModelBuilder<M extends FilterTreeModel<Entity>>	Builds the underlying tree model of an EntityTreeModel.

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

EntityTreeModel.Builder<B extends EntityTreeModel.Builder<B>>

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

FilterTreeModel.Expansion<T>, FilterTreeModel.Loader<T>, FilterTreeModel.Nodes<T>, FilterTreeModel.NodesListener<T>, FilterTreeModel.VisibleNodes<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityTreeModel(AbstractEntityTreeModelBuilder<?> builder, AbstractEntityTreeModel.TreeModelBuilder<M> treeModel)

Method Summary

Modifier and Type	Method	Description
final EntityConnection	connection()
final FilterTreeModel.Expansion<Entity>	expansion()
final FilterTreeModel.Nodes<Entity>	nodes()
TreeSelection<Entity>	selection()	The selection, over the FilterTreeModel.visible() nodes, by item, with TreeSelection.paths() addressing particular nodes, the same item appearing in several places.
final FilterTreeSort<Entity>	sort()
String	toString()
protected final M	treeModel()
final FilterTreeModel.VisibleNodes<Entity>	visible()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEntityTreeModel

protected AbstractEntityTreeModel(AbstractEntityTreeModelBuilder<?> builder,
 AbstractEntityTreeModel.TreeModelBuilder<M> treeModel)

Parameters:

builder - the builder

treeModel - builds the underlying tree model

Method Details

connection

public final EntityConnection connection()

Specified by:

connection in interface EntityTreeModel

Returns:

the connection used by this tree model

nodes

public final FilterTreeModel.Nodes<Entity> nodes()

Specified by:

nodes in interface FilterTreeModel<M extends FilterTreeModel<Entity>>

Returns:

the FilterTreeModel.Nodes providing the structure, loading, mutation and filtering

expansion

public final FilterTreeModel.Expansion<Entity> expansion()

Specified by:

expansion in interface FilterTreeModel<M extends FilterTreeModel<Entity>>

Returns:

the FilterTreeModel.Expansion controlling the expanded nodes

visible

public final FilterTreeModel.VisibleNodes<Entity> visible()

Specified by:

visible in interface FilterTreeModel<M extends FilterTreeModel<Entity>>

Returns:

the FilterTreeModel.VisibleNodes, the rows a view displays

selection

public TreeSelection<Entity> selection()

Description copied from interface: FilterTreeModel

The selection, over the FilterTreeModel.visible() nodes, by item, with TreeSelection.paths() addressing particular nodes, the same item appearing in several places. Selecting a node hidden below a collapsed ancestor expands its ancestors, and a node not yet loaded is selected via TreeSelection.set(NodePath).

The selection is kept by path, through refreshes, filtering, sorting and expansion. A selected node hidden by collapsing one of its ancestors is replaced by its nearest visible ancestor, and one removed or excluded is dropped from the selection.

Specified by:

selection in interface FilterTreeModel<M extends FilterTreeModel<Entity>>

Returns:

the selection

sort

public final FilterTreeSort<Entity> sort()

Specified by:

sort in interface FilterTreeModel<M extends FilterTreeModel<Entity>>

Returns:

the FilterTreeSort instance used by this model

toString

public String toString()

Overrides:

toString in class Object

treeModel

protected final M treeModel()

Returns:

the underlying tree model