com.raritantechnologies.concept.clustering
Class BasicClustererRenderer

java.lang.Object
  com.raritantechnologies.concept.clustering.BasicClustererRenderer

All Implemented Interfaces:

IClustererRenderer, IConfigurable

Direct Known Subclasses:

QueryResultSetClustererRenderer, SearchFormClustererRenderer, TabbedDisplayFormClustererRenderer

public abstract class BasicClustererRenderer

extends java.lang.Object

implements IClustererRenderer

Base class for Clusterer Renderers.

XML Configuration Template:

   <ClustererRenderer class="[ subclass of BasicClustererRenderer ]" 
                       maxDocs="[ maximum documents to cluster -1 is default ]"
                       searchSource="[ name of RTI SearchSource ]"
                       useCache="[ true(default)| false ]"
                       setCache="[true|false(default) ]"
                       cacheName="[name to cache parameters]"
                       cacheOnParams="[ optional list of search fields to use for cache control ]" >

     <Clusterer class="[ class of com.raritantechnologies.concept.clustering.IClusterer ]" >

     </Clusterer>

     <QueryMap>
        <Field ID="[ name of query field ]" requestParam="[ name of parameter in http request ]" exactMatch="[true|false(default)]" />
     </QueryMap>

     <FixedParams>
        <Field ID="[ name of query field ]" value="[ fixed value ]" />
     </FixedParams>

   </ClustererRenderer>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

BasicClustererRenderer()

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 clustererName, RaritanPageContext pContext)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.raritantechnologies.concept.clustering.IClustererRenderer

renderClusterer

Constructor Detail

BasicClustererRenderer

public BasicClustererRenderer()

Method Detail

renderClusterer

public java.lang.String renderClusterer(java.lang.String clustererName,
                                        RaritanPageContext pContext)

Specified by:

renderClusterer in interface IClustererRenderer

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