com.raritantechnologies.utils.tree.filter
Class TreeNodePatternFilter

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

public class TreeNodePatternFilter
extends java.lang.Object
implements ITreeNodeFilter

Creates a TreeNode field from a pattern template field and the current values of the TreeNode's attributes.

XML Configuration Template:
   <TreeNodeFilter class="com.raritantechnologies.utils.tree.filter.TreeNodePatternFilter" 
                      templateAttribute="[ (optional) name of TreeNode attribute that contains pattern template ]"
                      outputAttribute="[ name of TreeNode attribute to receive filtered result string ]" >

     <!-- If the template pattern is not acquired from the TreeNode.templateAttribute: specifiy a fixed template pattern: -->
     <Template>
       <![CDATA[
          Tree node attribute pattern with {Tree_Node_Attribute_Name} sections to indicate where current
       Tree node attribute values are to be inserted.
       <]]>
     </Template>

   </TreeNodeFilter>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
 
Fields inherited from interface com.raritantechnologies.utils.tree.filter.ITreeNodeFilter
TEMPLATE
 
Constructor Summary
TreeNodePatternFilter()
           
 
Method Summary
 TreeNode filterNode(TreeNode treeNode, RaritanPageContext pageContext)
           
 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

TreeNodePatternFilter

public TreeNodePatternFilter()
Method Detail

filterNode

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

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