com.raritantechnologies.searchApp.taglibrary
Class MultipleValueResultRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      com.raritantechnologies.searchApp.taglibrary.MultipleValueResultRenderer

All Implemented Interfaces:

IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class MultipleValueResultRenderer

extends BasicResultRenderer

implements IResultRenderer

Renders an IResult with multiple field values or nested IResultSets as separate rendering operations using a nested or proxy IResultRenderer. The renderer can also handle delimited single value fields.

Configuration determines which fields to pass to the proxy renderer gets the multi-value field and puts it as value of the fieldID to pass to the proxyRenderer.

XML Configuration Template:

  <ResultRenderer 
     rendererClass="com.raritantechnologies.searchApp.taglibrary.MultipleValueResultRenderer" 
     name="rendererName" 
     multiValField="fieldID"
     nColumns="3"
     delimiter="[ character used for delimited field values ]" 
     sortValues="[ true|false(default) ]"
     columnSeparator=",&nbsp;"
     columnWidth="[ width of columns ]"
     tableProps="[ properties for inner table ]"
     trProps="[ properties for inner rows ]"
     bgcolor1="[ rgb color for odd-numbered rows ]"
     bgcolor2="[ rgb color for even-numbered rows ]" >

    <ResultRenderer rendererClass="[the child renderer...]" >
      <!-- child renderer details -->
    </ResultRenderer>

 </ResultRenderer>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer

enabled, name, prefBeanName, prefCompareValue, prefEnableIfInChecklist, prefEnableIfInYesno

Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IResultRenderer

TEMPLATE

Constructor Summary

MultipleValueResultRenderer()

Method Summary

protected java.lang.String	doRenderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext)
java.lang.String	getColumnSeparator()
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
void	getConfigurationXML(java.io.Writer writer)
java.lang.String	getDelimiter()
java.lang.String	getFieldID()
int	getNColumns()
IResultRenderer	getProxyRenderer()
boolean	getUseRows()
boolean	getUseTable()
void	initialize(org.w3c.dom.Element elem) IResultRenderers are XML configurable.
void	setColumnSeparator(java.lang.String columnSeparator)
void	setDelimiter(java.lang.String delimiter)
void	setFieldID(java.lang.String multiValField)
void	setNColumns(int nColumns)
void	setProxyRenderer(IResultRenderer proxyRenderer)
void	setResultRenderer(IResultRenderer proxyRenderer)
void	setUseRows(boolean useRows)
void	setUseTable(boolean useTable)

Methods inherited from class com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer

getPrefBeanName, getPrefCompareValue, getPrefEnableIfInChecklist, getPrefEnableIfInYesno, getRenderer, isEnabled, renderResult, setEnable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.raritantechnologies.searchApp.taglibrary.IResultRenderer

getRenderer, isEnabled, renderResult, setEnable

Constructor Detail

MultipleValueResultRenderer

public MultipleValueResultRenderer()

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IResultRenderer

IResultRenderers are XML configurable.

Specified by:

initialize in interface IResultRenderer

Overrides:

initialize in class BasicResultRenderer

doRenderResult

protected java.lang.String doRenderResult(IResult result,
                                          int firstResult,
                                          int lastResult,
                                          int resultNum,
                                          RaritanPageContext pageContext)

Specified by:

doRenderResult in class BasicResultRenderer

setFieldID

public void setFieldID(java.lang.String multiValField)

getFieldID

public java.lang.String getFieldID()

setResultRenderer

public void setResultRenderer(IResultRenderer proxyRenderer)

setProxyRenderer

public void setProxyRenderer(IResultRenderer proxyRenderer)

getProxyRenderer

public IResultRenderer getProxyRenderer()

setUseTable

public void setUseTable(boolean useTable)

getUseTable

public boolean getUseTable()

setUseRows

public void setUseRows(boolean useRows)

getUseRows

public boolean getUseRows()

setNColumns

public void setNColumns(int nColumns)

getNColumns

public int getNColumns()

setDelimiter

public void setDelimiter(java.lang.String delimiter)

getDelimiter

public java.lang.String getDelimiter()

setColumnSeparator

public void setColumnSeparator(java.lang.String columnSeparator)

getColumnSeparator

public java.lang.String getColumnSeparator()

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IResultRenderer

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)

Specified by:

getConfigurationXML in interface IResultRenderer