com.raritantechnologies.verity.parametric
Class ParametricSearchBean

java.lang.Object
  com.raritantechnologies.verity.parametric.ParametricSearchBean

public class ParametricSearchBean

extends java.lang.Object

Connects the Parametric User Interface layer to the Parametric Index search layer. Maps Servlet requests to query requests, maintains VParametricSearch object cache. Maintains user session state.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

ParametricSearchBean(ILoginInfo userInfo, java.lang.String sourceName, RaritanPageContext rPageContext, IParametricSourceSpec pss, java.lang.String action, java.lang.String target)
This constructor can be used by ASP code

ParametricSearchBean(ILoginInfo userInfo, java.lang.String sourceName, ServletRequest initialSettings, IParametricSourceSpec pss, java.lang.String action, java.lang.String target, HttpSession session)

ParametricSearchBean(ILoginInfo userInfo, java.lang.String sourceName, ServletRequest initialSettings, java.lang.String action, java.lang.String target, HttpSession session)

Method Summary

void	executeQuery(ServletRequest queryParams, java.lang.Integer pageSize, java.lang.Integer startRec) This form of executeQuery can be used by Java Servlet based applications...
java.lang.String	getAction()
java.util.Set	getAllAttributeFieldNames()
java.util.Set	getAllEnumFieldNames()
java.util.Set	getAllTaxFieldNames()
CheckBoxSelector	getCheckboxSelector(java.lang.String fieldName, int colCount)
boolean	getClearQueryOnBrowsePolicy()
java.lang.String	getCurrentQuery()
OrderedMap	getCurrentQueryParams()
IResultSet	getCurrentResults()
java.lang.String	getCurrentTaxonomyPath(java.lang.String taxField) returns the current path of a taxonomy view:
ParaDocumentSearcher	getDocumentSearcher()
EnumView	getEnumView(java.lang.String fieldname)
KTreeView	getKTreeView(java.lang.String fieldname)
long	getNumProcessed()
PagingManager	getPagingManager(java.lang.String pageNum, int numPerPage, int numPageLinks)
PagingManager	getPagingManager(java.lang.String pageNum, int numPerPage, int numPageLinks, java.lang.String pagingManagerClass)
java.lang.Object	getParam(java.lang.String name)
ParametricSelector	getParametricMultiSelector(java.lang.String fieldName)
ParametricSelector	getParametricSelector(java.lang.String fieldName, java.lang.String submitButtonCall)
ParametricSearchSource	getParametricSource()
java.lang.String	getParentTaxonomyPath(java.lang.String taxField)
RarTaxRenderer	getRarTaxRenderer(KTreeView taxView, java.lang.String titleclass, java.lang.String headerclass, java.lang.String bodyclass, java.lang.String query, int maxchar, java.lang.String title)
RarTaxRenderer	getRarTaxRenderer(KTreeView taxView, java.lang.String titleclass, java.lang.String headerclass, java.lang.String bodyclass, java.lang.String query, int maxchar, java.lang.String title, java.lang.String useConnector)
java.lang.String	getTarget()
TaxonomyCounterRenderer	getTaxonomyCounterRenderer(java.lang.String taxonomy, java.lang.String titleclass, java.lang.String headerclass, java.lang.String bodyclass, java.lang.String sortBy, java.lang.String sortDir, java.lang.String title, boolean orderByName, int rows, int cols, int maxchar)
TaxonomyPieRenderer	getTaxonomyPieRenderer(java.lang.String taxonomy, java.lang.String titleclass, java.lang.String headerclass, java.lang.String bodyclass, java.lang.String sortBy, java.lang.String sortDir, java.lang.String title, boolean orderByName, int rows, int cols, int maxchar)
TreeRenderer	getTreeRenderer(KTreeView taxView, java.lang.String titleclass, java.lang.String headerclass, java.lang.String bodyclass, int cols, java.lang.String sortBy, java.lang.String sortDir, int maxchar, java.lang.String title)
VParametricSearch	getVParametricSearch()
boolean	haveBrowseField(ServletRequest request)
void	resetQueryFields()
void	setAction(java.lang.String action)
void	setParam(java.lang.String name, java.lang.Object value)
void	setTarget(java.lang.String target)
boolean	shouldClearQuery()
void	valueBound(HttpSessionBindingEvent event)
void	valueUnbound(HttpSessionBindingEvent event) This method should be called when the HttpSession is destroyed by the App server.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametricSearchBean

public ParametricSearchBean(ILoginInfo userInfo,
                            java.lang.String sourceName,
                            ServletRequest initialSettings,
                            java.lang.String action,
                            java.lang.String target,
                            HttpSession session)
                     throws UnsupportedLanguageException,
                            QueryParseException

ParametricSearchBean

public ParametricSearchBean(ILoginInfo userInfo,
                            java.lang.String sourceName,
                            ServletRequest initialSettings,
                            IParametricSourceSpec pss,
                            java.lang.String action,
                            java.lang.String target,
                            HttpSession session)
                     throws UnsupportedLanguageException,
                            QueryParseException

ParametricSearchBean

public ParametricSearchBean(ILoginInfo userInfo,
                            java.lang.String sourceName,
                            RaritanPageContext rPageContext,
                            IParametricSourceSpec pss,
                            java.lang.String action,
                            java.lang.String target)
                     throws UnsupportedLanguageException,
                            QueryParseException

This constructor can be used by ASP code

Method Detail

setAction

public void setAction(java.lang.String action)

getAction

public java.lang.String getAction()

setTarget

public void setTarget(java.lang.String target)

getTarget

public java.lang.String getTarget()

valueBound

public void valueBound(HttpSessionBindingEvent event)

valueUnbound

public void valueUnbound(HttpSessionBindingEvent event)

This method should be called when the HttpSession is destroyed by the App server.

executeQuery

public void executeQuery(ServletRequest queryParams,
                         java.lang.Integer pageSize,
                         java.lang.Integer startRec)
                  throws QueryProcessorException,
                         UnsupportedLanguageException,
                         QueryParseException

This form of executeQuery can be used by Java Servlet based applications...

Throws:

QueryProcessorException

UnsupportedLanguageException

QueryParseException

getCurrentResults

public IResultSet getCurrentResults()

getNumProcessed

public long getNumProcessed()

getAllTaxFieldNames

public java.util.Set getAllTaxFieldNames()

getAllEnumFieldNames

public java.util.Set getAllEnumFieldNames()

getAllAttributeFieldNames

public java.util.Set getAllAttributeFieldNames()

getCheckboxSelector

public CheckBoxSelector getCheckboxSelector(java.lang.String fieldName,
                                            int colCount)

getParametricSelector

public ParametricSelector getParametricSelector(java.lang.String fieldName,
                                                java.lang.String submitButtonCall)

getParametricMultiSelector

public ParametricSelector getParametricMultiSelector(java.lang.String fieldName)

getPagingManager

public PagingManager getPagingManager(java.lang.String pageNum,
                                      int numPerPage,
                                      int numPageLinks)

getPagingManager

public PagingManager getPagingManager(java.lang.String pageNum,
                                      int numPerPage,
                                      int numPageLinks,
                                      java.lang.String pagingManagerClass)

getKTreeView

public KTreeView getKTreeView(java.lang.String fieldname)

getEnumView

public EnumView getEnumView(java.lang.String fieldname)

getCurrentTaxonomyPath

public java.lang.String getCurrentTaxonomyPath(java.lang.String taxField)

returns the current path of a taxonomy view:

getParentTaxonomyPath

public java.lang.String getParentTaxonomyPath(java.lang.String taxField)

getTreeRenderer

public TreeRenderer getTreeRenderer(KTreeView taxView,
                                    java.lang.String titleclass,
                                    java.lang.String headerclass,
                                    java.lang.String bodyclass,
                                    int cols,
                                    java.lang.String sortBy,
                                    java.lang.String sortDir,
                                    int maxchar,
                                    java.lang.String title)

getTaxonomyPieRenderer

public TaxonomyPieRenderer getTaxonomyPieRenderer(java.lang.String taxonomy,
                                                  java.lang.String titleclass,
                                                  java.lang.String headerclass,
                                                  java.lang.String bodyclass,
                                                  java.lang.String sortBy,
                                                  java.lang.String sortDir,
                                                  java.lang.String title,
                                                  boolean orderByName,
                                                  int rows,
                                                  int cols,
                                                  int maxchar)

getTaxonomyCounterRenderer

public TaxonomyCounterRenderer getTaxonomyCounterRenderer(java.lang.String taxonomy,
                                                          java.lang.String titleclass,
                                                          java.lang.String headerclass,
                                                          java.lang.String bodyclass,
                                                          java.lang.String sortBy,
                                                          java.lang.String sortDir,
                                                          java.lang.String title,
                                                          boolean orderByName,
                                                          int rows,
                                                          int cols,
                                                          int maxchar)

getRarTaxRenderer

public RarTaxRenderer getRarTaxRenderer(KTreeView taxView,
                                        java.lang.String titleclass,
                                        java.lang.String headerclass,
                                        java.lang.String bodyclass,
                                        java.lang.String query,
                                        int maxchar,
                                        java.lang.String title)

getRarTaxRenderer

public RarTaxRenderer getRarTaxRenderer(KTreeView taxView,
                                        java.lang.String titleclass,
                                        java.lang.String headerclass,
                                        java.lang.String bodyclass,
                                        java.lang.String query,
                                        int maxchar,
                                        java.lang.String title,
                                        java.lang.String useConnector)

getVParametricSearch

public VParametricSearch getVParametricSearch()

getDocumentSearcher

public ParaDocumentSearcher getDocumentSearcher()

resetQueryFields

public void resetQueryFields()

haveBrowseField

public boolean haveBrowseField(ServletRequest request)

getClearQueryOnBrowsePolicy

public boolean getClearQueryOnBrowsePolicy()

shouldClearQuery

public boolean shouldClearQuery()

getCurrentQuery

public java.lang.String getCurrentQuery()

getCurrentQueryParams

public OrderedMap getCurrentQueryParams()

getParam

public java.lang.Object getParam(java.lang.String name)

setParam

public void setParam(java.lang.String name,
                     java.lang.Object value)

getParametricSource

public ParametricSearchSource getParametricSource()