Package com.hybris.cockpitng.tree.util

Class TreeUtils

java.lang.Object

com.hybris.cockpitng.tree.util.TreeUtils

public final class TreeUtils
extends java.lang.Object

Provides useful functionalities for zk trees, especially for searching within treenodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TreeUtils.FilteredTreeModel<E>	Subclass of AbstractTreeModel that can be used as a filter.
static interface	TreeUtils.FilterStringResolver<E>	Used by TreeUtils.FilteredTreeModel to determine the string representation of a treenode that should be used for filtering.
static class	TreeUtils.MatchMode
static class	TreeUtils.SearchDepth	Determines whether filtering should be done up until first match or without any limitations

Method Summary

Modifier and Type	Method	Description
protected static int	getDynamicNodeDepth(DynamicNode node)
static boolean	isEligibleForMatching(NavigationNode node)	Checks whether specified node is eligible for TreeUtils.FilteredTreeModel to filter.
static boolean	matchCamelCase(java.lang.String value, java.lang.String searchString)	Camelcase string matching.
static boolean	matchFilterString(java.lang.Object data, java.lang.String filterString, boolean camelCase)	The call is equal to calling matchFilterString(Object, String, boolean, MatchMode) with match mode set to TreeUtils.MatchMode.CONTAINS.
static boolean	matchFilterString(java.lang.Object data, java.lang.String filterString, boolean camelCase, TreeUtils.MatchMode mode)	Checks, if argument data can be represented by argument filterString, i.e.
static boolean	matchFilterStringSimple(java.lang.String value, java.lang.String filterString)	The call is equal to calling matchFilterStringSimple(String, String, MatchMode) with match mode set to TreeUtils.MatchMode.CONTAINS.
static boolean	matchFilterStringSimple(java.lang.String value, java.lang.String filterString, TreeUtils.MatchMode mode)	Checks, if argument value starts (case-insensitive) with argument filterString.

Methods inherited from class java.lang.Object

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

Method Detail

matchCamelCase

public static boolean matchCamelCase(java.lang.String value,
                                     java.lang.String searchString)

Camelcase string matching.

Parameters:

value - the string that should be checked.

searchString - the "camel-cased" search string.

Returns:

true, if the search string is a camelcase representation of the value.

matchFilterString

public static boolean matchFilterString(java.lang.Object data,
                                        java.lang.String filterString,
                                        boolean camelCase)

The call is equal to calling matchFilterString(Object, String, boolean, MatchMode) with match mode set to TreeUtils.MatchMode.CONTAINS.

matchFilterString

public static boolean matchFilterString(java.lang.Object data,
                                        java.lang.String filterString,
                                        boolean camelCase,
                                        TreeUtils.MatchMode mode)

Checks, if argument data can be represented by argument filterString, i.e. it first checks, if data is a String, then invokes matchFilterString(Object, String, boolean) and optionally invokes matchCamelCase(String, String), depending on argument camelCase.

matchFilterStringSimple

public static boolean matchFilterStringSimple(java.lang.String value,
                                              java.lang.String filterString)

The call is equal to calling matchFilterStringSimple(String, String, MatchMode) with match mode set to TreeUtils.MatchMode.CONTAINS.

matchFilterStringSimple

public static boolean matchFilterStringSimple(java.lang.String value,
                                              java.lang.String filterString,
                                              TreeUtils.MatchMode mode)

Checks, if argument value starts (case-insensitive) with argument filterString.

isEligibleForMatching

public static boolean isEligibleForMatching(NavigationNode node)

Checks whether specified node is eligible for TreeUtils.FilteredTreeModel to filter. Method does not check filtering itself, yet whether filter can even be applied on node.

Parameters:

node - node to be checked

Returns:

true if node can potentially be tested against filter query

getDynamicNodeDepth

protected static int getDynamicNodeDepth(DynamicNode node)