com.ptc.windchill.cadx.search
Class DoIntegratedSearchProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      com.ptc.windchill.cadx.search.DoIntegratedSearchProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class DoIntegratedSearchProcessor

extends BasicTemplateProcessor

$$NONE Presents the local search results in the HTML Local Search UI.

Supported API: false

Extendable: false

See Also:

Serialized Form

Nested Class Summary

(package private) class

DoIntegratedSearchProcessor.DoIntegratedSearchDelegate A utility class that maintains state inbetween calls to doIntegratedSearch() from within the same instance of a DoIntegratedSearchProcessor.

Field Summary

private static String	ASCENDING
private static String	CODEBASE
private String	criteriaLink
private static String	DESCENDING
private static URL	FORM_ACTION
private static String	FORM_TAG
private String	keyword
private static String	KEYWORD
private static int	PAGE_EXPIRATION
private static String	PAGE_OFFSET
private int	pageOffset
private static String	QRESOURCE
private String	queryValue
private DoIntegratedSearchProcessor.DoIntegratedSearchDelegate	searchDelegate
private String	searchLink
private static String	SESSION_ID
private long	sessionId
private static String	SORT_PREF
private String	sortPref
private static int	THUMBNAIL_COLUMN
private static String	UNSORTED
private Hashtable	urlActionCache
private static boolean	VERBOSE
private VisualizationHelperIfc	visHelper
private static String	WFSRESOURCE

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

DoIntegratedSearchProcessor()

Method Summary

void	doCustomIntegratedSearch(OutputStream os)
void	doIntegratedSearch(Properties parameters, Locale locale, OutputStream os) Presents the local search results.
protected Vector	getActionDelegates(Class objClass, Locale locale)
String	getCustomSearchResultPage(String pageURL, IntegratedSearchTask st, QueryResult results, int pageOff, String queryValue, Locale locale)
String[]	getCustomSearchWTObjectInfo(String attr, String link, Locale locale, WTObject obj)
protected String	getGotoPageDisplay(String s, Locale locale)
protected void	getGotoPageJavascript(int page_count, int page_range, PrintWriter out, Locale locale)
protected String	getPageOfDisplay(int page_range, int total_size, int page_count, Locale locale)
HTMLTemplate	getTemplate(Vector preferences) Return an initialized HTMLTemplate.
void	handleRequest(HTTPRequest req, HTTPResponse resp) This method handles HTTP GET requests to produce an HTML page which presents the Search results page.
protected void	printRow(WTObject wtObj, int rowCount, Vector actionDelegates, boolean thumbnail, Locale locale, PrintWriter out)
private String	removeExtras(String url_text, String[] list)

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

WFSRESOURCE

private static final String WFSRESOURCE

See Also:

Constant Field Values

QRESOURCE

private static final String QRESOURCE

See Also:

Constant Field Values

FORM_TAG

private static String FORM_TAG

FORM_ACTION

private static URL FORM_ACTION

KEYWORD

private static String KEYWORD

PAGE_OFFSET

private static String PAGE_OFFSET

SESSION_ID

private static String SESSION_ID

SORT_PREF

private static String SORT_PREF

ASCENDING

private static String ASCENDING

DESCENDING

private static String DESCENDING

UNSORTED

private static String UNSORTED

THUMBNAIL_COLUMN

private static int THUMBNAIL_COLUMN

searchLink

private String searchLink

criteriaLink

private String criteriaLink

queryValue

private String queryValue

searchDelegate

private DoIntegratedSearchProcessor.DoIntegratedSearchDelegate searchDelegate

urlActionCache

private Hashtable urlActionCache

keyword

private String keyword

pageOffset

private int pageOffset

sessionId

private long sessionId

sortPref

private String sortPref

visHelper

private VisualizationHelperIfc visHelper

Constructor Detail

DoIntegratedSearchProcessor

public DoIntegratedSearchProcessor()

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 Search results page.

Supported API: false

Parameters:

req - HTTPRequest

resp - HTTPResponse

Throws:

WTException

See Also:

URLProcessor

removeExtras

private String removeExtras(String url_text,
                            String[] list)

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Return an initialized HTMLTemplate.

Supported API: false

Throws:

WTException

doIntegratedSearch

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

Presents the local search results. Does the search and presents the results.

Supported API: false

Throws:

WTException

getActionDelegates

protected Vector getActionDelegates(Class objClass,
                                    Locale locale)
                             throws WTException

Throws:

WTException

printRow

protected void printRow(WTObject wtObj,
                        int rowCount,
                        Vector actionDelegates,
                        boolean thumbnail,
                        Locale locale,
                        PrintWriter out)
                 throws WTException

Throws:

WTException

getPageOfDisplay

protected String getPageOfDisplay(int page_range,
                                  int total_size,
                                  int page_count,
                                  Locale locale)

getGotoPageJavascript

protected void getGotoPageJavascript(int page_count,
                                     int page_range,
                                     PrintWriter out,
                                     Locale locale)

getGotoPageDisplay

protected String getGotoPageDisplay(String s,
                                    Locale locale)

getCustomSearchWTObjectInfo

public String[] getCustomSearchWTObjectInfo(String attr,
                                            String link,
                                            Locale locale,
                                            WTObject obj)
                                     throws WTException

Throws:

WTException

getCustomSearchResultPage

public String getCustomSearchResultPage(String pageURL,
                                        IntegratedSearchTask st,
                                        QueryResult results,
                                        int pageOff,
                                        String queryValue,
                                        Locale locale)
                                 throws WTException

Throws:

WTException

doCustomIntegratedSearch

public void doCustomIntegratedSearch(OutputStream os)
                              throws WTException,
                                     WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException