com.raritantechnologies.verity.topic
Class VerityTaxonomyTreeBuilder

java.lang.Object
  com.raritantechnologies.verity.topic.VerityTaxonomyTreeBuilder

All Implemented Interfaces:

IConfigurable, ITreeBuilder

public class VerityTaxonomyTreeBuilder

extends java.lang.Object

implements ITreeBuilder

Builds a Taxonomy Tree from Verity tax and otl files. Includes an com.raritantechnologies.verity.topic.ITopicSetBuilder to create a TopicSet and an com.raritantechnologies.verity.topic.ITopicRenderer to convert Verity topics to a query string.

XML Configuration Template:

   <TreeBuilder class="com.raritantechnologies.verity.topic.VerityTaxonomyTreeBuilder"
                   topicIDField="[ field with Topic ID ]"
                   queryField="[ field that rendered query will be added to ]" >

     <!-- TreeBuilder source for initial taxonomy tree -->
     <TaxonomyTreeBuilder class="[ class of com.raritantechnologies.utils.tree.ITreeBuilder" >
        <!-- configuration parameters for TreeBuilder -->
     </TaxonomyTreeBuilder>

     <!-- TopicSetBuilder creates a TopicSet object -->
     <TopicSetBuilder class="[ class of com.raritantechnologies.verity.topic.ITopicSetBuilder ]" >
        <!-- configuration parameters for TopicSetBuilder -->
     </TopicSetBuilder>

     <!-- TopicRenderer converts Verity Topic to query string -->
     <TopicRenderer class="[ class of com.raritantechnologies.verity.topic.ITopicRenderer ]" >
        <!-- configuration parameters for TopicRenderer -->
     </TopicRenderer>

   </TreeBuilder>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

VerityTaxonomyTreeBuilder()

Method Summary

TreeRoot	buildTree(RaritanPageContext pContext)
java.lang.String	getQueryField()
Topic	getTopic(TreeNode tNode)
java.lang.String	getTopicIDField()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
TreeRoot	refreshTree(TreeRoot tree, RaritanPageContext pContext) Method to enable dynamic or refreshable trees.

Methods inherited from class java.lang.Object

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

Constructor Detail

VerityTaxonomyTreeBuilder

public VerityTaxonomyTreeBuilder()

Method Detail

buildTree

public TreeRoot buildTree(RaritanPageContext pContext)

Specified by:

buildTree in interface ITreeBuilder

getTopic

public Topic getTopic(TreeNode tNode)

refreshTree

public TreeRoot refreshTree(TreeRoot tree,
                            RaritanPageContext pContext)

Description copied from interface: ITreeBuilder

Method to enable dynamic or refreshable trees. Static tree builders should implement this by returning the passed in tree object. Dynamic tree builders should implement this by returning the output of their buildTree( ) method or by pruning/growing the given tree as appropriate.

ITreeBuilders that support "lazy tree node evaluation" should use this method to determine which nodes in the tree need to be updated (TreeNode.needsUpdate( ) method returns true.

Specified by:

refreshTree in interface ITreeBuilder

getTopicIDField

public java.lang.String getTopicIDField()

getQueryField

public java.lang.String getQueryField()

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