com.raritantechnologies.verity.taglibrary
Class DidYouMeanTag

java.lang.Object
  extended byBodyTagSupport
      extended bycom.raritantechnologies.verity.taglibrary.DidYouMeanTag

public class DidYouMeanTag
extends BodyTagSupport

JSP CustomTag that provides a Verity Did You Mean link.


Developed by Raritan Technologies Inc..

Author:
Alan Connell
See Also:
Serialized Form

Constructor Summary
DidYouMeanTag()
           
 
Method Summary
 int doStartTag()
           
 void setCollection(java.lang.String collection)
          A colon(:) separated list of collections to search collection="col1:col2:col3"
 void setLabel(java.lang.String label)
          Set the label for the link, i.e.
 void setLinkTemplate(java.lang.String linkTemplate)
           
 void setPassword(java.lang.String password)
          Password for user
 void setProperties(java.lang.String props)
          Properties for the link such as class, target onClick etc.
 void setQueryParam(java.lang.String query)
          Name of the search parameter (query)
 void setSearchSourceName(java.lang.String source)
          Can either be the name of a source configured in the application config xml or a verity collection name and port i.e.
 void setUserName(java.lang.String userName)
          User name that Verity will use to restrict which collections are searched
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DidYouMeanTag

public DidYouMeanTag()
Method Detail

setQueryParam

public void setQueryParam(java.lang.String query)
Name of the search parameter (query)


setProperties

public void setProperties(java.lang.String props)
Properties for the link such as class, target onClick etc. props="class='style' target='_top'"

Parameters:
props -

setLabel

public void setLabel(java.lang.String label)
Set the label for the link, i.e. Did you mean:

Parameters:
label -

setLinkTemplate

public void setLinkTemplate(java.lang.String linkTemplate)

setSearchSourceName

public void setSearchSourceName(java.lang.String source)
Can either be the name of a source configured in the application config xml or a verity collection name and port i.e. sourceName="XML conf name" or sourceName="localhost:6620"

Parameters:
source -

setCollection

public void setCollection(java.lang.String collection)
A colon(:) separated list of collections to search collection="col1:col2:col3"

Parameters:
collection -

setUserName

public void setUserName(java.lang.String userName)
User name that Verity will use to restrict which collections are searched

Parameters:
userName -

setPassword

public void setPassword(java.lang.String password)
Password for user

Parameters:
password -

doStartTag

public int doStartTag()
               throws JspException
Throws:
JspException