com.raritantechnologies.searchApp.taglibrary
Class ConfigurablePageRequestMap

java.lang.Object
  BodyTagSupport
      com.raritantechnologies.searchApp.taglibrary.ConfigurablePageRequestMap

All Implemented Interfaces:

IConfigurable, ICustomTag

public class ConfigurablePageRequestMap

extends BodyTagSupport

implements ICustomTag

Enables JSP page variables to be set from the Configuration XML or from session data cache. Similar to PageParameterMapTag except that the JSP passes in the type, and name of a list of configurable attributes which are defined in a Configuration <ParameterMap>. The parameters are then loaded into the JSP page context so that they can be used in other places on the page.

The tag reads the configuration parameters by obtaining a Parameter Map using the ConfigurationManager.getSystemObject( ) method with the given page name and parameter type.

The ParameterMap is then used to set page variables on the SPJSP PageContext using setAttribute. These parameters can then be inserted into a JSP page using <%= theParamName %>.

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

See Also:

Serialized Form

Constructor Summary

ConfigurablePageRequestMap()

Method Summary

int	doStartTag()
java.lang.String	getBody(RaritanPageContext rpc) Returns the tag body.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	initialize(java.util.Map initParams)
void	setPageName(java.lang.String pageName)
void	setParamList(java.lang.String parameterList) Custom tag parameter: comma separated list of parameter names to be extracted ConfigurationManager ParamMap
void	setParamName(java.lang.String paramMapName)
void	setParamType(java.lang.String paramType)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurablePageRequestMap

public ConfigurablePageRequestMap()

Method Detail

setPageName

public void setPageName(java.lang.String pageName)

setParamType

public void setParamType(java.lang.String paramType)

setParamName

public void setParamName(java.lang.String paramMapName)

setParamList

public void setParamList(java.lang.String parameterList)

Custom tag parameter: comma separated list of parameter names to be extracted ConfigurationManager ParamMap

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.

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