com.raritantechnologies.utils.tree
Class NestedResultsTreeBuilder

java.lang.Object
  extended bycom.raritantechnologies.utils.tree.NestedResultsTreeBuilder
All Implemented Interfaces:
IConfigurable, IResultSetTreeBuilder

public class NestedResultsTreeBuilder
extends java.lang.Object
implements IResultSetTreeBuilder

Builds a Tree from a set of IResults with nested IResultSet hierarchy.

XML Configuration Template:
  <TreeBuilder class="com.raritantechnologies.utils.tree.NestedResultsTreeBuilder" >

  </TreeBuilder>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Constructor Summary
NestedResultsTreeBuilder()
           
 
Method Summary
 TreeRoot buildTree(java.lang.String treeName, java.lang.String pathField, IResultSet results)
           
 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.
 void setAddNodeCounts(boolean addNodeCounts)
           
 void setAddResultsToNode(boolean addResultsToNode)
           
 void setPathValueDelimiter(java.lang.String delimiter)
           
 void setResultAttributeMap(java.util.Map resultAttributeMap)
           
 void setUseRootPath(boolean useRootPath)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NestedResultsTreeBuilder

public NestedResultsTreeBuilder()
Method Detail

buildTree

public TreeRoot buildTree(java.lang.String treeName,
                          java.lang.String pathField,
                          IResultSet results)
Specified by:
buildTree in interface IResultSetTreeBuilder

setAddNodeCounts

public void setAddNodeCounts(boolean addNodeCounts)
Specified by:
setAddNodeCounts in interface IResultSetTreeBuilder

setAddResultsToNode

public void setAddResultsToNode(boolean addResultsToNode)
Specified by:
setAddResultsToNode in interface IResultSetTreeBuilder

setResultAttributeMap

public void setResultAttributeMap(java.util.Map resultAttributeMap)
Specified by:
setResultAttributeMap in interface IResultSetTreeBuilder

setUseRootPath

public void setUseRootPath(boolean useRootPath)
Specified by:
setUseRootPath in interface IResultSetTreeBuilder

setPathValueDelimiter

public void setPathValueDelimiter(java.lang.String delimiter)
Specified by:
setPathValueDelimiter in interface IResultSetTreeBuilder

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)