com.raritantechnologies.dieselpoint.taglibrary
Class DieselpointTaxonomyTreeBuilder

java.lang.Object
  com.raritantechnologies.dieselpoint.taglibrary.DieselpointTaxonomyTreeBuilder

All Implemented Interfaces:

IConfigurable, ITreeBuilder

public class DieselpointTaxonomyTreeBuilder

extends java.lang.Object

implements ITreeBuilder

Implementation of ITreeBuilder that creates a Raritan TreeRoot from a Dieselpoint taxonomy. Creates and refreshes a DieselpointTaxonomyTree subclass of TreeRoot.

XML Configuration Template:

   <TreeBuilder class="com.raritantechnologies.dieselpoint.taglibrary.DieselpointTaxonomyTreeBuilder"
                   taxonomyName="[name of dieselpoint taxonomy field]"
                   runLocalSearch="[true|false(default) - local search to fully update nodes]" />
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

DieselpointTaxonomyTreeBuilder()

Method Summary

TreeRoot	buildTree(RaritanPageContext rpc)
java.lang.String	getConfigurationXML()
void	getConfigurationXML(java.io.Writer writer)
boolean	getRunLocalSearch()
java.lang.String	getTaxonomyName()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
TreeRoot	refreshTree(TreeRoot theTree, RaritanPageContext pContext) Method to enable dynamic or refreshable trees.
void	setRunLocalSearch(boolean runLocalSearch)
void	setTaxonomyName(java.lang.String taxonomyName)

Methods inherited from class java.lang.Object

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

Constructor Detail

DieselpointTaxonomyTreeBuilder

public DieselpointTaxonomyTreeBuilder()

Method Detail

buildTree

public TreeRoot buildTree(RaritanPageContext rpc)

Specified by:

buildTree in interface ITreeBuilder

refreshTree

public TreeRoot refreshTree(TreeRoot theTree,
                            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

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

setTaxonomyName

public void setTaxonomyName(java.lang.String taxonomyName)

getTaxonomyName

public java.lang.String getTaxonomyName()

setRunLocalSearch

public void setRunLocalSearch(boolean runLocalSearch)

getRunLocalSearch

public boolean getRunLocalSearch()

getConfigurationXML

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

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()