com.raritantechnologies.concept.clustering
Class TabbedDisplayFormClustererRenderer

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

All Implemented Interfaces:

IClustererRenderer, IConfigurable

public class TabbedDisplayFormClustererRenderer

extends BasicClustererRenderer

Renders a set of clustered IResultSets using a tabbed set of IDisplayFormRenderers. The tabs names are derived from the names of the clusters generated by the IClusterer whose output is being displayed. If necessary, the tab display name can be generated from the names of the extracted clusters using an IStringFilter.

XML Configuration Template:

   <ClustererRenderer class="com.raritantechnologies.concept.clustering.TabbedDisplayFormClustererRenderer" 
                       maxDocs="[ maximum documents to cluster -1 is default ]"
                       useCache="[ true(default)| false ]" >

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

     </Clusterer>

     <QueryMap>
        <Field ID="[ name of query field ]" requestParam="[ name of parameter in http request ]" />
     </QueryMap>

     <TabRenderer class="[Tab Renderer class]" >
       <!-- details needed by TabRenderer -->
     </TabRenderer>

     <!-- Optional set of fields to use to detect duplicate records -->
     <DuplicateMatchers>
        <Field ID="name of field" />
     </DuplicateMatchers>

     <DisplayFormRenderer class="[ class of IDisplayFormRenderer ]" >
     </DisplayFormRenderer>

     <!-- StringFilter to change clusterName to displayName -->
     <TabDisplayFilter class="[ class of IStringFilter ]" >
     </TabDisplayFilter>

   </ClustererRenderer>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

protected TabRenderer

tabRenderer

Constructor Summary

TabbedDisplayFormClustererRenderer()

Method Summary

void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
protected java.util.Map	initializeTabRenderer(java.util.Set clusterNames)
java.lang.String	renderClusterer(java.lang.String sessionID, IClusterer clusterer, RaritanPageContext pageContext)

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

Field Detail

tabRenderer

protected TabRenderer tabRenderer

Constructor Detail

TabbedDisplayFormClustererRenderer

public TabbedDisplayFormClustererRenderer()

Method Detail

renderClusterer

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

initializeTabRenderer

protected java.util.Map initializeTabRenderer(java.util.Set clusterNames)

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