com.raritantechnologies.quickstart.taglibrary.request
Class NextResultFormatter

java.lang.Object
  com.raritantechnologies.quickstart.taglibrary.request.NextResultFormatter

All Implemented Interfaces:

IConfigurable, IRequestFormatter

public class NextResultFormatter

extends java.lang.Object

implements IRequestFormatter

Creates a Hyperlink to the next / previous result in a result set. Useful for Full Text display pages.

XML Configuration Template:

   <RequestFormatter class="com.raritantechnologies.quickstart.taglibrary.request.NextResultFormatter"
                        direction="NEXT(default)|PREVIOUS"
                        sourceType="[ fixed sourceType ]"
                        sourceTypeParam="[ parameter for source type ]"
                        categoryParams="[ name of cached sources parameter(s) ]"
                        checkFederatedSource="true|false"
                        resultNumParam="[ name of request parameter with current result number ]"
                        activeOnParam="paramName=paramValue"
                        cacheKey="[ key to use for caching ]"
                        label="[ prepended link label ]" >

     <HyperlinkRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.IResultRenderer that can create
                                    a hyperlink ]" >
     </HyperlinkRenderer>

   </RequestFormatter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

static java.lang.String

RESULT_NUM

Constructor Summary

NextResultFormatter()

Method Summary

java.lang.String	formatSearchRequest(RaritanPageContext pageContext) Reformat the http request as a String.
protected java.lang.String	getSourceCategory(RaritanPageContext rPageContext)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Field Detail

RESULT_NUM

public static final java.lang.String RESULT_NUM

See Also:

Constant Field Values

Constructor Detail

NextResultFormatter

public NextResultFormatter()

Method Detail

formatSearchRequest

public java.lang.String formatSearchRequest(RaritanPageContext pageContext)

Description copied from interface: IRequestFormatter

Reformat the http request as a String.

Specified by:

formatSearchRequest in interface IRequestFormatter

getSourceCategory

protected java.lang.String getSourceCategory(RaritanPageContext rPageContext)

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 IRequestFormatter