com.raritantechnologies.concept.clustering
Class SearchFormClustererRenderer

java.lang.Object
  extended bycom.raritantechnologies.concept.clustering.BasicClustererRenderer
      extended bycom.raritantechnologies.concept.clustering.SearchFormClustererRenderer
All Implemented Interfaces:
IClustererRenderer, IConfigurable

public class SearchFormClustererRenderer
extends BasicClustererRenderer

Converts a set of clustered results into a single metadata set and forwards this to a SearchFormRenderer.

XML Configuration Template:
   <ClustererRenderer class="com.raritantechnologies.concept.clustering.SearchFormClustererRenderer" >

     <SearchFormRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.ISearchFormRenderer ]" 
                            searchFormName="[ name of form ]"
                            categoryName="[ name of search source category ]"
                            initialFields="[  field=value|field2=value2 pairs of initial form parameters ]"
                            hiddenFields="[ field=value|field2=value2 paris of hidden parameter ]" 
                            action="[ form action URL ]"
                            formInitArgs="[ argments added to <form> tag ]" >

       <!-- Initialization parameter for SearchFormRenderer -->

     </SearchFormRenderer>

     <!-- Optional ResultMatcher to select results for use as SearchForm field / value pairs

     <Fields>
       <Field resultField="[ name of field ]" formField="[ name of field in form ]"
                 useValue="ALL|FIRST|LAST (if single value)" >

       </Field>
     </Fields>

   </ClustererRenderer>
 

Developed by Raritan Technologies .

Author:
Ted Sullivan

Constructor Summary
SearchFormClustererRenderer()
           
 
Method Summary
 void initialize(org.w3c.dom.Element elem)
          Initializes the object from an XML tag or element.
 java.lang.String renderClusterer(java.lang.String sessionID, IClusterer clusterer, RaritanPageContext rpc)
           
 
Methods inherited from class com.raritantechnologies.concept.clustering.BasicClustererRenderer
renderClusterer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchFormClustererRenderer

public SearchFormClustererRenderer()
Method Detail

renderClusterer

public java.lang.String renderClusterer(java.lang.String sessionID,
                                        IClusterer clusterer,
                                        RaritanPageContext rpc)

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 IConfigurable
Overrides:
initialize in class BasicClustererRenderer