com.ptc.windchill.cadx.caddoc
Class EPMWhereUsedProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          com.ptc.core.HTMLtemplateutil.server.processors.ExpandCollapseSectionProcessor
              com.ptc.windchill.cadx.common.treetable.AbstractTreeTableStructureNavigateProcessor
                  com.ptc.windchill.cadx.caddoc.EPMWhereUsedProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor, TreeTableStructureNavigate

public class EPMWhereUsedProcessor

extends AbstractTreeTableStructureNavigateProcessor

This provides behavior for user to navigate (expand & collapse) the product structure of a document to find out all the usedBy objects for the specified object.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static Class[]	nodeObjectValidDataTypes
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class com.ptc.windchill.cadx.common.treetable.AbstractTreeTableStructureNavigateProcessor

ID_SEPARATOR, treeTableCookie

Fields inherited from class com.ptc.core.HTMLtemplateutil.server.processors.ExpandCollapseSectionProcessor

AUX_ACTION, AUX_ICON_FILE, IMAGE_DIR

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, CODEBASE, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR

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

EPMWhereUsedProcessor()

Method Summary

Enumeration	getAssociatedObjects(Persistable persistable) For the specified object get the associated objects required for the tree table Supported API: false
Comparator	getComparator(Locale locale) For the specified locale, get the Comparator object.
String	getCookieName() Get the cookie name for the cookie for this class.
Class[]	getNodeObjectValidDataTypes() Get the valid data types of the other (than root) tree table node objects.
Class	getRootObjectValidDataType() Get the data type of the root node of the tree table.
private Enumeration	getUsedByDocs(EPMDocument doc)
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(EPMWhereUsedProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class com.ptc.windchill.cadx.common.treetable.AbstractTreeTableStructureNavigateProcessor

createHTMLTable, createTreeTableModel, expand, expand, getConfigSpec, getCookie, getNewCookie, getNode, getNodeIndex, getNodeIndex, getRootDocMaster, getRootObjectToNavigate, getRowDataObjects, getTreeModel, initializeTreeTable, isNodeObjectDataTypeValid, isRootObjectDataTypeValid, isValidRootObject, prepareForFreshDisplay, readVersion, saveCookies, sort

Methods inherited from class com.ptc.core.HTMLtemplateutil.server.processors.ExpandCollapseSectionProcessor

createShareStatusTable, getAuxAction, getBody, getFooter, getHeaderHelp, getHeaderTutorial, getNorgieAltText, getNorgieIcon, getNorgieLink, getNorgieTrailId, getTitle, initializeSection, isExpanded, readVersion

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

nodeObjectValidDataTypes

public static final Class[] nodeObjectValidDataTypes

Constructor Detail

EPMWhereUsedProcessor

public EPMWhereUsedProcessor()

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 AbstractTreeTableStructureNavigateProcessor

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 AbstractTreeTableStructureNavigateProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

getAssociatedObjects

public Enumeration getAssociatedObjects(Persistable persistable)
                                 throws WTException,
                                        WTPropertyVetoException

For the specified object get the associated objects required for the tree table

Supported API: false

Specified by:

getAssociatedObjects in interface TreeTableStructureNavigate

Specified by:

getAssociatedObjects in class AbstractTreeTableStructureNavigateProcessor

Parameters:

persistable -

Returns:

Enumeration

Throws:

WTException

WTPropertyVetoException

getCookieName

public String getCookieName()

Get the cookie name for the cookie for this class. This cookie contains the session state of the row data objects, table model, row identifier etc.

Supported API: false

Specified by:

getCookieName in interface TreeTableStructureNavigate

Specified by:

getCookieName in class AbstractTreeTableStructureNavigateProcessor

Returns:

String

getRootObjectValidDataType

public Class getRootObjectValidDataType()

Get the data type of the root node of the tree table. For example if the root object is EPMDocument, the returned data type would be wt.epm.EPMDocument.class object.

Supported API: false

Specified by:

getRootObjectValidDataType in interface TreeTableStructureNavigate

Specified by:

getRootObjectValidDataType in class AbstractTreeTableStructureNavigateProcessor

Returns:

Class

getNodeObjectValidDataTypes

public Class[] getNodeObjectValidDataTypes()

Get the valid data types of the other (than root) tree table node objects. These represent the nodes of the tree. For example if the node objects are EPMDocument, the returned data type would be an array of wt.epm.EPMDocument.class object with only one array element.

Supported API: false

Specified by:

getNodeObjectValidDataTypes in interface TreeTableStructureNavigate

Specified by:

getNodeObjectValidDataTypes in class AbstractTreeTableStructureNavigateProcessor

Returns:

Class[]

getComparator

public Comparator getComparator(Locale locale)

For the specified locale, get the Comparator object. This object is later used for sorting of the tree table rows.

Supported API: false

Specified by:

getComparator in interface TreeTableStructureNavigate

Specified by:

getComparator in class AbstractTreeTableStructureNavigateProcessor

Parameters:

locale -

Returns:

Comparator

getUsedByDocs

private Enumeration getUsedByDocs(EPMDocument doc)
                           throws WTException,
                                  WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException