com.raritantechnologies.searchApp.query
Interface IQueryFormatter

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

DisplayQueryFormatter, HyperlinkQueryFormatter, SimpleQueryFormatter, VerityQueryFormatter

public interface IQueryFormatter

extends IConfigurable

Each QueryFormatter implementation must convert a set of form parameters contained in a java.util.Map into a Query string. The ISearchFieldMap is used to ensure that the QueryFormatter is correctly matched to an input form and to the SearchSource(s) against which the query was executed.

QueryFormatters 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	formatQuery(RaritanPageContext pageContext) Format a query from the current input context:
java.lang.String	formatQuery(java.lang.String sessionID, OrderedMap query)
java.lang.String	formatQuery(java.lang.String sessionID, QueryResultBean qrb) Returns a string for the form parameters submitted in queryParams that is in the correct format.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Method Detail

formatQuery

public java.lang.String formatQuery(RaritanPageContext pageContext)

Format a query from the current input context:

formatQuery

public java.lang.String formatQuery(java.lang.String sessionID,
                                    QueryResultBean qrb)

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

formatQuery

public java.lang.String formatQuery(java.lang.String sessionID,
                                    OrderedMap query)

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