com.raritantechnologies.searchApp.taglibrary
Class BibliographicDisplayFormRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BibliographicDisplayFormRenderer

All Implemented Interfaces:

IConfigurable, IDisplayFormRenderer

public class BibliographicDisplayFormRenderer

extends java.lang.Object

implements IDisplayFormRenderer

Renders results in bibliographic format. Currently supports the following types:

field: value is taken from a result field and standard formatting is used.

format: value is taken from a result field and formatted using a format string of the form: {}, {n}, or {n,m} where n and m are integers >= 0. the integers represent character positions within the string that will be excerpted so for example '{1,3}' will take the first two characters. These can be nested.

static: a constant value is added to each output record.

XML Configuration Template:

  <DisplayForm name="brief"
      rendererClass="com.raritantechnologies.searchApp.taglibrary.BibliographicDisplayFormRenderer"
      separator="[ separator between name and value ('NONE' means no separator)]"
      fieldSeparator="\n"
      recordSeparator="-----\n"
      debug="[ true | false (default) | code; Optional debug flag, code and true both turn code debugging on]"
      outputEmptyFields="false" >

    <!-- One or more Field tags: -->
    <Field ID="[ IResult field ID ]"    name="[ display name in output ]" type="[field|static|format]" isRequired="[ true|false ]" />
    <!-- etc. . . -->

  </DisplayForm>
 

Sample output:
The following Field configuration:

   ...
    <Field ID="Title"    name="TI" type="field" isRequired="true" />
    <Field ID="Author"   name="AU" type="field"  />

    <Field ID="Company"  name="CO" value="IBM" type="static" />

    <Field ID="Type"     name="TY: '{1,1}'" type="format" />
  ...
 

would produce:
TI: The Good, the Bad, and the Ugly CO: IBM TY: 'M' ----- TI: To Kill a Mockingbird AU: Harper Lee CO: IBM TY: 'B' ----- TI: AU: John Smith CO: IBM TY: 'N' -----
Developed by Raritan Technologies .

Author:

Kepler Gelotte

Field Summary

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

TEMPLATE

Constructor Summary

BibliographicDisplayFormRenderer()

Method Summary

void	addBodyTrailerContent(java.lang.String content) Add html content to be appended to the body of the displayFormRenderer
void	disableRenderers(java.util.HashSet disabledRenderers)
void	enableRenderers(java.util.HashSet enabledRenderers)
java.lang.String	getBody(IResultSet theResults, java.lang.String displayFormName, RaritanPageContext pageContext) returns the set of results in blibliographic format.
IResultRenderer	getResultRenderer(java.lang.String name)
void	initialize(org.w3c.dom.Element elem) Initialize the display form renderer from the configuration XML.
void	initialize(java.util.Map renderParams) Initialize the display form renderer from a set of configuration parameters.
void	setDEBUG(java.lang.String debugSt)
void	setDisabledRendererParam(java.lang.String disabledParam)
void	setEnabledRendererParam(java.lang.String enabledParam)
void	setEnabledRenderers(java.lang.String displayForm, RaritanPageContext pageContext)
void	setFields(java.util.Map fields)
void	setRecordSeparator(java.lang.String recordSeparator)
void	setSeparator(java.lang.String separator)

Methods inherited from class java.lang.Object

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

Constructor Detail

BibliographicDisplayFormRenderer

public BibliographicDisplayFormRenderer()

Method Detail

initialize

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

Initialize the display form renderer from the configuration XML.

Specified by:

initialize in interface IDisplayFormRenderer

initialize

public void initialize(java.util.Map renderParams)

Initialize the display form renderer from a set of configuration parameters.

getBody

public java.lang.String getBody(IResultSet theResults,
                                java.lang.String displayFormName,
                                RaritanPageContext pageContext)

returns the set of results in blibliographic format.

Specified by:

getBody in interface IDisplayFormRenderer

getResultRenderer

public IResultRenderer getResultRenderer(java.lang.String name)

Specified by:

getResultRenderer in interface IDisplayFormRenderer

addBodyTrailerContent

public void addBodyTrailerContent(java.lang.String content)

Description copied from interface: IDisplayFormRenderer

Add html content to be appended to the body of the displayFormRenderer

Specified by:

addBodyTrailerContent in interface IDisplayFormRenderer

setEnabledRendererParam

public void setEnabledRendererParam(java.lang.String enabledParam)

Specified by:

setEnabledRendererParam in interface IDisplayFormRenderer

setDisabledRendererParam

public void setDisabledRendererParam(java.lang.String disabledParam)

Specified by:

setDisabledRendererParam in interface IDisplayFormRenderer

setEnabledRenderers

public void setEnabledRenderers(java.lang.String displayForm,
                                RaritanPageContext pageContext)

Specified by:

setEnabledRenderers in interface IDisplayFormRenderer

enableRenderers

public void enableRenderers(java.util.HashSet enabledRenderers)

Specified by:

enableRenderers in interface IDisplayFormRenderer

disableRenderers

public void disableRenderers(java.util.HashSet disabledRenderers)

Specified by:

disableRenderers in interface IDisplayFormRenderer

setSeparator

public void setSeparator(java.lang.String separator)

setRecordSeparator

public void setRecordSeparator(java.lang.String recordSeparator)

setFields

public void setFields(java.util.Map fields)

setDEBUG

public void setDEBUG(java.lang.String debugSt)