com.raritantechnologies.searchApp.sourceMap.taglibrary
Class SourceMapTreeTag

java.lang.Object
  BodyTagSupport
      com.raritantechnologies.searchApp.sourceMap.taglibrary.SourceMapTreeTag

All Implemented Interfaces:

IConfigurable, ICustomTag

public class SourceMapTreeTag

extends BodyTagSupport

implements ICustomTag

JSP Custom tag that renders a SourceMapTree as HTML.

JSP Custom Tag Template:

  <search:SourceMapTree  sourceMapTreeName="[ name of SourceMapTree in SourceMap XML ]"
                            sourceMapName="[ name of source map in SourceMap XML ]"
                            rendererName="[ name of SourceMap Tree Renderer ]"
                            sourceTreeURL="[ url of JSP page with this tag ]"
                            searchFormName="[ name of SearchForm tag in main configuration XML ]" />
 

SourceMap Tree Configuration XML:

  <SourceMapTree name="Subjects" param="treepath" >
   <SourceMapTreeNode name="Documents" >

    <!-- SourceMapList provides a list of sub-types -->
    <SourceMapList param="docType" >
      <params>
        <param name="Book"        value="Book" />
        <param name="RefArticle"  value="Reference Article" />
        <param name="NewsArticle" value="News Article" />
      </params>
    </SourceMapList>

  </SourceMapTreeNode>
 </SourceMapTree>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

See Also:

Serialized Form

Constructor Summary

SourceMapTreeTag()

Method Summary

int	doStartTag()
java.lang.String	getBody(RaritanPageContext rpc) Returns the tag body.
protected ISourceMapTreeNode	getSourceMapTree(RaritanPageContext pContext)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	initialize(java.util.Map initParams)
void	setDisplayFormName(java.lang.String displayFormName)
void	setFormTableProps(java.lang.String formTableProps)
void	setPageSize(java.lang.String pageSize)
void	setRendererName(java.lang.String sourceMapRenderer)
void	setSearchFormName(java.lang.String searchFormName)
void	setSearchFormURL(java.lang.String searchFormURL)
void	setSourceMapName(java.lang.String sourceMapName)
void	setSourceMapTreeName(java.lang.String sourceMapTreeName) sets the sourceMapTreeName
void	setSourceMapTreeSelector(java.lang.String sourceMapSelectorName)
void	setSourceTreeURL(java.lang.String sourceTreeURL)
void	setTableProps(java.lang.String tableProps)
void	setTreeBorderColor(java.lang.String treeBorderColor)

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceMapTreeTag

public SourceMapTreeTag()

Method Detail

setSourceMapTreeName

public void setSourceMapTreeName(java.lang.String sourceMapTreeName)

sets the sourceMapTreeName

setRendererName

public void setRendererName(java.lang.String sourceMapRenderer)

setSourceTreeURL

public void setSourceTreeURL(java.lang.String sourceTreeURL)

setSearchFormName

public void setSearchFormName(java.lang.String searchFormName)

setSearchFormURL

public void setSearchFormURL(java.lang.String searchFormURL)

setDisplayFormName

public void setDisplayFormName(java.lang.String displayFormName)

setSourceMapName

public void setSourceMapName(java.lang.String sourceMapName)

setSourceMapTreeSelector

public void setSourceMapTreeSelector(java.lang.String sourceMapSelectorName)

setPageSize

public void setPageSize(java.lang.String pageSize)

setTableProps

public void setTableProps(java.lang.String tableProps)

setFormTableProps

public void setFormTableProps(java.lang.String formTableProps)

setTreeBorderColor

public void setTreeBorderColor(java.lang.String treeBorderColor)

doStartTag

public int doStartTag()
               throws JspException

Throws:

JspException

getBody

public java.lang.String getBody(RaritanPageContext rpc)

Description copied from interface: ICustomTag

Returns the tag body.

Specified by:

getBody in interface ICustomTag

Parameters:

rpc - Platform-neutral page context ( can be used in non J2EE environments such as ASP).

Returns:

The tag body text string.

getSourceMapTree

protected ISourceMapTreeNode getSourceMapTree(RaritanPageContext pContext)

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

initialize

public void initialize(java.util.Map initParams)

Specified by:

initialize in interface ICustomTag