wt.query
Class LocalSearchProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.query.LocalSearchProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

Direct Known Subclasses:

ObjectSearchProcessor

public class LocalSearchProcessor

extends BasicTemplateProcessor

Presents the local search criteria in the HTML Local Search UI. Supported API: false Extendable: false

See Also:

Serialized Form

Field Summary

private static String	bgColorTable
private static String	CODEBASE
private static int	PAGE_EXPIRATION
private static String	PROCESSOR_CLASS
private static String	PROCESSOR_METHOD
private static String	RESOURCE
private static boolean	VERBOSE

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ACTION, ADD_HELP_ICON, ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, CLASS, componentFactory, CONTAINER_NAME, CONTENT_RESOURCE, contextClass, DEFAULT_CHARSET, DEFAULT_HELP_ICON_SELECTOR, DEFAULT_HELP_LABEL, DEFAULT_PREFERENCE_CONTEXT, DOCFROMTEMPLATE, ENABLE_HELP_ICON_PROPERTY_NAME, ENTERPRISE_SEARCH, EXTERNALIZATION_VERSION_UID, FEDERATION_SEARCH, GLOBAL_NAVIGATION_ENABLE_HELP_ICON, globalNavBarHelpIconEnabledDefault, HELP_CONTEXT, HELP_ICON_POSITION, HELP_ICON_SELECTOR, HELP_LABEL, HELP_LABEL_RESOURCE, HELP_WINDOW_NAME, helpContext, helpIconEnabled, helpIconEnabledDefault, HOMEPAGE, IDPREFIX, IMPORT, INTEGRATED_SEARCH, isDndMicroAppletEnabled, isDndMicroAppletEnabledInitialized, LABEL_SEPARATOR, LINE_FEED_DELIMITER, linkPrefix, LOCAL_SEARCH, OID, OLD_FORMAT_VERSION_UID, pageContext, PDMLINK_INSTALL_KEY, PERSONAL_CABINET, PREF_WINDOW_NAME, PREFERENCE_CONTEXT, PRESENT_HELP_LABEL, PROJECTLINK_INSTALL_KEY, SEARCH, SHARE_ICON, TEXT_RESOURCE_BUNDLE, URL_RESOURCE, WORKLIST, wtAttribute, WTCORE_IMAGE_DIR

Fields inherited from interface wt.templateutil.processor.ContextTranslator

CONTEXT_LIST_IN, CONTEXT_LIST_OUT

Fields inherited from interface wt.templateutil.processor.ContextHolder

CONTEXT_ACTION, CONTEXT_CLASS_NAME, CONTEXT_OBJ, CONTEXT_PROPERTIES, FORM_DATA, QUERY_DATA, RESPONSE_EXCEPTIONS, RESPONSE_FOOTERS, RESPONSE_HEADERS, RESPONSE_MESSAGES, RESPONSE_STRING, STATUS

Constructor Summary

LocalSearchProcessor()

Method Summary

private static String	createFindUserHTML(String attrib, Locale locale)
static String	displayLocalSearch(Properties parameters, Locale locale) Method for displaying the Local Search criteria HTML.
static void	displayLocalSearch(Properties parameters, Locale locale, OutputStream os)
static Vector	getAttributeValueList(PropertyDescriptor pd, Locale locale) Tries to generate a Vector of legal value strings to be used in the drop down list.
static Vector	getCabinetList() Generates a Vector of cabinet strings to be used in the drop down list.
static Vector	getDataFormatList() Generates a Vector of data format strings to be used in the drop down list.
static Vector	getLegalValueList(String method_name) Generates a Vector of legal value strings to be used in the drop down list.
static Vector	getTeamTemplateList() Generates a Vector of TeamTemplate strings to be used in the drop down list.
HTMLTemplate	getTemplate(Vector preferences) Return an initialized HTMLTemplate.
Vector	getValueList(PropertyDescriptor pd, Locale locale) Tries to generate a Vector of legal value strings to be used in the drop down list.
static Vector	getViewList() Generates a Vector of view strings to be used in the drop down list.
void	handleRequest(HTTPRequest req, HTTPResponse resp) This method handles HTTP GET requests to produce an HTML page which presents the Local Search criteria page.
void	localSearch(Properties parameters, Locale locale, OutputStream os) Presents the local search criteria.

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHiddenProperty, addHTMLHelpLink, addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, allVersions, bcwti, buildFormProcessorURL, buildFormProcessorURL, comment, createActionsBar, createFederationNavigationBar, createGlobalNavigationBar, createNavigationBar, createParentFolderLink, currentTimestamp, displayAllCabinets, displayAttributeName, displayAttributesTable, displayAttributeValue, displayFolderContents, displayFolderObject, displayFolderTrail, displayGoToLatestLink, displayOrganizationIdentifier, displayPendingChangeIndicator, displayStyleSheetAttributesTable, displayVisualData, formatDate, getActionPairs, getAllCabinetsURL, getBaselineItems, getCharsetEncoding, getCheckedOutFolderURL, getClassIcon, getClassInfo, getContextAction, getContextClass, getContextClassName, getContextListIn, getContextListOut, getContextObj, getContextProperties, getContextServiceName, getDisplayName, getDomainPath, getEnabledVersion, getEncoding, getFederationSearchURL, getFolderLocation, getFolderPath, getFormData, getGenericInstanceIconImgTag, getGlyphImageTag, getGlyphsArray, getGlyphTagsNoDnD, getHelpContext, getHomepageURL, getHTMLComponentFactory, getHTMLHelpLink, getHTMLHelpURL, getHTMLHelpURL, getHTMLTableService, getIconResource, getIconResource, getIconResource, getIconSelector, getId, getJavaScriptManager, getLocalizedDateFormatMessage, getLocalizedMessage, getLocalizedPrintWriter, getLocalizedString, getObjectDnDIcon, getObjectIcon, getObjectIconDnDTag, getObjectIconGlyphs, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectPropertyValueString, getObjectPropertyValueString, getPageContext, getParentFolderLink, getPersonalCabinet, getPersonalCabinetURL, getPreferenceValue, getPrincipalEmailLink, getPrincipalEmailLink, getPrintWriter, getPropertyFromPropertyFile, getQuery, getQueryData, getReferenceString, getReferenceString, getResourceString, getResourceString, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getSearchCriteriaURL, getSearchCriteriaURL, getSearchResultsURL, getShareImage, getShareImage, getState, getStatus, getStringFromResourceBundle, getStringFromResourceBundle, getTemplateDisplayGeneral, getTrailId, getTrlIdAttribute, getURLActions, getURLActions, getURLActions, getURLActions, getURLActionsString, getURLActionsString, getURLFactory, getURLFromDelegate, getURLProcessorLink, getURLProcessorLink, getURLProcessorLink, getURLProcessorLinkWithLabel, getUsedByLinks, getWCColor, getWCColor, getWCColorDec, getWCColorDec, getWCFontFamily, getWCFontFamily, getWorklistURL, getWTAttribute, getWTContainerByName, getWTContainerRef, handleExceptionTP, handleExceptionTP, handleProcessorException, hiddenContextString, include, initJavaScriptManager, isDndMicroAppletEnabled, isEqual, listContent, objectActionLink, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectBackground, objectIdentification, objectIdentifier, objectProperties, objectPropertyName, objectPropertyNameAux, objectPropertyNameAux2, objectPropertyValue, objectPropertyValueAux, objectPropertyValueAux2, objectPropertyValueString, outputLink, outputPropertyFromPropertyFile, parameterValue, partUsedBy, PDMLinkIsInstalled, printQueryTable, printTable, printTextArea, processSubTemplate, readContext, readExternal, readVersion, setColumnProperties, setContextAction, setContextClass, setContextClassName, setContextListIn, setContextListOut, setContextObj, setContextProperties, setFormData, setHelpContext, setHTMLTableService, setJavaScriptManager, setPageContext, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setState, setStatus, showResponseExceptions, showResponseFooters, showResponseHeaders, showResponseMessage, showResponseMessages, showVersions, sortQueryResult, splitStringIntoTokens, tableService, translateToHtml, useProcessorService, visualizationIsEnabled, writeExternal, writeHiddenContext, writeQueryStringContext

Methods inherited from class java.lang.Object

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

Field Detail

CODEBASE

private static String CODEBASE

VERBOSE

private static boolean VERBOSE

PAGE_EXPIRATION

private static int PAGE_EXPIRATION

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

PROCESSOR_CLASS

private static final String PROCESSOR_CLASS

See Also:

Constant Field Values

PROCESSOR_METHOD

private static final String PROCESSOR_METHOD

See Also:

Constant Field Values

bgColorTable

private static final String bgColorTable

Constructor Detail

LocalSearchProcessor

public LocalSearchProcessor()

Method Detail

handleRequest

public void handleRequest(HTTPRequest req,
                          HTTPResponse resp)
                   throws WTException

This method handles HTTP GET requests to produce an HTML page which presents the Local Search criteria page.

Parameters:

req - HTTPRequest

resp - HTTPResponse

Throws:

WTException

See Also:

URLProcessor

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Return an initialized HTMLTemplate.

Throws:

WTException

localSearch

public void localSearch(Properties parameters,
                        Locale locale,
                        OutputStream os)
                 throws WTException

Presents the local search criteria. Generates the html and java script required.

Throws:

WTException

displayLocalSearch

public static void displayLocalSearch(Properties parameters,
                                      Locale locale,
                                      OutputStream os)
                               throws WTException

Throws:

WTException

displayLocalSearch

public static String displayLocalSearch(Properties parameters,
                                        Locale locale)
                                 throws WTException

Method for displaying the Local Search criteria HTML. This method returns a String which contains the HTML code for building the form to display the local search criteria. This method was implemented so that the local search could easily be included into an HTML page build using JSPs.

Parameters:

parameters - the Properties object containing parameters for building the search criteria

locale - the Locale in which the search will be displayed

Throws:

WTException

getTeamTemplateList

public static Vector getTeamTemplateList()
                                  throws WTException

Generates a Vector of TeamTemplate strings to be used in the drop down list.

Throws:

WTException

getCabinetList

public static Vector getCabinetList()
                             throws WTException

Generates a Vector of cabinet strings to be used in the drop down list.

Throws:

WTException

getViewList

public static Vector getViewList()
                          throws WTException

Generates a Vector of view strings to be used in the drop down list.

Throws:

WTException

getDataFormatList

public static Vector getDataFormatList()
                                throws WTException

Generates a Vector of data format strings to be used in the drop down list.

Throws:

WTException

getLegalValueList

public static Vector getLegalValueList(String method_name)
                                throws WTException

Generates a Vector of legal value strings to be used in the drop down list. Does an invoke on the method name.

Throws:

WTException

getValueList

public Vector getValueList(PropertyDescriptor pd,
                           Locale locale)

Tries to generate a Vector of legal value strings to be used in the drop down list. Checks for attribute types that it knows how to generate lists for like boolean and extensions of EnumeratedType.

getAttributeValueList

public static Vector getAttributeValueList(PropertyDescriptor pd,
                                           Locale locale)

Tries to generate a Vector of legal value strings to be used in the drop down list. Checks for attribute types that it knows how to generate lists for like boolean and extensions of EnumeratedType.

createFindUserHTML

private static String createFindUserHTML(String attrib,
                                         Locale locale)
                                  throws WTException

Throws:

WTException