com.raritantechnologies.utils.tree.taglibrary
Class TreeDisplayFormRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicDisplayFormRenderer
      com.raritantechnologies.utils.tree.taglibrary.TreeDisplayFormRenderer

All Implemented Interfaces:

IConfigurable, IDisplayFormRenderer

public class TreeDisplayFormRenderer

extends BasicDisplayFormRenderer

Renders a tree from an IResultSet. Uses a ResultPathTreeBuilder (or another implementation of the IResultSetTreeBuilder interface ) to build a tree from a result set, and a ITreeRenderer to render the tree.

XML Configuration Template:

   <DisplayForm class="com.raritantechnologies.utils.tree.taglibrary.TreeDisplayFormRenderer"
                   treeName="[ name of the tree ]"
                   actionURL="[ base URL for hyperlinks ]"
                   initialState="[ open|closed ]"
                   resultPathField="[ field in IResult to get tree paths ]"
                   pathValueDelimiter="[ delimiter for packed multi-value result fields ]"
                   addResultsToNode="true(default)|false"
                   treeRootClass="[ class name of TreeRoot ]"
                   treeNodeClass="[ class name of TreeNode ]"
                   treeBuilderClass="[ class name of IResultSetTreeBuilder implementation (optional) ]"
                   hyperlinkAction="[ action to use (if not using ResultRenderer or TreeRenderer LinkRenderer) - equivalent to createHyperlink=true ]"
                   hyperlinkPathParam="[ hyperlink parameter to put TreeNode path in (if not using ResultRenderer or TreeRenderer LinkRenderer) ]"
                   addNodeCounts="[true|false(default) - if true adds counts for number of path 'hits' rather than child counts ]"
                   treeCacheKey="[ cache key for Tree built from result paths ]"
                   useRootPath="[ true(default)|false ]" >

      <!-- ================================================================== -->
      <!--  Determines how IResult fields are mapped to tree attributes       -->
      <!-- ================================================================== -->
      <ResultAttributeMap>
        <Field resultField="[ fieldID in result ]" attribute="[ tree node attribute ]" />
      </ResultAttributeMap>

      <!-- Optional ResultSetTreeBuilder (if not using the standard ResultPathTreeBuilder) -->
      <ResultSetTreeBuilder class="[ class of com.raritantechnologies.utils.tree.IResultSetTreeBuilder ]" >

      </ResultSetTreeBuilder>

      <!-- ================================================================== -->
      <!-- Optional TreeFilter to filter the tree prior to rendering          -->
      <!-- ================================================================== -->
      <TreeFilter class="[ class of com.raritantechnologies.utils.filter.TreeFilter" ]" >

      </TreeFilter>

      <!-- ================================================================== -->
      <!-- The ITreeRenderer used to render the tree display (required).      -->
      <!-- ================================================================== -->
      <TreeRenderer class="[ class of com.raritantechnologies.utils.tree.taglibrary.ITreeRenderer ]" >

      </TreeRenderer>

      <!-- ================================================================== -->
      <!-- Optional Result Renderer element - If an IResultRenderer is        -->
      <!-- specified here, aTreeResultHyperlinkRenderer is used to render     -->
      <!-- TreeNode hyperlinks using the specified IResultRenderer.           -->
      <!-- ================================================================== -->
      <NodeRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.IResultRenderer ]" >

      </NodeRenderer>

      <!-- ================================================================== -->
      <!-- Optional StringFilter(s) for hyperlink parameters                  -->
      <!-- ================================================================== -->
      <HyperlinkFilter param="[ name of hyperlink parameter to get filtered ]"
                          class="[ class of com.raritantechnologies.utils.filter.IStringFilter" >

      </HyperlinkFilter>

   </DisplayForm>

 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.taglibrary.BasicDisplayFormRenderer

trailerBuffer

Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IDisplayFormRenderer

TEMPLATE

Constructor Summary

TreeDisplayFormRenderer()

Method Summary

java.lang.String	getBody(IResultSet resultSet, java.lang.String displayFormName, RaritanPageContext pageContext) Returns the display form body as an HTML fragment, by formatting the data contained in an IResultSet.
void	initialize(org.w3c.dom.Element elem) Initialize the display form renderer from the configuration XML.

Methods inherited from class com.raritantechnologies.searchApp.taglibrary.BasicDisplayFormRenderer

addBodyTrailerContent, disableRenderers, enableRenderers, getConfigurationXML, getResultRenderer, initialize, setBackgroundColor1, setBackgroundColor2, setColumnSpacing, setDisabledRendererParam, setEnabledRendererParam, setEnabledRenderers, setFieldNameCSSClass, setFielValueCSSClass, setHeaderWidth, setResultWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeDisplayFormRenderer

public TreeDisplayFormRenderer()

Method Detail

getBody

public java.lang.String getBody(IResultSet resultSet,
                                java.lang.String displayFormName,
                                RaritanPageContext pageContext)

Returns the display form body as an HTML fragment, by formatting the data contained in an IResultSet.

Specified by:

getBody in interface IDisplayFormRenderer

Overrides:

getBody in class BasicDisplayFormRenderer

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from class: BasicDisplayFormRenderer

Initialize the display form renderer from the configuration XML.

Specified by:

initialize in interface IDisplayFormRenderer

Overrides:

initialize in class BasicDisplayFormRenderer