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, Serializable

public class ESIReferenceDesignatorRenderer

extends ESIBOMSubordinateRenderer

implements Serializable

This class renders the output of reference designators (ie. ) in ESI DataResponse.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

protected static String	ADDED_GROUP
private static String	CLASSNAME
protected static String	DELETED_GROUP
protected static String	ESIRESOURCE
protected static String	NULL_STRING
private static String	RESOURCE
private TaskHelper	taskHelper

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

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

adapterName, PART_CLASS_NAME, TASK_URI, XML_META_NAME

Constructor Summary

ESIReferenceDesignatorRenderer()

Method Summary

private void	addElements(String groupName, PartUsageInfo pui, Enumeration rds)
protected Element	adjustElement(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 void	buildGroups() Produces the renderer's output.
protected TaskHelper	getTaskHelper()
private Element	mapPartUsageInfo(String groupName, PartUsageInfo pui, UsesOccurrence rd, Collection targets)

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

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

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

adjustEffectivities, adjustObjectID, adjustTargets, buildUfidString, getAdapterName, getAttsFromMapFile, getBuilder, getEffectivityHandler, getGroupInfo, getMap, getMapInfo, getTargetsFromAssns, getWCAttributeList, invokeQueryTask, invokeQueryTask, invokeQueryTask, mapElement, mapObject, render, setBuilder, setEffectivityHandler

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

NULL_STRING

protected static final String NULL_STRING

See Also:

Constant Field Values

DELETED_GROUP

protected static final String DELETED_GROUP

See Also:

Constant Field Values

ADDED_GROUP

protected static final String ADDED_GROUP

See Also:

Constant Field Values

ESIRESOURCE

protected static final String ESIRESOURCE

See Also:

Constant Field Values

taskHelper

private TaskHelper taskHelper

Constructor Detail

ESIReferenceDesignatorRenderer

public ESIReferenceDesignatorRenderer()

Method Detail

buildGroups

protected void buildGroups()
                    throws 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 reference designator additions and reference designator deletions.
2. Maps the output.
3. Calls adjustObjectID().
4. Calls adjustTargets()
5. Calls adjustElement()
6. Calls addRenderedPart()

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

adjustElement

protected Element adjustElement(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

addElements

private void addElements(String groupName,
                         PartUsageInfo pui,
                         Enumeration rds)
                  throws ESIRendererException

Throws:

ESIRendererException

mapPartUsageInfo

private Element mapPartUsageInfo(String groupName,
                                 PartUsageInfo pui,
                                 UsesOccurrence rd,
                                 Collection targets)
                          throws ESIRendererException

Throws:

ESIRendererException

getTaskHelper

protected TaskHelper getTaskHelper()