com.raritantechnologies.quickstart.taglibrary.request
Class RequestSearchElementFormatter

java.lang.Object
  extended bycom.raritantechnologies.quickstart.taglibrary.request.RequestSearchElementFormatter
All Implemented Interfaces:
IConfigurable, IRequestFormatter

public class RequestSearchElementFormatter
extends java.lang.Object
implements IRequestFormatter

RequestFormatter that wraps a ISearchElementRenderer.

XML Configuration Template:
   <RequestFormatter class="com.raritantechnologies.utils.taglibrary.request.RequestSearchElementFormatter"
                        searchFormName="[ name of search form ]" 
                        categoryName="[ source category ]" >

    <SearchElementRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.ISearchElementRenderer ]" >
      <!-- configuration parameters for SearchElementRenderer -->
    </SearchElementRenderer>

   </RequestFormatter>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Constructor Summary
RequestSearchElementFormatter()
           
 
Method Summary
 java.lang.String formatSearchRequest(RaritanPageContext pageContext)
          Reformat the http request as a String.
 java.lang.String getCategoryName()
           
 java.lang.String getConfigurationXML()
           
 ISearchElementRenderer getSearchElementRenderer()
           
 java.lang.String getSearchFormName()
           
 void initialize(org.w3c.dom.Element elem)
          Initializes the object from an XML tag or element.
 void setCategoryName(java.lang.String categoryName)
           
 void setSearchElementRenderer(ISearchElementRenderer seRenderer)
           
 void setSearchFormName(java.lang.String searchFormName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RequestSearchElementFormatter

public RequestSearchElementFormatter()
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

setSearchElementRenderer

public void setSearchElementRenderer(ISearchElementRenderer seRenderer)

getSearchElementRenderer

public ISearchElementRenderer getSearchElementRenderer()

setSearchFormName

public void setSearchFormName(java.lang.String searchFormName)

getSearchFormName

public java.lang.String getSearchFormName()

setCategoryName

public void setCategoryName(java.lang.String categoryName)

getCategoryName

public java.lang.String getCategoryName()

getConfigurationXML

public java.lang.String getConfigurationXML()