com.raritantechnologies.searchApp.taglibrary
Class SaveResultsSearchFormRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicSearchFormRenderer
      com.raritantechnologies.searchApp.taglibrary.SaveResultsSearchFormRenderer

All Implemented Interfaces:

IConfigurable, ISearchFormRenderer

Direct Known Subclasses:

SavePreferencesSearchFormRenderer

public class SaveResultsSearchFormRenderer

extends BasicSearchFormRenderer

Search Form Renderer used to save currently selected results with metadata added by user input in a html form.

XML Configuration Template:

 <SearchForm rendererClass="com.raritantechnologies.searchApp.taglibrary.SaveResultsSearchFormRenderer"
                formType="[ form type parameter for save results requests ]"
                cacheResultSetName="[ name of cacheResultSet ]" >

   <SaveSelectedResults>
   <!-- mapping of search form parameters to saved result fields -->
     <ResultFields saveName="[ name of result field that gets the user-supplied group name ]"
                      userID="[ name of result field that gets UserID ]"
                      timeStamp="[ name of result field that gets save time stamp ]" >
                      dateFormat="MM/dd/yy" >
        <Field ID="[ form field ID ]" mapTo="[ optional name for result field ]" />
     </ResultFields>

     <GatewayOutputProcessor class="[ class of com.raritantechnologies.searchApp.dataCollection.IGatewayOutputProcessor ]" >

     </GatewayOutputProcessor>

     <ResultSetProcessor class="[ class of com.raritantechnologies.searchApp.IResultSetProcessor ]" >

     </ResultSetProcessor>
   </SaveSelectedResults>

   <SaveFormFields 
           userID="[ name of result field that gets UserID ]"
           timeStamp="[ name of result field that gets save time stamp ]" >
           dateFormat="MM/dd/yy"
           cacheFormFields="[true|false(default)]" >

     <Field ID="[ field id in form ]" resultID="[ field ID in result ]" />

     <GatewayOutputProcessor class="[ class of com.raritantechnologies.searchApp.dataCollection.IGatewayOutputProcessor ]" >

     </GatewayOutputProcessor>

     <ResultSetProcessor class="[ class of com.raritantechnologies.searchApp.IResultSetProcessor ]" >

     </ResultSetProcessor>
   </SaveFormFields>

   <SearchFormRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.ISearchFormRenderer" >

   </SearchFormRenderer>

 </SearchForm>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

protected boolean	cacheFormFields
protected boolean	clearAfterSave

Fields inherited from class com.raritantechnologies.searchApp.taglibrary.BasicSearchFormRenderer

action, afterFormData, category, displayStyle, formInitArgs, formMethod, formName, formType, hiddenFieldMap, hiddenFields, includeResetButton, includeSearchForm, includeSubmitButton, initialFields, onSubmitHandler, operatorMap, scriptMap, sourceMapName, submitButtonOnBottom, submitButtonText, submitHandlerName, targetFrame

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

CLEAR, PAGE, PAGE_NUM, PAGE_SIZE, RESET, SEARCH

Constructor Summary

SaveResultsSearchFormRenderer()

Method Summary

java.lang.String	getBody(java.lang.String searchFormName, java.lang.String categoryName, java.lang.String initialFields, java.lang.String hiddenFields, java.lang.String action, java.lang.String formInitArgs, RaritanPageContext pageContext) Main search form generation method.
void	initialize(org.w3c.dom.Element elem) Adds configurable properties to the renderer.
protected void	saveResults(IResultSet resSet, ILoginInfo userInfo, IGatewayOutputProcessor outputProcessor)
protected void	saveResults(IResultSet resSet, ILoginInfo userInfo, IResultSetProcessor resSetProcessor)

Methods inherited from class com.raritantechnologies.searchApp.taglibrary.BasicSearchFormRenderer

addAfterFormData, addFormScript, addHiddenField, addHiddenFields, addPersistentFields, canUpdateSearchParams, getActionURL, getCategory, getFormInitArgs, getFormMethod, getFormName, getFormStart, getFormType, getHiddenFields, getInitialFields, getOnSubmitHandler, getSubmitHandlerName, renderHiddenFields, renderScripts, setFormMethod, setFormName, setFormType, setOnSubmitHandler, setSubmitHandlerName, updateSearchParams

Methods inherited from class java.lang.Object

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

Field Detail

cacheFormFields

protected boolean cacheFormFields

clearAfterSave

protected boolean clearAfterSave

Constructor Detail

SaveResultsSearchFormRenderer

public SaveResultsSearchFormRenderer()

Method Detail

getBody

public java.lang.String getBody(java.lang.String searchFormName,
                                java.lang.String categoryName,
                                java.lang.String initialFields,
                                java.lang.String hiddenFields,
                                java.lang.String action,
                                java.lang.String formInitArgs,
                                RaritanPageContext pageContext)

Description copied from interface: ISearchFormRenderer

Main search form generation method. Creates a <form ...> ... </form> HTML fragment.

Specified by:

getBody in interface ISearchFormRenderer

Overrides:

getBody in class BasicSearchFormRenderer

saveResults

protected void saveResults(IResultSet resSet,
                           ILoginInfo userInfo,
                           IResultSetProcessor resSetProcessor)

saveResults

protected void saveResults(IResultSet resSet,
                           ILoginInfo userInfo,
                           IGatewayOutputProcessor outputProcessor)

initialize

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

Description copied from class: BasicSearchFormRenderer

Adds configurable properties to the renderer.

Specified by:

initialize in interface ISearchFormRenderer

Overrides:

initialize in class BasicSearchFormRenderer