com.raritantechnologies.searchApp.sourceMap.taglibrary
Class BasicSourceMapTreeRenderer

java.lang.Object
  com.raritantechnologies.searchApp.sourceMap.taglibrary.BasicSourceMapTreeRenderer

All Implemented Interfaces:

IConfigurable, ISourceMapTreeRenderer

Direct Known Subclasses:

ExplorerSourceMapTreeRenderer

public class BasicSourceMapTreeRenderer

extends java.lang.Object

implements ISourceMapTreeRenderer

Renders a hyperlink tree version of a hierarchical SourceMapTree.

XML Configuration Template: (NOTE: XML is in SourceMap xml, not main configuration XML)

 <SourceMapTreeRenderer name="basicRenderer"
           class="com.raritantechnologies.searchApp.sourceMap.taglibrary.BasicSourceMapTreeRenderer"
           openNodeImg="./images/plus.gif"
           closeNodeImg="./images/minus.gif"
           treeBgColor="#aabbcc"
           treeWidth="200" 
           searchResultWidth="500" 
           tableHeight="500"
           tableClass="theTreeClass"
           tableProps="'border='1' "
           formTableProps="[ table properties for SearchForm ]"
           searchBgColor="#ccccff"
           resultBgColor="#eeeeee"
           hiddenFields="adhocFields,item_id"
           savePageParams="true|false"
           hyperlinkFolders="true(default)|false - if true only leaf nodes have hyperlinks" >

   <PageLinkRenderer position="both" pageURL="sourceTree.jsp" />

   <!-- Control components are added to the left side of the interface and can generate their own 
   <!-- actions. -->
   <ControlComponent class="[ class of com.raritantechnologies.searchApp.IPageContextRenderer ]" >

   </ControlComponent>

 </SourceMapTreeRenderer>

 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

protected java.lang.String	hiddenFieldsList
protected java.lang.String	sourceMapURL

Constructor Summary

BasicSourceMapTreeRenderer()

BasicSourceMapTreeRenderer(java.lang.String sourceMapURL, java.lang.String searchFormName)

Method Summary

protected void	appendRequestParams(java.lang.StringBuffer strbuf, ISourceMapTreeNode treeNode, RaritanPageContext pageContext)
protected boolean	canSearch(RaritanPageContext pageContext, ISourceMapTreeNode treeNode)
protected java.lang.String	getDisplayForm(RaritanPageContext rpc)
protected java.lang.String	getDropdownLists(ISourceMapTreeNode treeNode)
protected java.lang.String	getHyperlink(java.lang.String treeName, ISourceMapTreeNode treeNode, RaritanPageContext pageContext)
protected java.lang.String	getHyperlink(java.lang.String treeName, ISourceMapTreeNode treeNode, RaritanPageContext pageContext, boolean includeAction)
protected java.lang.String	getPageLink(RaritanPageContext rpc)
protected java.lang.String	getSearchForm(ISearchFormRenderer sfRenderer, RaritanPageContext rpc, java.lang.String searchFormCategory)
protected java.lang.String	getSourceTree(ISourceMapTreeNode sourceMapTree, RaritanPageContext pageContext)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
protected ISearchFormRenderer	initializeSearchFormRenderer(java.lang.String searchFormName, java.lang.String searchFormCategory, RaritanPageContext pageContext)
protected void	renderNode(java.lang.StringBuffer strbuf, java.lang.String treeName, ISourceMapTreeNode treeNode, RaritanPageContext pageContext, int level, boolean renderChildren, java.lang.String currentPath)
java.lang.String	renderSourceMap(ISourceMapTreeNode sourceMapTree, RaritanPageContext pageContext) Renders a SourceMapTree, including any parameter lists and a search form or display form.
void	setActiveSourceMapNode(ISourceMapTreeNode activeNode)
void	setCloseNodeImg(java.lang.String closeNodeImg)
void	setDisplayFormName(java.lang.String displayFormName)
void	setFormTableProps(java.lang.String formTableProps)
void	setOpenNodeImg(java.lang.String openNodeImg)
void	setPageSize(java.lang.String pageSize)
void	setSearchFormName(java.lang.String searchFormName) URL to use for search form submits.
void	setSearchFormURL(java.lang.String searchFormURL) URL to use for search form submits.
void	setSourceMapName(java.lang.String sourceMapName)
void	setSourceMapTreeName(java.lang.String sourceMapTreeName)
void	setSourceMapURL(java.lang.String sourceMapURL) URL to use for source tree hyperlinks...
void	setTableProps(java.lang.String tableProps)
void	setTreeBorderColor(java.lang.String treeBorderColor)
void	setTreeState(ISourceMapTreeNode smTree, RaritanPageContext pageContext)

Methods inherited from class java.lang.Object

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

Field Detail

sourceMapURL

protected java.lang.String sourceMapURL

hiddenFieldsList

protected java.lang.String hiddenFieldsList

Constructor Detail

BasicSourceMapTreeRenderer

public BasicSourceMapTreeRenderer()

BasicSourceMapTreeRenderer

public BasicSourceMapTreeRenderer(java.lang.String sourceMapURL,
                                  java.lang.String searchFormName)

Method Detail

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 ISourceMapTreeRenderer

setSourceMapURL

public void setSourceMapURL(java.lang.String sourceMapURL)

URL to use for source tree hyperlinks...

Specified by:

setSourceMapURL in interface ISourceMapTreeRenderer

setSearchFormName

public void setSearchFormName(java.lang.String searchFormName)

URL to use for search form submits.

Specified by:

setSearchFormName in interface ISourceMapTreeRenderer

setSearchFormURL

public void setSearchFormURL(java.lang.String searchFormURL)

Description copied from interface: ISourceMapTreeRenderer

URL to use for search form submits.

Specified by:

setSearchFormURL in interface ISourceMapTreeRenderer

setTableProps

public void setTableProps(java.lang.String tableProps)

Specified by:

setTableProps in interface ISourceMapTreeRenderer

setFormTableProps

public void setFormTableProps(java.lang.String formTableProps)

Specified by:

setFormTableProps in interface ISourceMapTreeRenderer

setTreeBorderColor

public void setTreeBorderColor(java.lang.String treeBorderColor)

Specified by:

setTreeBorderColor in interface ISourceMapTreeRenderer

setTreeState

public void setTreeState(ISourceMapTreeNode smTree,
                         RaritanPageContext pageContext)

Specified by:

setTreeState in interface ISourceMapTreeRenderer

setActiveSourceMapNode

public void setActiveSourceMapNode(ISourceMapTreeNode activeNode)

Specified by:

setActiveSourceMapNode in interface ISourceMapTreeRenderer

setOpenNodeImg

public void setOpenNodeImg(java.lang.String openNodeImg)

setCloseNodeImg

public void setCloseNodeImg(java.lang.String closeNodeImg)

setDisplayFormName

public void setDisplayFormName(java.lang.String displayFormName)

Specified by:

setDisplayFormName in interface ISourceMapTreeRenderer

setSourceMapName

public void setSourceMapName(java.lang.String sourceMapName)

Specified by:

setSourceMapName in interface ISourceMapTreeRenderer

setSourceMapTreeName

public void setSourceMapTreeName(java.lang.String sourceMapTreeName)

Specified by:

setSourceMapTreeName in interface ISourceMapTreeRenderer

setPageSize

public void setPageSize(java.lang.String pageSize)

Specified by:

setPageSize in interface ISourceMapTreeRenderer

renderSourceMap

public java.lang.String renderSourceMap(ISourceMapTreeNode sourceMapTree,
                                        RaritanPageContext pageContext)

Renders a SourceMapTree, including any parameter lists and a search form or display form.

Specified by:

renderSourceMap in interface ISourceMapTreeRenderer

Parameters:

sourceMapTree - The source map tree to be rendered.

pageContext - The page HTTP request context.

Returns:

HTML string of the rendered source map page.

getSourceTree

protected java.lang.String getSourceTree(ISourceMapTreeNode sourceMapTree,
                                         RaritanPageContext pageContext)

renderNode

protected void renderNode(java.lang.StringBuffer strbuf,
                          java.lang.String treeName,
                          ISourceMapTreeNode treeNode,
                          RaritanPageContext pageContext,
                          int level,
                          boolean renderChildren,
                          java.lang.String currentPath)

getHyperlink

protected java.lang.String getHyperlink(java.lang.String treeName,
                                        ISourceMapTreeNode treeNode,
                                        RaritanPageContext pageContext)

getHyperlink

protected java.lang.String getHyperlink(java.lang.String treeName,
                                        ISourceMapTreeNode treeNode,
                                        RaritanPageContext pageContext,
                                        boolean includeAction)

appendRequestParams

protected void appendRequestParams(java.lang.StringBuffer strbuf,
                                   ISourceMapTreeNode treeNode,
                                   RaritanPageContext pageContext)

getDropdownLists

protected java.lang.String getDropdownLists(ISourceMapTreeNode treeNode)

initializeSearchFormRenderer

protected ISearchFormRenderer initializeSearchFormRenderer(java.lang.String searchFormName,
                                                           java.lang.String searchFormCategory,
                                                           RaritanPageContext pageContext)

getSearchForm

protected java.lang.String getSearchForm(ISearchFormRenderer sfRenderer,
                                         RaritanPageContext rpc,
                                         java.lang.String searchFormCategory)

getDisplayForm

protected java.lang.String getDisplayForm(RaritanPageContext rpc)

getPageLink

protected java.lang.String getPageLink(RaritanPageContext rpc)

canSearch

protected boolean canSearch(RaritanPageContext pageContext,
                            ISourceMapTreeNode treeNode)