com.ptc.windchill.esi.bom
Class SubstituteRendererImpl

java.lang.Object
  com.ptc.windchill.esi.rnd.ResponseRendererImpl
      com.ptc.windchill.esi.bom.ESIWTPartRenderer
          com.ptc.windchill.esi.bom.SubstituteRendererImpl

All Implemented Interfaces:

BOMPartRenderer, SubstituteRenderer, ResponseRenderer, Serializable

public class SubstituteRendererImpl
extends ESIWTPartRenderer
implements SubstituteRenderer, Serializable

Default implementation of SubstituteRenderer.

Supported API: true

Extendable: true

See Also:

Serialized Form

Method Summary

protected com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element elem, String group, PartUsageInfo pui, WTPartMaster sub, Collection targets) Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected void	buildGroups() Produces the renderer's output.
protected void	validate() Calls base class validate().

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

addRenderedPart, addRenderedPart, areComponentQuantitiesRequired, areLineNumbersEnforced, getDeltaParts, getPart, getRenderedParts, getRoot, getTargets, isLineNumberEnabled

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

adjustEffectivities, adjustObjectID, adjustTargets, buildUfidString, getBuilder, invokeQueryTask, mapElement, mapObject, render, setBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ptc.windchill.esi.bom.BOMPartRenderer

setData

Methods inherited from interface com.ptc.windchill.esi.rnd.ResponseRenderer

render

Method Detail

validate

protected void validate()
                 throws com.ptc.windchill.esi.rnd.ESIRendererException

Calls base class validate().

Supported API: true

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException

buildGroups

protected void buildGroups()
                    throws com.ptc.windchill.esi.rnd.ESIRendererException

Produces the renderer's output. Obtains the deltaParts array of Collections from the base class. Iterates each Collection in turn. For each entry in the iterations:

1. Obtains the substitute additions and substitute deletions.
2. Maps the output.
3. If alternate item groups are required, obtains the appropriate alternate item group from the alternate item group manager.
4. Calls adjustObjectID().
5. Calls adjustTargets()
6. Calls adjustElement()
7. Calls addRenderedPart()

Supported API: true

Specified by:

buildGroups in class ResponseRendererImpl

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
                                                              String group,
                                                              PartUsageInfo pui,
                                                              WTPartMaster sub,
                                                              Collection targets)
                                                       throws com.ptc.windchill.esi.rnd.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 -

sub -

targets - Collection of ESITarget objects.

Returns:

Element

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException