com.raritantechnologies.searchApp.query.taglibrary
Class ReadQueriesSearchElementRenderer

java.lang.Object
  com.raritantechnologies.searchApp.query.taglibrary.ReadQueriesSearchElementRenderer

All Implemented Interfaces:

IConfigurable, ISearchElementRenderer

Direct Known Subclasses:

AlertListSearchElementRenderer, DeleteListSearchElementRenderer

public class ReadQueriesSearchElementRenderer

extends java.lang.Object

implements ISearchElementRenderer

Basic SearchElementRenderer that can read selected queries from a persistent store and execute them within a Search Form context.

Provides a control (dropdown list or hyperlinks) that generates Javascript that will fill in a search form (and optionally trigger a search form submit( ) ) - when the control is selected to execute the restored queries.

XML Configuration Template:

  <SearchElementRenderer 
     rendererClass="com.raritantechnologies.searchApp.query.taglibrary.ReadQueriesSearchElementRenderer"
     applicationName="[The application name - needed if mixed schema in persistant store]"
     selectField="[name of html dropdown field]"
     queryReader="[name of query reader system object (alternate to QueryReader tag)]"
     sortBy="NAME|QUERIES|DATE|RESULTS|TIME"
     sortDir="asc|desc"
     style="DROPDOWN|HYPERLINK"
     hyperlinkAction="someJsp.jsp [ if HYPERLINK ]"
     cssClass="cssClass"
     multiSelect="true"
     delimiter="|"
     rows="10" 
     cols="80"
     externalSearchForm="[alternate search form to execute]" >

    <QueryReader class="[Implementation class of IQueryResultSetReader]" >
      <!-- Parameters needed by QueryReader class -->
    </QueryReader>

    <!-- parameters to be inserted into the SearchForm Page Context -->
    <SearchParams>
      <Param ID="[a request param ID]" />
      <Param ID="[another param ID]" />
    </SearchParams>

    <!-- Additional parameters to use when executing the query -->
    </ExecuteParams>
      <Param ID="paramID" value="paramVal" />
    </ExecuteParams>

  </SearchElementRenderer>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

protected java.lang.String	action
protected java.lang.String	clazz
static java.lang.String	deSelectedQParam
static java.lang.String	qSourcesParam
static java.lang.String	selectedQParam

Constructor Summary

ReadQueriesSearchElementRenderer()

Method Summary

java.lang.String	getBody(ISearchFormRenderer parent, RaritanPageContext pageContext) Returns the element html fragment.
protected java.lang.String	getHttpQuery(QueryResultBean qrb)
protected IQueryResultSetReader	getQueryResultSetReader()
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.
boolean	isHidden(ISearchFormRenderer parent, RaritanPageContext pageContext)
protected java.lang.String	processResults(ISearchFormRenderer parent, java.util.Iterator it, RaritanPageContext pageContext)
void	setEnable(boolean enabled) Enable/Disable the renderer.

Methods inherited from class java.lang.Object

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

Field Detail

action

protected java.lang.String action

selectedQParam

public static final java.lang.String selectedQParam

See Also:

Constant Field Values

deSelectedQParam

public static final java.lang.String deSelectedQParam

See Also:

Constant Field Values

qSourcesParam

public static final java.lang.String qSourcesParam

See Also:

Constant Field Values

clazz

protected java.lang.String clazz

Constructor Detail

ReadQueriesSearchElementRenderer

public ReadQueriesSearchElementRenderer()

Method Detail

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 ISearchElementRenderer

getBody

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

Description copied from interface: ISearchElementRenderer

Returns the element html fragment.

Specified by:

getBody in interface ISearchElementRenderer

isHidden

public boolean isHidden(ISearchFormRenderer parent,
                        RaritanPageContext pageContext)

Specified by:

isHidden in interface ISearchElementRenderer

processResults

protected java.lang.String processResults(ISearchFormRenderer parent,
                                          java.util.Iterator it,
                                          RaritanPageContext pageContext)

getHttpQuery

protected java.lang.String getHttpQuery(QueryResultBean qrb)

getQueryResultSetReader

protected IQueryResultSetReader getQueryResultSetReader()

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