com.raritantechnologies.quickstart.taglibrary.request
Class BasicRequestFormatter

java.lang.Object
  com.raritantechnologies.quickstart.taglibrary.request.BasicRequestFormatter

All Implemented Interfaces:

IConfigurable, IRequestFormatter

public class BasicRequestFormatter

extends java.lang.Object

implements IRequestFormatter

Formats an http request as a delimited string of parameter values. (e.g. "Flat file" format). Used for translating search request to log file entry.

XML Configuration Template:

  <RequestFormatter 
       class="com.raritantechnologies.quickstart.taglibrary.request.BasicRequestFormatter"
       delimiter="|" includeBlankRows="false" 
       isPersistent="[true|false(default) - request 'sticks' until valid request received ]"
       cacheKey="[ name of formatter to use for persistent cache key ]" >

    <!-- Defines the order in which parameter values will be rendered into the delimited string -->
    <Params>
       <Param ID="First_Param" />
       <Param>Next_Param</Param>

       <Param ID="[ param ID ]">
         <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

         </StringFilter>
       </Param>

    </Params>

    <!-- Defines parameters that can be used to clear the persistent value -->
    <ClearParams isAnd="[true|false(default) - if true all params must match ]" >
       <Param ID="First_Param" values="[ comma separated list of values that can clear the persistent string ]"/>
    </ClearParams>

  </RequestFormatter>

 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

protected boolean	includeBlankRows
protected java.util.ArrayList	requestParams

Constructor Summary

BasicRequestFormatter()

Method Summary

java.lang.String	formatSearchRequest(RaritanPageContext pageContext) Reformat the http request as a String.
java.lang.String	getConfigurationXML()
java.lang.String	getDelimiter()
boolean	getIncludeBlankRows()
java.lang.String[]	gsetRequestParams()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setDelimiter(java.lang.String delimiter)
void	setIncludeBlankRows(boolean includeBlankRows)
void	setRequestParams(java.lang.String[] requestParams)

Methods inherited from class java.lang.Object

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

Field Detail

requestParams

protected java.util.ArrayList requestParams

includeBlankRows

protected boolean includeBlankRows

Constructor Detail

BasicRequestFormatter

public BasicRequestFormatter()

Method Detail

formatSearchRequest

public java.lang.String formatSearchRequest(RaritanPageContext pageContext)

Description copied from interface: IRequestFormatter

Reformat the http request as a String.

Specified by:

formatSearchRequest in interface IRequestFormatter

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 IRequestFormatter

setRequestParams

public void setRequestParams(java.lang.String[] requestParams)

gsetRequestParams

public java.lang.String[] gsetRequestParams()

setDelimiter

public void setDelimiter(java.lang.String delimiter)

getDelimiter

public java.lang.String getDelimiter()

setIncludeBlankRows

public void setIncludeBlankRows(boolean includeBlankRows)

getIncludeBlankRows

public boolean getIncludeBlankRows()

getConfigurationXML

public java.lang.String getConfigurationXML()