com.raritantechnologies.utils.tree.filter
Class BasicTreeNodeFilter

java.lang.Object
  extended bycom.raritantechnologies.utils.tree.filter.BasicTreeNodeFilter
All Implemented Interfaces:
IConfigurable, ITreeNodeFilter

public class BasicTreeNodeFilter
extends java.lang.Object
implements ITreeNodeFilter

Applies one or more IStringFilter operations to the attributes in a TreeNode.

XML Configuration Template:
   <NodeFilter class="com.raritantechnologies.utils.tree.filter.BasicTreeNodeFilter"
                  oldName="[ optional name of node to change from ]"
                  newName="[ name of node to change to if matches 'oldName' ]" >

     <!-- One or more StringFilter for an Attribute -->
     <AttributeFilter attribute="[ NAME | ID | name of TreeNode attribute to filter ]"
                         class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >
     </AttributeFilter>

   </NodeFilter>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
 
Fields inherited from interface com.raritantechnologies.utils.tree.filter.ITreeNodeFilter
TEMPLATE
 
Constructor Summary
BasicTreeNodeFilter()
           
 
Method Summary
 void addAttributeFilter(java.lang.String attribute, IStringFilter attributeFilter)
           
 TreeNode filterNode(TreeNode treeNode, RaritanPageContext pageContext)
           
 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

BasicTreeNodeFilter

public BasicTreeNodeFilter()
Method Detail

filterNode

public TreeNode filterNode(TreeNode treeNode,
                           RaritanPageContext pageContext)
Specified by:
filterNode in interface ITreeNodeFilter

addAttributeFilter

public void addAttributeFilter(java.lang.String attribute,
                               IStringFilter attributeFilter)

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)