com.raritantechnologies.utils.tree
Class DifferenceTreeBuilder

java.lang.Object
  com.raritantechnologies.utils.tree.DifferenceTreeBuilder

All Implemented Interfaces:

IConfigurable, ITreeBuilder

public class DifferenceTreeBuilder

extends java.lang.Object

implements ITreeBuilder

Builds a difference tree between a positive (additive) TreeBuilder and a negative (subtractive) TreeBuilder.

XML Configuration Template:

   <TreeBuilder class="com.raritantechnologies.utils.tree.DifferenceTreeBuilder" >

     <AddTreeBuilder class="[ class of com.raritantechnologies.utils.tree.ITreeBuilder ]" >
     </AddTreeBuilder>

     <SubtractTreeBuilder class="[ class of com.raritantechnologies.utils.tree.ITreeBuilder ]"
                             level="[ level to start the subtract Tree at: 0 = root ]" >
     </SubtractTreeBuilder>

  </TreeBuilder>

 

Field Summary

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

TEMPLATE

Constructor Summary

DifferenceTreeBuilder()

Method Summary

TreeRoot	buildTree(RaritanPageContext pContext)
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.
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

DifferenceTreeBuilder

public DifferenceTreeBuilder()

Method Detail

buildTree

public TreeRoot buildTree(RaritanPageContext pContext)

Specified by:

buildTree in interface ITreeBuilder

refreshTree

public TreeRoot refreshTree(TreeRoot tree,
                            RaritanPageContext pContext)

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.

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

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)