wt.part
Class PartLocalSearchProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.part.PartLocalSearchProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

Direct Known Subclasses:

AlternatesLocalSearchProcessor, SubstitutesLocalSearchProcessor

public class PartLocalSearchProcessor

extends GenerateFormProcessor

Processor used for the PartLocalSearch html template and for various customized search results templates.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private Hashtable	criteria
static String	CRITERIA_PREFIX
static long	EXTERNALIZATION_VERSION_UID
private String[]	hiddenFields
protected int	nResults
protected static long	OLD_FORMAT_VERSION_UID
private String[]	otherFields
private String[]	passThruFieldPrefixes
private static String	query
private static String	RESOURCE
protected SortedEnumeration	results
(package private) static long	serialVersionUID
private static boolean	VERBOSE

Fields inherited from class wt.templateutil.processor.GenerateFormProcessor

DEFAULT_LIFECYCLE, ON_CHANGE_EVENT_NAME, TEAMTEMPLATE_INPUT_NAME

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, CODEBASE, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR, OID

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ADD_HELP_ICON, ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, 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, 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, linkPrefix, LOCAL_SEARCH, 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

PartLocalSearchProcessor()

Method Summary

private void	displayAttrLabelPDMLink(String attrib, PropertyDescriptor pd, Locale locale, Class class_name, PrintWriter out) Generates the label for one search attribute
private void	displayAttrLabelWC(String attrib, PropertyDescriptor pd, Locale locale, Class class_name, PrintWriter out) Generates the label for one search attribute
void	doObjectSearch(Properties parameters, Locale locale, OutputStream os) doObjectSearch method Performs a local search for WTParts meeting user's criteria
void	generateModifyCriteriaButton(Properties parameters, Locale locale, OutputStream os) Generates the Modify Search Criteria button for the Alternates Local Search Results html form
void	generatePartSearchForm(Properties parameters, Locale locale, OutputStream os) Builds and launches the Part Local Search html form
void	generateResultsFormTag(Properties parameters, Locale locale, OutputStream os) Generates the form tag for the Local Search Results html form
void	generateResultsSummary(Properties parameters, Locale locale, OutputStream os) Displays the search results summary line: "Your search ...
void	generateSearchFormTag(Properties parameters, Locale locale, OutputStream os) Generates the form tag for the Part Local Search html form
protected String[]	getHiddenFields()
Vector	getLegalValueList(String method_name) Generates a Vector of legal value strings to be used in the drop down list.
protected String[]	getOtherFields()
protected String[]	getPassThruFieldPrefixes()
Vector	getValueList(PropertyDescriptor pd, Locale locale) Tries to generate a Vector of legal value strings to be used in the drop down list.
protected boolean	hiddenField(String name)
protected boolean	notOtherFields(String name)
protected boolean	passThruData(String name)
private boolean	queryValidate(String a_Query, Vector OK_class_list)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(PartLocalSearchProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	showObjectSearch(Properties parameters, Locale locale, OutputStream os) Displays the search results in tabular form and writes out any form data passed to this form into hidden fields on this form
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class wt.templateutil.processor.GenerateFormProcessor

addHiddenProperties, changedContextualValue, contextualValue, contextualValueEncoded, currentFolderId, currentFolderPath, enumeratedTypeMenu, enumeratedTypeMenuForClass, generateAction, generatePostURL, generateUpdatePostURL, getButtonText, getContentHolder, getContextualValue, getDefaultPath, getDelim, getDnDAppletTags, getEnumeratedTypeMenu, getFormat, getFormValueFromSession, getFormValueFromSession, getFormValueFromSessionWithEnumeratedPropertyDefault, getFormValueFromSessionWithPropertyDefault, getLastUpdated, getMessageURL, getObjectIdentity, getPreferenceValue, getPrimary, getPrimary, getPrimaryAttribute, getPrimaryChecksum, getPrimaryChecksum, getPrimaryDownloadURL, getPrimaryDownloadURL, getPrimaryFileName, getPrimaryFileName, getPrimaryOidString, getPrimaryOidString, getPrimaryUploadedFromPath, getPrimaryUploadedFromPath, getPrimaryUploadURL, getPrimaryUploadURL, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getSize, getTargetType, getURLTabLink, getWTContainerRef, handleRequest, holderUploadTable, listLifeCycles, listTeamTemplates, obtainFromCovertProperty, parentFolderPath, readVersion, selectFolderMenu, selectFolderMenuForContainers, setContentHolder

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

addHiddenProperty, addToFeedbackCookie, addToFeedbackCookie, getContextPropertyValue, getCurrentUrl, getFeedbackCookieExceptions, getFeedbackCookieMessages, getHtmlTemplateFactory, getMessageSeparator, getPAGE_EXPIRATION, getPageExpirationResource, getTemplate, getTemplateDisplay, hiddenContextString, readVersion, setContextPropertyValue, setHtmlTemplateFactory, setMethodContextProperty, setNameProcessor, setPAGE_EXPIRATION, setPageExpirationResource, writeHiddenContext, writeQueryStringContext

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, 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, handleExceptionTP, handleExceptionTP, handleProcessorException, 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, 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

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

results

protected SortedEnumeration results

nResults

protected int nResults

hiddenFields

private String[] hiddenFields

otherFields

private String[] otherFields

passThruFieldPrefixes

private String[] passThruFieldPrefixes

criteria

private Hashtable criteria

query

private static String query

CRITERIA_PREFIX

public static final String CRITERIA_PREFIX

See Also:

Constant Field Values

VERBOSE

private static boolean VERBOSE

Constructor Detail

PartLocalSearchProcessor

public PartLocalSearchProcessor()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class GenerateFormProcessor

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class GenerateFormProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(PartLocalSearchProcessor thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

generateSearchFormTag

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

Generates the form tag for the Part Local Search html form

Throws:

WTException

generatePartSearchForm

public void generatePartSearchForm(Properties parameters,
                                   Locale locale,
                                   OutputStream os)
                            throws WTIntrospectionException,
                                   WTException,
                                   WTPropertyVetoException

Builds and launches the Part Local Search html form

Throws:

WTIntrospectionException

WTException

WTPropertyVetoException

displayAttrLabelWC

private void displayAttrLabelWC(String attrib,
                                PropertyDescriptor pd,
                                Locale locale,
                                Class class_name,
                                PrintWriter out)

Generates the label for one search attribute

displayAttrLabelPDMLink

private void displayAttrLabelPDMLink(String attrib,
                                     PropertyDescriptor pd,
                                     Locale locale,
                                     Class class_name,
                                     PrintWriter out)

Generates the label for one search attribute

generateResultsFormTag

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

Generates the form tag for the Local Search Results html form

Throws:

WTException

doObjectSearch

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

doObjectSearch method Performs a local search for WTParts meeting user's criteria

Throws:

WTException

WTPropertyVetoException

generateResultsSummary

public void generateResultsSummary(Properties parameters,
                                   Locale locale,
                                   OutputStream os)
                            throws WTIntrospectionException

Displays the search results summary line: "Your search ... found ... objects"

Throws:

WTIntrospectionException

generateModifyCriteriaButton

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

Generates the Modify Search Criteria button for the Alternates Local Search Results html form

Throws:

WTException

showObjectSearch

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

Displays the search results in tabular form and writes out any form data passed to this form into hidden fields on this form

Throws:

WTException

WTPropertyVetoException

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.

getLegalValueList

public 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

getOtherFields

protected String[] getOtherFields()

notOtherFields

protected boolean notOtherFields(String name)

getHiddenFields

protected String[] getHiddenFields()

hiddenField

protected boolean hiddenField(String name)

getPassThruFieldPrefixes

protected String[] getPassThruFieldPrefixes()

passThruData

protected boolean passThruData(String name)

queryValidate

private boolean queryValidate(String a_Query,
                              Vector OK_class_list)
                       throws WTPropertyVetoException

Throws:

WTPropertyVetoException