com.raritantechnologies.utils.tree.filter
Class TreeFilter

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

All Implemented Interfaces:

IConfigurable, ITreeFilter

public class TreeFilter

extends java.lang.Object

implements ITreeFilter

Configurable Tree Filter. Contains one or more ITreeNodeFilters that can modify a Tree object or its nodes.

XML Configuration Template:

    <TreeFilter class="com.raritantechnologies.utils.tree.filter.TreeFilter"
        newNameAttribute="[ tree attribute to use as tree node Name ]"
        debug_xml="[true|false(default) ]" >

      <!-- One or more NodeFilter elements -->
      <NodeFilter class="[ class of com.raritantechnologies.utils.tree.filter.ITreeNodeFilter ]" >

      </NodeFilter>

      <!-- etc... -->

    </TreeFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

TreeFilter()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeFilter

public TreeFilter()

Method Detail

filterTree

public TreeRoot filterTree(TreeRoot tree)

filterTree

public TreeRoot filterTree(TreeRoot tree,
                           RaritanPageContext pContext)

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

setNodeFilters

public void setNodeFilters(ITreeNodeFilter[] nodeFilters)

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