GetFormHyperlinkRenderer

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.raritantechnologies.quickstart.taglibrary
Class GetFormHyperlinkRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      com.raritantechnologies.quickstart.taglibrary.GetFormHyperlinkRenderer

All Implemented Interfaces:: IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class GetFormHyperlinkRenderer
extends BasicResultRenderer
implements IResultRenderer

Renders an IResult as a hyperlink to a jsp or servlet process. Takes a set of parameter IDs used to look up dynamic parameters, an action URL and a set of fixed parameters (name/value pairs). Builds a hyperlink using an IResult where the dynamic parameter values are extracted from the field values of the IResult object.

XML Configuration Template:

       <ResultRenderer 
           rendererClass="com.raritantechnologies.quickstart.taglibrary.GetFormHyperlinkRenderer"
           target="new" 
           isPopup="true|false(default) - set true for new window target"
           setFocus="[true|false(default) - call focus() on new window"
           includeSessionID="[true|false(default)]" 
           includeResultNum="[true|false(default)]"
           includeSourceName="[true|false(default)]"
           cssClass="someClass"
           defaultValue="[what to put if no result value]"
           title="[anchor title - used for roll-over text]" >
   
         <-- setting includResultNum to "true" causes the resulting link to include
                the result number for the current result as the "resultNum" request 
                parameter (&resultNum=XX) -->
   
         <LinkField ID="Title" />  <!-- Alternate LabelField for compatibility with FieldHyperlinkRenderer -->
  
         <!-- Optional or Label -->
         <Label value="The Label" >
  
         <!-- OR ResultRenderer -->
         <LinkRenderer rendererClass="[some result renderer]" >
            <!-- FieldRenderer stuff... -->
         </LinkRenderer>
  
         <Host>http://www.somehost.com/</Host>
         <Action>someActionJsp.jsp</Action>
  
         &lt!-- ParamField(s) are parameters that are picked up from the Result -->
         <ParamField ID="someParam" name="[ name in URL output ]" />
         <ParamField ID="SomeOtherField" name="[ other Name In URL ]" default="foo" multiple="true|false(default)" />

         <!-- ParamField can have an optional StringFilter -->
         <ParamField ID="[result field ID ]" name="[ name in URL output ]" >
           <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

           </StringFilter>
         </ParamField>
  
         <!-- SessionField(s) are picked up from the SessionData cache -->
         <SessionField ID="Some cached field in SessionData map" name="name to use in URL" />
  
         <!-- QueryField(s) are picked up from the last Query run -->
         <QueryField ID="field in query map" name="name in URL" />
  
         <!-- FixedParam(s) are added as is -->
         <FixedParam name="paramName" value="paramValue" />

         <!-- Fixed parameters can be conditional -->
         <FixedParam name="paramName" value="paramValue" >
            <!-- RequestComparator Tag: -->
            <RequestComparator param="[ name of request parameter to compare ]" class="[ class of com.raritantechnologies.utils.comparators.IComparator ]" >
            </RequestComparator>
         </FixedParam>
  
         <SecurityManager name="secManagerName" loginURL="someURLForLogin.jsp" 
                             failureMessage="Access denied. Consult your System administrator"
                             loginFailPage="[NAME of login failed page - points to name in paramMap]" >
           <params>
              <param name="foo" value="bar" />
           </params>
         </SecurityManager>

         <!-- Anchor '#' field (optional) -->
         <Anchor ID="[ result field that creates anchor value ]">
           <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter" >

           </StringFilter
         </Anchor>
       </ResultRenderer>

ParamField tags list the parameters of the IResult that should be renderered.

The ID attribute should map to a result field defined in the section of the configuration XML.
The name attribute is the name that will be used in the get request string.

In the above example, the ParamField tags would generate the following:
&someName=[value of 'someParam' field in IResult]&otherNameInURL=[value of 'SomeOtherField']

FixedParam tags list static parameters that should be added to the get request string. They can be used to link the GetFormHyperlinkRenderer with other elements in the application (such as Content Handlers).

The <SecurityManager> tag is optional and is used when a login challenge may be needed to access the hyperlink.

Can be used to set up proxy: if "action" is a proxy servlet (such as a logging or security servlet): add action=realServlet.jsp as a static parameter.

Developed by Raritan Technologies Inc. .

Author:: Ted Sullivan, Alan Connell, Jim Nicholson

Field Summary
`static java.lang.String`	`ACTION`
`static java.lang.String`	`FORM_PARAM_IDS`
`static java.lang.String`	`HOST`
`static java.lang.String`	`LINK_ID`
`static java.lang.String`	`RESULTNUM_TAG`
`static java.lang.String`	`SOURCENAME_TAG`

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

enabled, name, prefBeanName, prefCompareValue, prefEnableIfInChecklist, prefEnableIfInYesno

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

TEMPLATE

Constructor Summary
`GetFormHyperlinkRenderer()`
`GetFormHyperlinkRenderer(java.lang.String linkField, java.util.HashMap formParamIDs, java.lang.String host, java.lang.String action, java.util.Map fixedParams)`

Method Summary
`void`	`addQueryParameter(java.lang.String paramID, java.lang.String paramName)`
`void`	`addResultField(java.lang.String paramID, java.lang.String paramName, java.lang.String defaultValue)`
`void`	`addSessionParameter(java.lang.String paramID, java.lang.String paramName)`
`void`	`addStaticParameter(java.lang.String paramName, java.lang.String paramValue)`
`protected java.lang.String`	`doRenderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext)`
`java.lang.String`	`getAction()`
`java.lang.String`	`getConfigurationXML()`
`java.lang.String`	`getConfigurationXML(java.lang.String configurationTemplate)`
`void`	`getConfigurationXML(java.io.Writer writer)`
`java.lang.String`	`getCssClass(java.lang.String clazz)`
`java.lang.String`	`getDefaultValue()`
`java.lang.String`	`getFailureMessage()`
`java.lang.String`	`getHost()`
`boolean`	`getIncludeResultNumInLink()`
`boolean`	`getIncludeSessionID()`
`boolean`	`getIsPopup()`
`java.lang.String`	`getLinkField()`
`java.lang.String`	`getLinkLabel()`
`IResultRenderer`	`getLinkRenderer()`
`java.lang.String`	`getLoginFailPage()`
`java.lang.String`	`getLoginURL()`
`BasicDataTable`	`getQueryParameters()`
`BasicDataTable`	`getResultFields()`
`java.lang.String`	`getSecurityManagerName()`
`BasicDataTable`	`getSessionParameters()`
`boolean`	`getShouldChallenge()`
`java.lang.String`	`getTarget()`
`java.lang.String`	`getTitle()`
`java.lang.String`	`getWindowOptions()`
`void`	`initialize(org.w3c.dom.Element elem)` IResultRenderers are XML configurable.
`void`	`initialize(java.util.Map renderParams)`
`void`	`setAction(java.lang.String action)`
`void`	`setCssClass(java.lang.String clazz)`
`void`	`setDefaultValue(java.lang.String defaultValue)`
`void`	`setFailureMessage(java.lang.String failureMessage)`
`void`	`setHost(java.lang.String host)`
`void`	`setIncludeResultNumInLink(boolean includeResultNumInLink)`
`void`	`setIncludeSessionID(boolean includeSessionID)`
`void`	`setIsPopup(boolean isPopup)`
`void`	`setLinkField(java.lang.String linkField)`
`void`	`setLinkLabel(java.lang.String linkLabel)`
`void`	`setLinkRenderer(IResultRenderer linkRenderer)`
`void`	`setLoginFailPage(java.lang.String loginFailPage)`
`void`	`setLoginURL(java.lang.String loginURL)`
`void`	`setQueryFields(BasicDataTable queryFieldTable)`
`void`	`setResultFields(BasicDataTable resultTable)`
`void`	`setSecurityManagerName(java.lang.String securityManagerName)`
`void`	`setSessionFields(BasicDataTable sessionFieldTable)`
`void`	`setShouldChallenge(boolean shouldChallenge)`
`void`	`setTarget(java.lang.String target)`
`void`	`setTitle(java.lang.String title)`
`void`	`setWindowOptions(java.lang.String window_options)`

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

getPrefBeanName, getPrefCompareValue, getPrefEnableIfInChecklist, getPrefEnableIfInYesno, getRenderer, isEnabled, renderResult, setEnable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.raritantechnologies.searchApp.taglibrary.IResultRenderer

getRenderer, isEnabled, renderResult, setEnable

Field Detail

LINK_ID

public static final java.lang.String LINK_ID

See Also:: Constant Field Values

HOST

public static final java.lang.String HOST

See Also:: Constant Field Values

ACTION

public static final java.lang.String ACTION

See Also:: Constant Field Values

RESULTNUM_TAG

public static final java.lang.String RESULTNUM_TAG

See Also:: Constant Field Values

FORM_PARAM_IDS

public static final java.lang.String FORM_PARAM_IDS

See Also:: Constant Field Values

SOURCENAME_TAG

public static final java.lang.String SOURCENAME_TAG

See Also:: Constant Field Values

Constructor Detail