com.raritantechnologies.utils.tree.filter
Class BasicTreeFilter

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

All Implemented Interfaces:

IConfigurable, ITreeFilter

public class BasicTreeFilter

extends java.lang.Object

implements ITreeFilter

Provides basic filtering capability for tree objects. Selects tree nodes using a set of attribute comparisons.

XML Configuration Template:

   <TreeFilter class="com.raritantechnologies.utils.tree.BasicTreeFilter"
                  isAnd="[ true(default)|false ]" >

     <Attributes>
       <Attribute name="[ name of attribute ]" value="[ value of attribute ]" />

       <!-- can also use IComparator to match attributes -->
       <Attribute name="[ name of attribute ]" >
         <Comparator class="[ class of com.raritantechnologies.utils.comparators.IComparator ]" >

         </Comparator>
       </Attribute>
     </Attributes>

   </TreeFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

BasicTreeFilter()

Method Summary

TreeNode	filterNode(TreeNode node, TreeRoot tree, RaritanPageContext rpc)
TreeRoot	filterTree(TreeRoot tree, RaritanPageContext rpc) Filter (prune, add, modify etc.) a Tree object.
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
void	getConfigurationXML(java.io.Writer writer)
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

BasicTreeFilter

public BasicTreeFilter()

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 tree,
                           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

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)