com.raritantechnologies.searchApp.reporting.taglibrary
Class TimedReportingTag

java.lang.Object
  BodyTagSupport
      com.raritantechnologies.searchApp.reporting.taglibrary.TimedReportingTag

All Implemented Interfaces:

IConfigurable, ICustomTag, ISearchElementRenderer

public class TimedReportingTag

extends BodyTagSupport

implements ICustomTag, ISearchElementRenderer

Executes a reporting job to refresh a screen tag at some configurable time interval.

XML Configuration Template:

  <SearchElementRenderer class="com.raritantechnologies.searchApp.reporting.taglibrary.TimedReportingTag"
                            reportProcessName="[ name of reporting process ]"
                            cacheInterval="[ recache interval in milliseconds ]" >

  </SearchElementRenderer>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

See Also:

Serialized Form

Constructor Summary

TimedReportingTag()

Method Summary

int	doStartTag() Main entry point for JSP custom tag.
java.lang.String	getBody(ISearchFormRenderer parent, RaritanPageContext rpc) Returns the element html fragment.
java.lang.String	getBody(RaritanPageContext rpc) Main entry point for RTI ICustomTag implementations.
ISearchElementRenderer	getRenderer(java.lang.String name) Returns ISearchElementRenderer of this render or a nested renderer matching the name given or null if no match is found.
void	initialize(org.w3c.dom.Element elem) Initialize renderer-specific parameters from the configuration XML tag.
void	initialize(java.util.Map initParams)
boolean	isHidden(ISearchFormRenderer parent, RaritanPageContext pageContext)
void	setAddPersistentParams(java.lang.String addPersist) sets flag to determine if this tag will add persistent parameters to the application (parameters whose state should be preserved across page requests).
void	setCacheInterval(java.lang.String cacheInterval) sets the cache interval in milliseconds.
void	setEnable(boolean enabled) Enable/Disable the renderer.
void	setRecacheParameters(java.lang.String recacheParameters) sets a list of parameters that will trigger a refresh of the report when they change.
void	setReportProcessName(java.lang.String reportProcessName) sets the name of reporting process (defined as a SystemObject tag in the application's configuration XML.
void	setSearchParameters(java.lang.String searchParams) sets a list of parameters that will be used as search parameters for the report's SearchSource.
void	setSearchSourceParam(java.lang.String searchSourceParam) Sets the request parameter name that will contain the name of the SearchSource to use for the reporting process.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimedReportingTag

public TimedReportingTag()

Method Detail

setReportProcessName

public void setReportProcessName(java.lang.String reportProcessName)

sets the name of reporting process (defined as a SystemObject tag in the application's configuration XML.

setCacheInterval

public void setCacheInterval(java.lang.String cacheInterval)

sets the cache interval in milliseconds. Reports will be refreshed at this interval.

setAddPersistentParams

public void setAddPersistentParams(java.lang.String addPersist)

sets flag to determine if this tag will add persistent parameters to the application (parameters whose state should be preserved across page requests).

setSearchSourceParam

public void setSearchSourceParam(java.lang.String searchSourceParam)

Sets the request parameter name that will contain the name of the SearchSource to use for the reporting process.

setRecacheParameters

public void setRecacheParameters(java.lang.String recacheParameters)

sets a list of parameters that will trigger a refresh of the report when they change.

Parameters:

recacheParameters - Comma separated list of request parameters that will trigger a report refresh.

setSearchParameters

public void setSearchParameters(java.lang.String searchParams)

sets a list of parameters that will be used as search parameters for the report's SearchSource.

Parameters:

searchParams - Comma separated list of request parameters that will be used as search parameters for the report's SearchSource.

doStartTag

public int doStartTag()
               throws JspException

Main entry point for JSP custom tag.

Throws:

JspException

getBody

public java.lang.String getBody(RaritanPageContext rpc)

Main entry point for RTI ICustomTag implementations.

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.

getBody

public java.lang.String getBody(ISearchFormRenderer parent,
                                RaritanPageContext rpc)

Description copied from interface: ISearchElementRenderer

Returns the element html fragment.

Specified by:

getBody in interface ISearchElementRenderer

setEnable

public void setEnable(boolean enabled)

Description copied from interface: ISearchElementRenderer

Enable/Disable the renderer. Disabled renderers are not included in the html output of an ISearchFormRenderer.

Specified by:

setEnable in interface ISearchElementRenderer

getRenderer

public ISearchElementRenderer getRenderer(java.lang.String name)

Description copied from interface: ISearchElementRenderer

Returns ISearchElementRenderer of this render or a nested renderer matching the name given or null if no match is found.

Specified by:

getRenderer in interface ISearchElementRenderer

isHidden

public boolean isHidden(ISearchFormRenderer parent,
                        RaritanPageContext pageContext)

Specified by:

isHidden in interface ISearchElementRenderer

initialize

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

Description copied from interface: ISearchElementRenderer

Initialize renderer-specific parameters from the configuration XML tag.

Specified by:

initialize in interface IConfigurable

initialize

public void initialize(java.util.Map initParams)

Specified by:

initialize in interface ICustomTag