com.raritantechnologies.utils.tree.filter
Class TreeSortingFilter

java.lang.Object
  com.raritantechnologies.utils.tree.filter.TreeSortingFilter

All Implemented Interfaces:

IConfigurable, ITreeFilter

public class TreeSortingFilter

extends java.lang.Object

implements ITreeFilter

Filters a Source TreeRoot by sorting the child elements using an ITreeNodeComparator.

XML Configuration Template:

   <TreeFilter class="com.raritantechnologies.utils.tree.filter.TreeSortingFilter" >

     <TreeNodeComparator class="[ class of com.raritantechnologies.utils.tree.ITreeNodeComparator ]" >

     </TreeNodeComparator>

   </TreeFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.utils.tree.ITreeFilter

TEMPLATE

Constructor Summary

TreeSortingFilter()

TreeSortingFilter(ITreeNodeComparator treeNodeComparator)

Method Summary

TreeNode	filterNode(TreeNode node, TreeRoot sourceTree, RaritanPageContext rpc)
TreeRoot	filterTree(TreeRoot tree, RaritanPageContext rpc) Filter (prune, add, modify etc.) a Tree object.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeSortingFilter

public TreeSortingFilter()

TreeSortingFilter

public TreeSortingFilter(ITreeNodeComparator treeNodeComparator)

Method Detail

filterTree

public TreeRoot filterTree(TreeRoot tree,
                           RaritanPageContext rpc)

Description copied from interface: ITreeFilter

Filter (prune, add, modify etc.) a Tree object.

Specified by:

filterTree in interface ITreeFilter

filterNode

public TreeNode filterNode(TreeNode node,
                           TreeRoot sourceTree,
                           RaritanPageContext rpc)

Specified by:

filterNode in interface ITreeFilter

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable