com.raritantechnologies.searchApp.query.taglibrary
Class QueryFieldSearchElementRenderer

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

All Implemented Interfaces:

IConfigurable, IReadQueryModule, ISearchElementRenderer

public class QueryFieldSearchElementRenderer

extends java.lang.Object

implements IReadQueryModule

Displays a hyperlink for a saved query. Works in conjunction with a configurable MultipleFieldQueriesSearchElementRenderer.

XML Configuration Template:

   <DisplayField class="com.raritantechnologies.searchApp.query.taglibrary.QueryFieldSearchElementRenderer"
                    size="[ size ]"
                    fieldClass="[ css class of field ]"
                    nameField="[ field to use for display name ]"
                    action="[url for hyperlink action ]"
                    header="[ renderer header ]" >

      <!-- one or more static parameters to add to query hyperlink -->
      <StaticParam name="[ name of static parameter ]" value="[ the value ]" />
      <StaticParam name="[ another static parameter ]" value="[ another value ]" />

      <!-- Clear Params can be overridden by saved values -->
      <Param name="[ name of default parameter ]" reset="[ value of default parameter ]" />

   </DisplayField>
 

Developed by Raritan Technologies Inc..

Author:

Chris Peterson

Constructor Summary

QueryFieldSearchElementRenderer()

Method Summary

java.lang.String	getBody(ISearchFormRenderer parent, RaritanPageContext pageContext) Returns the element html fragment.
java.lang.String	getBody(QueryResultBean qrb, RaritanPageContext pageContext, java.util.HashMap executeParams) Body for display
java.lang.String	getHeader(java.lang.String headerClass)
protected java.lang.String	getHttpQuery(QueryResultBean qrb, java.util.HashSet addedValues)
java.lang.String	getName()
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.
java.lang.String	getScript(RaritanPageContext pageContext)
void	initialize(org.w3c.dom.Element elem) Initialize renderer-specific parameters from the configuration XML tag.
boolean	isHidden(ISearchFormRenderer parent, RaritanPageContext pageContext)
void	preProcess(RaritanPageContext pageContext, java.lang.String queryWriterName, java.lang.String queryReaderName, java.lang.String applicationName, java.lang.String queryName) Process before display and heading
boolean	printHeader() Header information
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

Constructor Detail

QueryFieldSearchElementRenderer

public QueryFieldSearchElementRenderer()

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

getBody

public java.lang.String getBody(QueryResultBean qrb,
                                RaritanPageContext pageContext,
                                java.util.HashMap executeParams)

Description copied from interface: IReadQueryModule

Body for display

Specified by:

getBody in interface IReadQueryModule

isHidden

public boolean isHidden(ISearchFormRenderer parent,
                        RaritanPageContext pageContext)

Specified by:

isHidden in interface ISearchElementRenderer

getHttpQuery

protected java.lang.String getHttpQuery(QueryResultBean qrb,
                                        java.util.HashSet addedValues)

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

getHeader

public java.lang.String getHeader(java.lang.String headerClass)

Specified by:

getHeader in interface IReadQueryModule

printHeader

public boolean printHeader()

Description copied from interface: IReadQueryModule

Header information

Specified by:

printHeader in interface IReadQueryModule

preProcess

public void preProcess(RaritanPageContext pageContext,
                       java.lang.String queryWriterName,
                       java.lang.String queryReaderName,
                       java.lang.String applicationName,
                       java.lang.String queryName)

Description copied from interface: IReadQueryModule

Process before display and heading

Specified by:

preProcess in interface IReadQueryModule

getName

public java.lang.String getName()

Specified by:

getName in interface IReadQueryModule

getScript

public java.lang.String getScript(RaritanPageContext pageContext)

Specified by:

getScript in interface IReadQueryModule