com.alee.extended.tree

Class StructuredTreeNodesFilter<E extends UniqueNode>

java.lang.Object

com.alee.extended.tree.StructuredTreeNodesFilter<E>

All Implemented Interfaces:

com.alee.utils.compare.Filter<E>

public class StructuredTreeNodesFilter<E extends UniqueNode>
extends java.lang.Object
implements com.alee.utils.compare.Filter<E>

Special smart tree filter that doesn't filter out parent nodes which has children that are accepted by filter. This can be used in any kind of filter fields to provide a proper visual feedback in tree.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Boolean>	acceptStatesCache Accept states by node IDs cache.
protected boolean	matchCase Whether should match case or not.
protected com.alee.utils.compare.Filter<E>	originalFilter Original tree filter.
protected boolean	searchFromStart Whether should search from node text beginning or not.
protected java.lang.String	searchText Search request text.
protected com.alee.utils.text.TextProvider<E>	textProvider Nodes text provider.
protected boolean	useSpaceAsSeparator Whether should use space character as requests separator or not.

Constructor Summary

Constructors

Constructor and Description
StructuredTreeNodesFilter()

Method Summary

Modifier and Type	Method and Description
boolean	accept(E node)
protected boolean	accept(java.lang.String nodeText, java.lang.String searchRequest, boolean searchFromStart) Returns whether filter accepts specified node text or not.
protected boolean	acceptIncludingChildren(E node, java.lang.String searchRequest) Returns whether the specified node or any of its children match the filter or not.
protected boolean	acceptNode(E node, java.lang.String searchRequest) Returns whether the specified node matches the filter or not.
protected boolean	acceptNodeImpl(E node, java.lang.String searchRequest) Returns whether the specified node matches the filter or not.
void	clearCache() Clears accept states cache.
void	clearCache(E node) Clears specific node accept state cache.
void	clearCache(java.lang.String nodeId) Clears specific node accept state cache.
com.alee.utils.compare.Filter<E>	getOriginalFilter() Returns original tree filter.
java.lang.String	getSearchText() Returns search request text.
com.alee.utils.text.TextProvider<E>	getTextProvider() Returns nodes text provider.
boolean	isMatchCase() Returns whether should match case or not.
boolean	isSearchFromStart() Returns whether should search from node text beginning or not.
boolean	isUseSpaceAsSeparator() Returns whether should use space character as requests separator or not.
void	setMatchCase(boolean matchCase) Returns whether should match case or not.
void	setOriginalFilter(com.alee.utils.compare.Filter<E> filter) Sets original tree filter.
void	setSearchFromStart(boolean searchFromStart) Sets whether should search from node text beginning or not.
void	setSearchText(java.lang.String searchText) Sets search request text.
void	setTextProvider(com.alee.utils.text.TextProvider<E> textProvider) Sets nodes text provider.
void	setUseSpaceAsSeparator(boolean useSpaceAsSeparator) Sets whether should use space character as requests separator or not.

Methods inherited from class java.lang.Object

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

Field Detail

originalFilter

protected com.alee.utils.compare.Filter<E extends UniqueNode> originalFilter

Original tree filter.

textProvider

protected com.alee.utils.text.TextProvider<E extends UniqueNode> textProvider

Nodes text provider.

acceptStatesCache

protected java.util.Map<java.lang.String,java.lang.Boolean> acceptStatesCache

Accept states by node IDs cache.

matchCase

protected boolean matchCase

Whether should match case or not.

useSpaceAsSeparator

protected boolean useSpaceAsSeparator

Whether should use space character as requests separator or not.

searchFromStart

protected boolean searchFromStart

Whether should search from node text beginning or not.

searchText

protected java.lang.String searchText

Search request text.

Constructor Detail

StructuredTreeNodesFilter

public StructuredTreeNodesFilter()

Method Detail

getOriginalFilter

public com.alee.utils.compare.Filter<E> getOriginalFilter()

Returns original tree filter.

Returns:

original tree filter

setOriginalFilter

public void setOriginalFilter(com.alee.utils.compare.Filter<E> filter)

Sets original tree filter.

Parameters:

filter - original tree filter

getTextProvider

public com.alee.utils.text.TextProvider<E> getTextProvider()

Returns nodes text provider.

Returns:

nodes text provider

setTextProvider

public void setTextProvider(com.alee.utils.text.TextProvider<E> textProvider)

Sets nodes text provider. If set to null DefaultTextProvider will be used instead.

Parameters:

textProvider - new nodes text provider

isMatchCase

public boolean isMatchCase()

Returns whether should match case or not.

Returns:

true if should match case, false otherwise

setMatchCase

public void setMatchCase(boolean matchCase)

Returns whether should match case or not.

Parameters:

matchCase - whether should match case or not

isUseSpaceAsSeparator

public boolean isUseSpaceAsSeparator()

Returns whether should use space character as requests separator or not.

Returns:

true if should use space character as requests separator, false otherwise

setUseSpaceAsSeparator

public void setUseSpaceAsSeparator(boolean useSpaceAsSeparator)

Sets whether should use space character as requests separator or not.

Parameters:

useSpaceAsSeparator - whether should use space character as requests separator or not

isSearchFromStart

public boolean isSearchFromStart()

Returns whether should search from node text beginning or not.

Returns:

true if should search from node text beginning, false otherwise

setSearchFromStart

public void setSearchFromStart(boolean searchFromStart)

Sets whether should search from node text beginning or not.

Parameters:

searchFromStart - whether should search from node text beginning or not

getSearchText

public java.lang.String getSearchText()

Returns search request text.

Returns:

search request text

setSearchText

public void setSearchText(java.lang.String searchText)

Sets search request text.

Parameters:

searchText - search request text

clearCache

public void clearCache()

Clears accept states cache.

clearCache

public void clearCache(E node)

Clears specific node accept state cache.

Parameters:

node - node to clear accept state for

clearCache

public void clearCache(java.lang.String nodeId)

Clears specific node accept state cache.

Parameters:

nodeId - ID of the node to clear accept state for

accept

public boolean accept(E node)

Specified by:

accept in interface com.alee.utils.compare.Filter<E extends UniqueNode>

acceptIncludingChildren

protected boolean acceptIncludingChildren(E node,
                                          java.lang.String searchRequest)

Returns whether the specified node or any of its children match the filter or not.

Parameters:

node - node to match

searchRequest - search request text

Returns:

true if the specified node or any of its children match the filter, false otherwise

acceptNode

protected boolean acceptNode(E node,
                             java.lang.String searchRequest)

Returns whether the specified node matches the filter or not. This method might return cached value if it exists, otherwise it will retrieve and cache a new value.

Parameters:

node - node to match

searchRequest - search request text

Returns:

true if the specified node matches the filter, false otherwise

acceptNodeImpl

protected boolean acceptNodeImpl(E node,
                                 java.lang.String searchRequest)

Returns whether the specified node matches the filter or not.

Parameters:

node - node to match

searchRequest - search request text

Returns:

true if the specified node matches the filter, false otherwise

accept

protected boolean accept(java.lang.String nodeText,
                         java.lang.String searchRequest,
                         boolean searchFromStart)

Returns whether filter accepts specified node text or not.

Parameters:

nodeText - node text

searchRequest - single search request

searchFromStart - whether should start searching from the beginning of the node text

Returns:

true if filter accepts specified node text, false otherwise