com.raritantechnologies.quickstart.taglibrary.request
Class HyperlinkRequestFormatter

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

All Implemented Interfaces:

IConfigurable, IRequestFormatter

public class HyperlinkRequestFormatter

extends java.lang.Object

implements IRequestFormatter

Formats the request as a hyperlink - can change or remove request parameters.

XML Configuration Template:

  <SystemObject type="RequestFormatter" name="[ name of request formatter ]"
                   configurableClass="com.raritantechnologies.quickstart.taglibrary.request.HyperlinkRequestFormatter"
                   baseURL="[ optional base URL (if missing, will use the incoming request baseURL ]"
                   action="action page"
                   label="[ hyperlink label ]"
                   imageURL="[ URL to image to display for link ]" 
                   excludedParams="[ comma separated list of parameter names to remove from outgoing hyperlink ]"  >

    <!-- One or more Fixed parameter values - will override incoming paramters -->
    <FixedParam name="[ param Name ]" value="[ param Value ]" />

  </RequestFormatter>















Constructor Summary
HyperlinkRequestFormatter()



           
 



Method Summary




 java.lang.String
formatSearchRequest(RaritanPageContext pageContext)



          Reformat the http request as a String.



 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
 








Constructor Detail



HyperlinkRequestFormatter
public HyperlinkRequestFormatter()






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








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