com.raritantechnologies.quickstart.taglibrary.ajax
Class SearchDispatcher

java.lang.Object
  com.raritantechnologies.quickstart.taglibrary.ajax.SearchDispatcher

Direct Known Subclasses:

SearchDispatcherProxy

public class SearchDispatcher

extends java.lang.Object

Dispatches and controls state of a Search. Initialized by AjaxDisplayForm, and monitored by AjaxServlet.

Field Summary

static int	ABORTED
static int	ALL_COMPLETED
protected IResultSet	currentResults
protected IFieldFormatter	fieldFormatter
static int	FORMATTING
static int	FORMATTING_COMPLETED
static int	FORMATTING_NEW_RESULTS
static int	FORMATTING_NO_RESULTS
protected IResultSet	intermediateResults
static int	NEW_RESULTS
static int	NO_INITIAL_RESULTS
static int	NO_NEW_RESULTS
static int	READY
static int	RESULTS_AVAILABLE
static int	SEARCH_COMPLETED
static int	SEARCHING
protected int	status

Constructor Summary

SearchDispatcher()

SearchDispatcher(java.lang.Integer queryID, java.lang.String searchSourceName, int pageSize, int startRec, UserSession userSession)

SearchDispatcher(java.lang.Integer queryID, java.lang.String sourceType, java.lang.String sourceCategory, int pageSize, int startRec, UserSession userSession)

Method Summary

protected void	addProxyDispatcher(SearchDispatcherProxy proxy)
protected void	clearResults()
java.lang.String	completeSearch(RaritanPageContext pContext)
java.lang.String	getCachedResultsName()
int	getDisplayStatus()
IFieldFormatter	getFieldFormatter()
java.lang.String	getIntermediatePageTemplate()
java.lang.String	getLoadJavascript()
int	getPageSize()
IResultSet	getResults(int atState, boolean waitForIt) returns current results.
IResultSet	getResults(int atState, boolean waitForIt, boolean updateIntermediate)
IResultSet	getResults(int startRec, int atState, boolean waitForIt)
IResultSetFilter	getResultSetFilter()
IResultSetProcessor	getResultSetProcessor()
int	getStartRec()
int	getStatus()
java.lang.String	getStatusDisplay(int status)
java.util.Map	getStatusPageRendererMap()
boolean	isFederated()
java.lang.String	renderResults(int atState, boolean waitForIt, RaritanPageContext pContext)
java.lang.String	renderResults(int atState, boolean waitForIt, RaritanPageContext pContext, boolean updateIntermediate)
void	setCachedResultsName(java.lang.String cacheResultName)
protected void	setCurrentResults(IResultSet results)
void	setDisplayFormRenderer(IDisplayFormRenderer displayFormRenderer, java.lang.String displayFormName)
void	setFieldFormatter(IFieldFormatter fieldFormatter)
protected void	setFormattedResults(IResultSet results)
void	setIntermediatePageTemplate(java.lang.String intermediatePageTemplate) sets an HTML template for intermediate result page displays.
void	setLoadJavascript(java.lang.String loadJavascript)
void	setNFormatThreads(int nFormatThreads) Sets the number of process threads devoted to formatting.
void	setPageSize(int pageSize)
void	setQueryID(java.lang.Integer queryID)
void	setResultSetFilter(IResultSetFilter resSetFilter)
void	setResultSetProcessor(IResultSetProcessor resSetProcessor)
void	setSearchSourceName(java.lang.String sourceName)
void	setSourceCategory(java.lang.String sourceCategory)
void	setSourceType(java.lang.String sourceType)
void	setStartRec(int startRec)
void	setStatusPageRendererMap(java.util.Map statusPageRendererMap) Sets a map of Integer( status level ) to PageImportRenderer SystemObject name The PageImportRenderer should create a page that interacts with the AjaxServlet to provide current status and/or a button to retrieve new data.
void	setUserSession(UserSession userSession)
void	startSearch(RaritanPageContext rpc)
void	startSearch(RaritanPageContext rpc, boolean clearResults)
void	stopSearch()

Methods inherited from class java.lang.Object

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

Field Detail

status

protected int status

ABORTED

public static final int ABORTED

See Also:

Constant Field Values

READY

public static final int READY

See Also:

Constant Field Values

SEARCHING

public static final int SEARCHING

See Also:

Constant Field Values

RESULTS_AVAILABLE

public static final int RESULTS_AVAILABLE

See Also:

Constant Field Values

SEARCH_COMPLETED

public static final int SEARCH_COMPLETED

See Also:

Constant Field Values

FORMATTING

public static final int FORMATTING

See Also:

Constant Field Values

FORMATTING_COMPLETED

public static final int FORMATTING_COMPLETED

See Also:

Constant Field Values

NO_INITIAL_RESULTS

public static final int NO_INITIAL_RESULTS

See Also:

Constant Field Values

NO_NEW_RESULTS

public static final int NO_NEW_RESULTS

See Also:

Constant Field Values

NEW_RESULTS

public static final int NEW_RESULTS

See Also:

Constant Field Values

FORMATTING_NO_RESULTS

public static final int FORMATTING_NO_RESULTS

See Also:

Constant Field Values

FORMATTING_NEW_RESULTS

public static final int FORMATTING_NEW_RESULTS

See Also:

Constant Field Values

ALL_COMPLETED

public static final int ALL_COMPLETED

See Also:

Constant Field Values

currentResults

protected IResultSet currentResults

intermediateResults

protected IResultSet intermediateResults

fieldFormatter

protected IFieldFormatter fieldFormatter

Constructor Detail

SearchDispatcher

public SearchDispatcher()

SearchDispatcher

public SearchDispatcher(java.lang.Integer queryID,
                        java.lang.String searchSourceName,
                        int pageSize,
                        int startRec,
                        UserSession userSession)

SearchDispatcher

public SearchDispatcher(java.lang.Integer queryID,
                        java.lang.String sourceType,
                        java.lang.String sourceCategory,
                        int pageSize,
                        int startRec,
                        UserSession userSession)

Method Detail

setQueryID

public void setQueryID(java.lang.Integer queryID)

setSourceType

public void setSourceType(java.lang.String sourceType)

setSourceCategory

public void setSourceCategory(java.lang.String sourceCategory)

setSearchSourceName

public void setSearchSourceName(java.lang.String sourceName)

setStartRec

public void setStartRec(int startRec)

getStartRec

public int getStartRec()

setPageSize

public void setPageSize(int pageSize)

getPageSize

public int getPageSize()

setUserSession

public void setUserSession(UserSession userSession)

setFieldFormatter

public void setFieldFormatter(IFieldFormatter fieldFormatter)

getFieldFormatter

public IFieldFormatter getFieldFormatter()

setResultSetProcessor

public void setResultSetProcessor(IResultSetProcessor resSetProcessor)

getResultSetProcessor

public IResultSetProcessor getResultSetProcessor()

addProxyDispatcher

protected void addProxyDispatcher(SearchDispatcherProxy proxy)

setNFormatThreads

public void setNFormatThreads(int nFormatThreads)

Sets the number of process threads devoted to formatting.

setDisplayFormRenderer

public void setDisplayFormRenderer(IDisplayFormRenderer displayFormRenderer,
                                   java.lang.String displayFormName)

setStatusPageRendererMap

public void setStatusPageRendererMap(java.util.Map statusPageRendererMap)

Sets a map of Integer( status level ) to PageImportRenderer SystemObject name The PageImportRenderer should create a page that interacts with the AjaxServlet to provide current status and/or a button to retrieve new data.

getStatusPageRendererMap

public java.util.Map getStatusPageRendererMap()

setIntermediatePageTemplate

public void setIntermediatePageTemplate(java.lang.String intermediatePageTemplate)

sets an HTML template for intermediate result page displays. The template should have {STATUS} and {RESULTS} sections to indicate where the current status section and search results sections should go respectively.

getIntermediatePageTemplate

public java.lang.String getIntermediatePageTemplate()

setResultSetFilter

public void setResultSetFilter(IResultSetFilter resSetFilter)

getResultSetFilter

public IResultSetFilter getResultSetFilter()

setCachedResultsName

public void setCachedResultsName(java.lang.String cacheResultName)

getCachedResultsName

public java.lang.String getCachedResultsName()

setLoadJavascript

public void setLoadJavascript(java.lang.String loadJavascript)

getLoadJavascript

public java.lang.String getLoadJavascript()

startSearch

public void startSearch(RaritanPageContext rpc)

startSearch

public void startSearch(RaritanPageContext rpc,
                        boolean clearResults)

clearResults

protected void clearResults()

stopSearch

public void stopSearch()

getStatus

public int getStatus()

getStatusDisplay

public java.lang.String getStatusDisplay(int status)

getDisplayStatus

public int getDisplayStatus()

isFederated

public boolean isFederated()

renderResults

public java.lang.String renderResults(int atState,
                                      boolean waitForIt,
                                      RaritanPageContext pContext)

renderResults

public java.lang.String renderResults(int atState,
                                      boolean waitForIt,
                                      RaritanPageContext pContext,
                                      boolean updateIntermediate)

completeSearch

public java.lang.String completeSearch(RaritanPageContext pContext)

getResults

public IResultSet getResults(int atState,
                             boolean waitForIt)

returns current results. If waitForIt is false - asynchronous mode.

getResults

public IResultSet getResults(int atState,
                             boolean waitForIt,
                             boolean updateIntermediate)

getResults

public IResultSet getResults(int startRec,
                             int atState,
                             boolean waitForIt)

setCurrentResults

protected void setCurrentResults(IResultSet results)

setFormattedResults

protected void setFormattedResults(IResultSet results)