com.alee.extended.tree

Class AbstractExTreeDataProvider<N extends UniqueNode>

java.lang.Object

com.alee.extended.tree.AbstractExTreeDataProvider<N>

Type Parameters:

N - node type

All Implemented Interfaces:

ExTreeDataProvider<N>, Serializable

Direct Known Subclasses:

InterfaceTreeDataProvider

public abstract class AbstractExTreeDataProvider<N extends UniqueNode>
extends Object
implements ExTreeDataProvider<N>

Abstract ExTreeDataProvider that can contain single comparator and filter for child nodes.

Author:

Mikle Garin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Comparator<N>	comparator Comparator for all child nodes.
protected Filter<N>	filter Filter for all child nodes.

Constructor Summary

Constructors

Constructor and Description
AbstractExTreeDataProvider()

Method Summary

Modifier and Type	Method and Description
WebTreeModel<N>	createPlainModel() Returns plain WebTreeModel with data from this AbstractExTreeDataProvider implementation.
Comparator<N>	getChildrenComparator(N parent, List<N> children) Returns Comparator that will be used for the specified UniqueNode children.
Filter<N>	getChildrenFilter(N parent, List<N> children) Returns Filter that will be used for the specified UniqueNode children.
protected void	loadPlainChildren(N parent) Loads all child UniqueNodes for the specified parent UniqueNode recursively.
void	setChildrenComparator(Comparator<N> comparator) Sets children comparator for all nodes.
void	setChildrenFilter(Filter<N> filter) Sets children filter for all nodes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alee.extended.tree.ExTreeDataProvider

getChildren, getRoot

Field Detail

filter

@Nullable
protected transient Filter<N extends UniqueNode> filter

Filter for all child nodes. It is transient as it can only be set through code. Override getChildrenFilter(UniqueNode, List) method to provide parent-related Filter.

comparator

@Nullable
protected transient Comparator<N extends UniqueNode> comparator

Comparator for all child nodes. It is transient as it can only be set through code. Override getChildrenComparator(UniqueNode, List) method to provide parent-related Comparator.

Constructor Detail

AbstractExTreeDataProvider

public AbstractExTreeDataProvider()

Method Detail

getChildrenFilter

@Nullable
public Filter<N> getChildrenFilter(@NotNull
                                             N parent,
                                             @NotNull
                                             List<N> children)

Description copied from interface: ExTreeDataProvider

Returns Filter that will be used for the specified UniqueNode children. Specific List of child UniqueNodes is given for every separate filter operation. No filtering applied to children in case null is returned. This operation is always performed on EDT and should not take excessive amounts of time.

Specified by:

getChildrenFilter in interface ExTreeDataProvider<N extends UniqueNode>

Parameters:

parent - UniqueNode which children will be filtered using returned Filter

children - UniqueNodes to be filtered

Returns:

Filter that will be used for the specified UniqueNode children

See Also:

Event Dispatch Thread

setChildrenFilter

public void setChildrenFilter(@Nullable
                              Filter<N> filter)

Sets children filter for all nodes.

Parameters:

filter - children filter for all nodes

getChildrenComparator

@Nullable
public Comparator<N> getChildrenComparator(@NotNull
                                                     N parent,
                                                     @NotNull
                                                     List<N> children)

Description copied from interface: ExTreeDataProvider

Returns Comparator that will be used for the specified UniqueNode children. Specific List of child UniqueNodes is given for every separate comparison operation. No sorting applied to children in case null is returned. This operation is always performed on EDT and should not take excessive amounts of time.

Specified by:

getChildrenComparator in interface ExTreeDataProvider<N extends UniqueNode>

Parameters:

parent - UniqueNode which children will be sorted using returned Comparator

children - UniqueNodes to be sorted

Returns:

Comparator that will be used for the specified UniqueNode children

See Also:

Event Dispatch Thread

setChildrenComparator

public void setChildrenComparator(@Nullable
                                  Comparator<N> comparator)

Sets children comparator for all nodes.

Parameters:

comparator - children comparator for all nodes

createPlainModel

@NotNull
public WebTreeModel<N> createPlainModel()

Returns plain WebTreeModel with data from this AbstractExTreeDataProvider implementation.

Returns:

plain WebTreeModel with data from this AbstractExTreeDataProvider implementation

loadPlainChildren

protected void loadPlainChildren(@NotNull
                                 N parent)

Loads all child UniqueNodes for the specified parent UniqueNode recursively.

Parameters:

parent - parent UniqueNode to load all children for recursively