com.raritantechnologies.quickstart.taglibrary.request
Class PathRequestFormatter

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

All Implemented Interfaces:

IConfigurable, IRequestFormatter

public class PathRequestFormatter

extends java.lang.Object

implements IRequestFormatter

Converts a path value to a set of hyperlinks that preserve their own level. Useful for "breadcrumb" displays of current category or taxonomy path selections, etc.

XML Configuration Template:

   <RequestFormatter class="com.raritantechnologies.quickstart.taglibrary.request.PathRequestFormatter"
                        paramField="[ field in http parameter with path value ]"
                        pathDelimiter="[delimiter - default '/' ]"
                        displayDelimiter="[ delimiter for display default ' / ' ]"
                        displayInitialDelimiter="[ true(default)| false ]"
                        actionTemplate="[ action URL template with {PATH} indicating where path href should go ]"
                        startLevel="[ initial level to start displaying path links ]"
                        exactMatch="[ true(default)|false - if true, enclose path in single quote ]"
                        requestParams="[ comma separated list of request parameters to include in link ]" >

   </RequestFormatter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

PathRequestFormatter()

Method Summary

java.lang.String	formatSearchRequest(RaritanPageContext pageContext) Reformat the http request as a String.
java.lang.String	getConfigurationXML()
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

PathRequestFormatter

public PathRequestFormatter()

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

getConfigurationXML

public java.lang.String getConfigurationXML()