Package com.ptc.windchill.esi.bom

Class ESIReferenceDesignatorRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.bom.ESIBOMSubordinateRenderer

com.ptc.windchill.esi.bom.ESIReferenceDesignatorRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIReferenceDesignatorRenderer
extends ESIBOMSubordinateRenderer

This class renders the output of reference designators (i.e. <ReferenceDesignator></ReferenceDesignator> ) in ESI DataResponse.

Supported API: true

Extendable: true

Field Summary

Fields inherited from class com.ptc.windchill.esi.bom.ESIBOMSubordinateRenderer

currToPrevUsageLinks, delParts, part, partUsageLinksWithSubstitutes, partUsagesToTargetAssocsMap, renderedParts, rmDelParts, root, targetAssociations

Fields inherited from class com.ptc.windchill.esi.rnd.BasicESIRenderer

adapterName, authentication, currentTarget, DELIMITER, objectTypeDefs, OPTIONSVARIANTS_HELPER_CLASS_STRING, SEPARATOR, taskHelper, XML_META_NAME

Method Summary

Modifier and Type	Method	Description
protected com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element elem, String group, PartUsageInfo pui, UsesOccurrence rd, Collection targets)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element elem, String group, WTPartUsageLink usageLink, UsesOccurrence rd, Collection targets)	Allows subclasses to fix the contents of the input Element before it is added to the output group(s).
protected void	buildGroups()	Produces the renderer's output.
protected void	mapUoDataAtts(com.infoengine.object.factory.Element inputElem, Collection<com.infoengine.object.factory.Element> uoDataElements, Map<String,String> attsWithNoVal)	Sets the valueless Atts in the input Element, using the Elements in the input collection and the attribute names in the input Map.
void	setData(WTPart root, WTPart part, Collection<PartUsageInfo>[] deltaParts, Collection<ESITargetAssociation> orgs, boolean lineNumbers, String authentication, String adapterName)	Initialize the renderer instance with all required data to render Reference Designator object.
void	setData(WTPart rootPart, WTPart part, Map<WTPartUsageLink,WTPart>[] colArray, Collection<ESITargetAssociation> targets, boolean lineNumbers, String authentication, String adapterName, Map<WTPartUsageLink,Collection<ESIQueryTargetAssociation>> queryTargetAssociations)	Initialize the renderer instance with all required data to render Reference Designator object.

Methods inherited from class com.ptc.windchill.esi.bom.ESIBOMSubordinateRenderer

addRenderedPart, addRenderedPart, addRenderedPart, addRenderedPart, addRenderedParts, areComponentQuantitiesRequired, areLineNumbersEnforced, getAigManager, getCaller, getCurrToPrevUsageLinks, getDelParts, getDeltaParts, getPart, getPartUsageLinksWithSubstitutes, getRenderedParts, getRenderedParts, getRmDelParts, getRoot, getTargetAssociations, getTargetAssocsForPartUsageLink, isDefaultFilter, isLineNumberEnabled, setData, setData, setData, setData, setData, setPartUsageLinksWithSubstitutes, setPartUsagesToTargetAssocsMap, setRoot, shouldConsolidateComponentQuantity, validate

Methods inherited from class com.ptc.windchill.esi.rnd.BasicESIRenderer

addAtt, adjustConfigurableAndCollapsibleAtts, adjustDateEffCxt, adjustDateEffectivities, adjustEffectivities, adjustLotNumberEffCxt, adjustLotNumberEffectivities, adjustObjectID, adjustSerialNumberEffCxt, adjustSerialNumberEffectivities, adjustTargets, buildUfidString, evaluateBussinessRule, fetchLatestEffectivities, formatDateEffectivityElement, getAdapterName, getAssignedVariantSpec, getAssignedVariantSpec, getAUMRenderer, getAuth, getBuilder, getEffectivityElementMap, getEffectivityHandler, getEffectivityTargetAttributes, getElements, getERPMaterialAttributeList, getERPMaterialAttributeList, getERPMaterialTargetAttributes, getFormatedDate, getGroupInfo, getGroupInfo, getGroupInfo, getMap, getMap, getMapInfo, getMapInfo, getMapInfo, getNavigationFilter, getObjectTypeDefs, getPlantSpecificAttributeList, getPlantSpecificAttributeList, getPlantSpecificTargetAttributes, getPreviousObject, getPreviousPublishedEffectivity, getTargetsFromAssns, getTargetUtility, getTransactionUtility, getUnwantedAttributes, getVersionRefObjectRefMap, getWCAttributeList, getWCAttributeList, initEffectivityHandler, initializeElementForGroup, invokeQueryTask, invokeQueryTask, invokeQueryTask, invokeQueryTaskForObjects, isExpressionToBePublished, isGroupAvailable, isPublishAssocOptionSetFlagEnabled, mapDateEffectivities, mapEffectivities, mapEffectivityAttributes, mapEffectivityElement, mapEffectivityParentElement, mapElement, mapElement, mapElement, mapElementWithEffectivityAttrs, mapLotNumberEffectivities, mapObject, mapObject, mapSerialNumberEffectivities, mergeElements, overrideAttrValue, populateDateEffectivityInfo, populateEffectivityInfo, processBussinessRulesWithAnd, processBussinessRuleValidationResultSet, processNoMatchingVersionFound, removeAttributesNotRequired, removeUnwantedEffectivityAttributes, render, renderAssociatedSkinnyVariantSpec, renderAssociatedVariantSpec, renderAssocOptionSetLinks, renderAssocSkinnyVariantSpec, renderAssocVariantSpec, renderATONavigationFilter, renderChoiceRules, renderEffectivities, renderEffectivities, renderExpressions, renderOptionSets, renderRoleBObjectOfModuleVariantLink, setAttrValue, setAttrValue, setAttrValues, setBuilder, setCurrentTarget, setCurrentTarget, setCurrentTargetFromTgtAssocs, setEffectivityHandler, setObjectTypeDefs, setObjectTypeDefs, setObjectTypeDefsFromObj, setStartEndEffAttr, setTransactionUtility, shallPublishAssocOptionSet, shouldRenderEffectivityElementInPartElement, shouldUseOldEffectivityBehaviour, storeCurrentAndItsPreviousObject, storeCurrentAndItsPreviousObject

Methods inherited from class java.lang.Object

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

Method Details

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Produces the renderer's output. Obtains an array of Maps of delta parts from the base class. Processes each Map. For each entry in the Map:

1. Obtains the reference designator additions and reference designator deletions.
2. Queries the database for their attributes (including those on UsesOccurrenceData).
3. Maps the output.
4. Calls adjustObjectID().
5. Calls adjustTargets().
6. Calls adjustElement().
7. Calls addRenderedPart().

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

setData

public void setData(WTPart root,
 WTPart part,
 Collection<PartUsageInfo>[] deltaParts,
 Collection<ESITargetAssociation> orgs,
 boolean lineNumbers,
 String authentication,
 String adapterName)
             throws ESIRendererException

Initialize the renderer instance with all required data to render Reference Designator object.

Supported API: true

Parameters:

root - WTPart instance that represents the top level assembly.

part - WTPart instance that represents the assembly for which to process the components, substitutes or reference designators as appropriate.

deltaParts - Array of elements, each of which is a collection of PartUsageInfo instances; each such instance represents either an added, deleted, changed or an unchanged component in the BOM being processed.

orgs - Collection of ESITargetAssociations for the BOM header for which to process components, substitutes or reference designators as appropriate.

lineNumbers - Specifies whether or not line numbers associated with components are to be processed.

authentication - This parameter contains authentication information required for executing certain Windchill adapter webjects as part of the rendering process.

adaptername - This parameter contains Windchill adapter information required as part of the rendering process.

Throws:

ESIRendererException

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String group,
 PartUsageInfo pui,
 UsesOccurrence rd,
 Collection targets)
                                                       throws ESIRendererException

Allow subclasses to fix the contents of an element before it's added to the output group(s). Default behavior is to return the argument.

Supported API: true

Parameters:

elem -

group -

pui -

rd -

targets - Collection of ESITarget objects.

Returns:

Element

Throws:

ESIRendererException

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String group,
 WTPartUsageLink usageLink,
 UsesOccurrence rd,
 Collection targets)
                                                       throws ESIRendererException

Allows subclasses to fix the contents of the input Element before it is added to the output group(s). Default behavior is to return the input Element itself.

Supported API: true

Parameters:

elem - - Input Info*Engine Element to be updated.

group - - Logical name of the group to which the Element will be added (e.g., "AddedReferenceDesignators").

usageLink - - Part usage link referenced by the part uses occurrence being processed.

rd - - Part uses occurrence being processed.

targets - - Collection of ESITarget objects.

Returns:

Element - Updated Element.

Throws:

ESIRendererException

mapUoDataAtts

protected void mapUoDataAtts(com.infoengine.object.factory.Element inputElem,
 Collection<com.infoengine.object.factory.Element> uoDataElements,
 Map<String,String> attsWithNoVal)

Sets the valueless Atts in the input Element, using the Elements in the input collection and the attribute names in the input Map. See the parameter descriptions for more information.

Supported API: true

Parameters:

inputElem - Input Element whose valueless Atts are to be set.

uoDataElements - Input collection of Elements each representing a UsesOccurrenceData object; the method sets the valueluess Atts in the input Element using the values of Atts in these Elements.

attsWithNoVal - A Map where each key is the source attribute name (viz., the name of the UsesOccurrenceData attribute) and each value is the target attribute name (viz., the Att name in the input Element; this is also the name that is sent with the ESI response).

setData

public void setData(WTPart rootPart,
 WTPart part,
 Map<WTPartUsageLink,WTPart>[] colArray,
 Collection<ESITargetAssociation> targets,
 boolean lineNumbers,
 String authentication,
 String adapterName,
 Map<WTPartUsageLink,Collection<ESIQueryTargetAssociation>> queryTargetAssociations)

Initialize the renderer instance with all required data to render Reference Designator object.

Supported API: true

Parameters:

rootPart - WTPart instance that represents the top level assembly.

part - WTPart instance that represents the assembly for which to process the components, substitutes or reference designators as appropriate.

colArray - Array of elements, each of which is a collection of PartUsageInfo instances; each such instance represents either an added, deleted, changed or an unchanged component in the BOM being processed.

targets - Collection of ESITargetAssociations for the BOM header for which to process components, substitutes or reference designators as appropriate.

lineNumbers - Specifies whether or not line numbers associated with components are to be processed.

authentication - This parameter contains authentication information required for executing certain Windchill adapter webjects as part of the rendering process.

queryTargetAssociations - Map of PartUsageInfo and collection of Query target association

adaptername - This parameter contains Windchill adapter information required as part of the rendering process.

Throws:

ESIRendererException