com.raritantechnologies.quickstart.taglibrary
Class SizeFieldRenderer

java.lang.Object
  extended bycom.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      extended bycom.raritantechnologies.quickstart.taglibrary.SizeFieldRenderer
All Implemented Interfaces:
IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class SizeFieldRenderer
extends BasicResultRenderer
implements IResultRenderer

Renders a IResult size field in Kb, Mb, Gb, and Tb.

XML Configuration Template:
   <ResultRenderer 
       rendererClass="com.raritantechnologies.quickstart.taglibrary.SizeFieldRenderer" >

     <Field ID="DOC_SZ" units="Kb,Mb" />

   </ResultRenderer>
 

The <Field> tag is used to specify which field in the result is to be used to provide the value for the renderer. Sample HTML output:

 425 Kb 
 

Developed by Raritan Technologies Inc..

Author:
Kepler Gelotte

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
SizeFieldRenderer()
           
 
Method Summary
protected  java.lang.String doRenderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext)
           
 java.lang.String getConfigurationXML()
           
 java.lang.String getConfigurationXML(java.lang.String configurationTemplate)
           
 void getConfigurationXML(java.io.Writer writer)
           
 java.lang.String getCssClass()
           
 long getFactor()
           
 java.lang.String getFieldID()
           
 java.lang.String[] getUnits()
           
 void initialize(org.w3c.dom.Element elem)
          IResultRenderers are XML configurable.
 void setCssClass(java.lang.String cssClass)
           
 void setFactor(long factor)
           
 void setFieldID(java.lang.String fieldID)
           
 void setUnits(java.lang.String[] units)
           
 
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

SizeFieldRenderer

public SizeFieldRenderer()
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 fieldID)

getFieldID

public java.lang.String getFieldID()

setUnits

public void setUnits(java.lang.String[] units)

getUnits

public java.lang.String[] getUnits()

setFactor

public void setFactor(long factor)

getFactor

public long getFactor()

setCssClass

public void setCssClass(java.lang.String cssClass)

getCssClass

public java.lang.String getCssClass()

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