wt.part
Class MultilevelWhereUsedProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.part.MultilevelWhereUsedProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class MultilevelWhereUsedProcessor

extends DefaultTemplateProcessor

implements Externalizable

This template processor produces the HTML representation of the Multilevel Where Used report when an HTML template calls the WindchillScript method getXmlUsingXsl, causing the template processor to call getMultilevelWhereUsed. Customization should be done using the XSL template and the MultilevelWhereUsedVisitor, not the HTML template.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String	BASELINE_NAME_LABEL
static String	CDATA
private static String	CLASSNAME
static String	CONFIG_SPEC
static String	CONFIGURATION
static String	CONFIGURATION_ITEM_LABEL
static String	DISPLAY_NAME
static String	EFFECTIVE_DATE_LABEL
static String	EFFECTIVITY_TYPE_LABEL
static String	ENTERPRISE_RESOURCE
static long	EXTERNALIZATION_VERSION_UID
static String	INCLUDE_LABEL
static String	INCORPORATION_DATE_LABEL
static String	IS_PLANNING_DATE_LABEL
static String	LEVEL_HEADER
static String	MULTI_WHERE_USED
static String	MULTI_WHERE_USED_REPORT
protected static long	OLD_FORMAT_VERSION_UID
static String	PART
static String	PART_PROPERTIES_LINK_FRAGMENT
static String	PART_TITLE
static String	PRODUCT_INSTANCE
static String	PRODUCT_STRUCTURE_HEADER
static String	QUANTITY_HEADER
static String	REPORT_TITLE
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SPEC_TITLE
static String	STATE_LABEL
static String	UNIT_LABEL
static String	URL_TEMPLATE_ACTION
static String	VERSION_HEADER
static String	VERSION_NOT_SPECIFIED
static String	VIEW_LABEL
static String	WTPART
static String	XSL_PROPERTY_NAME

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, CODEBASE, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR, OID, VERBOSE

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

MultilevelWhereUsedProcessor()

Method Summary

ConfigSpec	getConfigSpec()
ConfigSpec	getConfigSpec(String encodedConfigSpec)
protected ServletSessionCookie	getCookie(String cookieName)
private String	getData(String key)
private WTPart	getPart()
private WTPart	getPart(String oidValue)
private WTProductConfiguration	getProductConfiguration()
private WTProductConfiguration	getProductConfiguration(String oidValue)
private WTProductInstance2	getProductInstance()
private WTProductInstance2	getProductInstance(String oidValue)
private String	getProperty(String name, Locale locale)
String	getXML(WTPart part, ConfigSpec spec, Locale locale)
void	getXmlUsingXsl(Properties parameters, Locale locale, OutputStream os)
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(MultilevelWhereUsedProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
static void	setMultiWhereUsedName(String newName)
static void	setXSLStylesheetName(String newName)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

addHiddenProperty, addToFeedbackCookie, addToFeedbackCookie, getContextPropertyValue, getCurrentUrl, getFeedbackCookieExceptions, getFeedbackCookieMessages, getHtmlTemplateFactory, getMessageSeparator, getPAGE_EXPIRATION, getPageExpirationResource, getTemplate, getTemplateDisplay, handleRequest, 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, getWTContainerRef, 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

PART

public static final String PART

See Also:

Constant Field Values

CONFIGURATION

public static final String CONFIGURATION

See Also:

Constant Field Values

BASELINE_NAME_LABEL

public static final String BASELINE_NAME_LABEL

See Also:

Constant Field Values

CDATA

public static final String CDATA

See Also:

Constant Field Values

CONFIG_SPEC

public static final String CONFIG_SPEC

See Also:

Constant Field Values

CONFIGURATION_ITEM_LABEL

public static final String CONFIGURATION_ITEM_LABEL

See Also:

Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

Constant Field Values

EFFECTIVE_DATE_LABEL

public static final String EFFECTIVE_DATE_LABEL

See Also:

Constant Field Values

EFFECTIVITY_TYPE_LABEL

public static final String EFFECTIVITY_TYPE_LABEL

See Also:

Constant Field Values

INCLUDE_LABEL

public static final String INCLUDE_LABEL

See Also:

Constant Field Values

INCORPORATION_DATE_LABEL

public static final String INCORPORATION_DATE_LABEL

See Also:

Constant Field Values

IS_PLANNING_DATE_LABEL

public static final String IS_PLANNING_DATE_LABEL

See Also:

Constant Field Values

LEVEL_HEADER

public static final String LEVEL_HEADER

See Also:

Constant Field Values

MULTI_WHERE_USED_REPORT

public static final String MULTI_WHERE_USED_REPORT

See Also:

Constant Field Values

PART_PROPERTIES_LINK_FRAGMENT

public static final String PART_PROPERTIES_LINK_FRAGMENT

See Also:

Constant Field Values

PART_TITLE

public static final String PART_TITLE

See Also:

Constant Field Values

PRODUCT_STRUCTURE_HEADER

public static final String PRODUCT_STRUCTURE_HEADER

See Also:

Constant Field Values

PRODUCT_INSTANCE

public static final String PRODUCT_INSTANCE

See Also:

Constant Field Values

QUANTITY_HEADER

public static final String QUANTITY_HEADER

See Also:

Constant Field Values

REPORT_TITLE

public static final String REPORT_TITLE

See Also:

Constant Field Values

SPEC_TITLE

public static final String SPEC_TITLE

See Also:

Constant Field Values

STATE_LABEL

public static final String STATE_LABEL

See Also:

Constant Field Values

URL_TEMPLATE_ACTION

public static final String URL_TEMPLATE_ACTION

See Also:

Constant Field Values

UNIT_LABEL

public static final String UNIT_LABEL

See Also:

Constant Field Values

VERSION_HEADER

public static final String VERSION_HEADER

See Also:

Constant Field Values

VERSION_NOT_SPECIFIED

public static final String VERSION_NOT_SPECIFIED

See Also:

Constant Field Values

VIEW_LABEL

public static final String VIEW_LABEL

See Also:

Constant Field Values

WTPART

public static final String WTPART

See Also:

Constant Field Values

MULTI_WHERE_USED

public static String MULTI_WHERE_USED

XSL_PROPERTY_NAME

public static String XSL_PROPERTY_NAME

ENTERPRISE_RESOURCE

public static final String ENTERPRISE_RESOURCE

See Also:

Constant Field Values

Constructor Detail

MultilevelWhereUsedProcessor

public MultilevelWhereUsedProcessor()

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 DefaultTemplateProcessor

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 DefaultTemplateProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(MultilevelWhereUsedProcessor 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

getData

private String getData(String key)

getConfigSpec

public ConfigSpec getConfigSpec()
                         throws WTException

Throws:

WTException

getConfigSpec

public ConfigSpec getConfigSpec(String encodedConfigSpec)
                         throws WTException

Throws:

WTException

getPart

private WTPart getPart()
                throws WTException

Throws:

WTException

getPart

private WTPart getPart(String oidValue)
                throws WTException

Throws:

WTException

getProductConfiguration

private WTProductConfiguration getProductConfiguration()
                                                throws WTException

Throws:

WTException

getProductConfiguration

private WTProductConfiguration getProductConfiguration(String oidValue)
                                                throws WTException

Throws:

WTException

getProductInstance

private WTProductInstance2 getProductInstance()
                                       throws WTException

Throws:

WTException

getProductInstance

private WTProductInstance2 getProductInstance(String oidValue)
                                       throws WTException

Throws:

WTException

getXML

public String getXML(WTPart part,
                     ConfigSpec spec,
                     Locale locale)
              throws WTException

Throws:

WTException

getXmlUsingXsl

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

Throws:

WTException

getProperty

private String getProperty(String name,
                           Locale locale)
                    throws WTException

Throws:

WTException

setXSLStylesheetName

public static void setXSLStylesheetName(String newName)

setMultiWhereUsedName

public static void setMultiWhereUsedName(String newName)

getCookie

protected ServletSessionCookie getCookie(String cookieName)