com.raritantechnologies.utils.tree.filter
Class CollectionGatewayTreeFilter

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

All Implemented Interfaces:

IConfigurable, ITreeFilter

public class CollectionGatewayTreeFilter

extends java.lang.Object

implements ITreeFilter

Uses an ICollectionGateway to obtain information to add attributes to TreeNodes in the tree. The Collection Gateway should create a set of IResult objects that contain a field with a tree path that can be mapped to tree nodes in the filtered tree. Once the mapping is accomplished, fields from the results (or the results themselves) can be added to their matching tree nodes.

XML Configuration Template:

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

    <CollectionGateway class="[ class of com.raritantechnologies.searchApp.dataCollection.ICollectionGateway ]" >

    </CollectionGateway>

    <!-- One or more CollectionNodeMap Elements: -->
    <CollectionNodeMap resultPathField="[ name of result field that contains tree Path ]" >

       <!-- One or more Attribute Elements: -->
       <Attribute treeAttribute="[ tree name ]" resultField="[ field in result ]" />

    </CollectionNodeMap>
  </TreeFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

CollectionGatewayTreeFilter()

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

CollectionGatewayTreeFilter

public CollectionGatewayTreeFilter()

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