com.raritantechnologies.searchApp.query
Class HyperlinkQueryFormatter

java.lang.Object
  com.raritantechnologies.searchApp.query.HyperlinkQueryFormatter

All Implemented Interfaces:

IConfigurable, IQueryFormatter

public class HyperlinkQueryFormatter

extends java.lang.Object

implements IQueryFormatter

Formats a set of query parameter|value pairs as a hyperlink to a search result display page.

XML Configuration Template:

 <QueryFormatter class="com.raritantechnologies.searchApp.query.HyperlinkQueryFormatter"
                 host="/" action="somePage.jsp" label="some label" labelField="someQueryField"
                 target="top"
                 cssClass="someClass"
                 displayQueryParams="false"
                 addBlankParams="true|false" >

    <!-- parameters to be added to query -->
    <Parameters>
       <Param name="pageNum" value="1" />
       <Param name="formType" value="search" />
       <Param name="textQuery" value="$query" />  
    <ExcludeParameters>
       <!-- one or more Param elements -->
       <Param name="[ excluded parameter name]" />
       <Param name="[ another parameter ]" /> 
    </ExcludeParameters>

 </QueryFormatter>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

HyperlinkQueryFormatter()

Method Summary

void	addParameter(java.lang.String name, java.lang.String value)
void	appendCounts(boolean append)
java.lang.String	formatQuery(RaritanPageContext pageContext) Format a query from the current input context:
java.lang.String	formatQuery(java.lang.String sessionID, OrderedMap queryParams)
java.lang.String	formatQuery(java.lang.String sessionID, QueryResultBean qrb) Returns a string for the form parameters submitted in queryParams that is in the correct format.
java.lang.String	getHref(OrderedMap queryParams)
java.lang.String	getHref(QueryResultBean qrb)
java.lang.String	getHref(RaritanPageContext pageContext)
java.lang.String	getLabel(OrderedMap queryParams, QueryResultBean qrb)
java.lang.String	getLabel(QueryResultBean qrb)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setAction(java.lang.String action)
void	setHost(java.lang.String host)
void	setLabel(java.lang.String label)
void	setLabelField(java.lang.String fieldID)

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperlinkQueryFormatter

public HyperlinkQueryFormatter()

Method Detail

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 IQueryFormatter

setHost

public void setHost(java.lang.String host)

setAction

public void setAction(java.lang.String action)

setLabel

public void setLabel(java.lang.String label)

setLabelField

public void setLabelField(java.lang.String fieldID)

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

appendCounts

public void appendCounts(boolean append)

Specified by:

appendCounts in interface IQueryFormatter

formatQuery

public java.lang.String formatQuery(java.lang.String sessionID,
                                    QueryResultBean qrb)

Description copied from interface: IQueryFormatter

Returns a string for the form parameters submitted in queryParams that is in the correct format.

Specified by:

formatQuery in interface IQueryFormatter

formatQuery

public java.lang.String formatQuery(java.lang.String sessionID,
                                    OrderedMap queryParams)

Specified by:

formatQuery in interface IQueryFormatter

formatQuery

public java.lang.String formatQuery(RaritanPageContext pageContext)

Description copied from interface: IQueryFormatter

Format a query from the current input context:

Specified by:

formatQuery in interface IQueryFormatter

getHref

public java.lang.String getHref(QueryResultBean qrb)

getHref

public java.lang.String getHref(OrderedMap queryParams)

getHref

public java.lang.String getHref(RaritanPageContext pageContext)

getLabel

public java.lang.String getLabel(QueryResultBean qrb)

getLabel

public java.lang.String getLabel(OrderedMap queryParams,
                                 QueryResultBean qrb)