com.raritantechnologies.searchApp.query
Interface IQueryResultSetFormatter

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

QueryResultSetChartFormatter, TestQueryCountFormatter

public interface IQueryResultSetFormatter

extends IConfigurable

Basic QueryResultSetFormatter interface for objects that can format a query string from a set of QueryResultBean objects.

Each QueryResultSetFormatter implementation must convert a QueryResultBeanSet into a String.

QueryResultSetFormatters are configured using the general purpose SystemObjects:

 <SystemObject type="QueryFormatter" name="[its Name]" class="[the implementation class]" />
 

Developed by Raritan Technologies .

Author:

Ted Sullivan, Glenn Robitaille

Method Summary

void	appendCounts(boolean append)
java.lang.String	formatQuerySet(QueryResultBeanSet qrbs, int sortByConstant) Returns a string for the form parameters submitted in queryParams that is in the correct format.
java.lang.String	formatQuerySet(java.lang.String sessionID, QueryResultBeanSet qrbs, int sortByConstant)
java.lang.String	formatQuerySetSeries(java.lang.String sessionID, QueryResultBeanSet[] querySets, java.lang.String[] seriesLabels) Format a series of QueryResultBeanSets.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Method Detail

formatQuerySet

public java.lang.String formatQuerySet(QueryResultBeanSet qrbs,
                                       int sortByConstant)

Returns a string for the form parameters submitted in queryParams that is in the correct format.

formatQuerySet

public java.lang.String formatQuerySet(java.lang.String sessionID,
                                       QueryResultBeanSet qrbs,
                                       int sortByConstant)

formatQuerySetSeries

public java.lang.String formatQuerySetSeries(java.lang.String sessionID,
                                             QueryResultBeanSet[] querySets,
                                             java.lang.String[] seriesLabels)

Format a series of QueryResultBeanSets.

appendCounts

public void appendCounts(boolean append)

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