Package com.ptc.windchill.esi.navigationcriteria

Class ESINavigationFilterRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.rnd.NavigationCriteriaAssociatedObjectRenderer

com.ptc.windchill.esi.navigationcriteria.ESINavigationFilterRenderer

All Implemented Interfaces:

ESIRenderer

public class ESINavigationFilterRenderer
extends NavigationCriteriaAssociatedObjectRenderer

Supported API: true

Extendable: true

Field Summary

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

atoNavigationFilter, comparisonOperatorIdToDisplayMap, deletedNavigationCriterias, EQUAL_DISPLAY, EQUAL_ID, GREATER_THAN_DISPLAY, GREATER_THAN_ID, GREATER_THAN_OR_EQUAL_DISPLAY, GREATER_THAN_OR_EQUAL_ID, groupName, LESS_THAN_DISPLAY, LESS_THAN_ID, LESS_THAN_OR_EQUAL_DISPLAY, LESS_THAN_OR_EQUAL_ID, navCriteria, NOT_EQUAL_DISPLAY, NOT_EQUAL_ID, NOT_SET_ID, part, smartCollection, targets, taskUri

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 void	adjustAttributeFilter(com.infoengine.object.factory.Element element, List<AttributeStructFilterRule> attributeRule)	For each entry in the attributeRule object, create a new Info*Engine Att object related to the AttributeStructFilterRule and add it to the element argument.
protected com.infoengine.object.factory.Element	adjustAttributeFilterElement(com.infoengine.object.factory.Element element, NavigationCriteria navigationCriteria, String groupName, AttributeStructFilter attributeFilter, Collection<ESITarget> targets, String standardConfigSpecId)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected void	adjustExpressionForAttributeFilter(com.infoengine.object.factory.Element element, AttributeStructFilterRule filterRule, AttributeStructFilterDelegate attsDelgate, StringBuilder rule)	For each entry in the expressions(AttributeStructFilterExpression) object, create a new Info*Engine Att object related to the element argument.
protected void	buildGroups()	Output generator for the class.
void	getAllFilters(String groupName, Collection<NavigationCriteria> navigationCriterias, Collection<NavigationFilter2> filters, Collection<ESITarget> targets, String auth, VdbBuilder vdbBuilder, AccountabilityMap accMap)	Renders the all Filters related to the input navigation criteria.
protected void	validate()	Make sure the object is ready to process.

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

createComparisonMap, getATONavCriteriaFilter, getCurrentNavCriterias, getNavCriteria, getNavCriteriaFilters, getPreviousNavCriteriasMap, setATONavigationFilter, setdata, setData, setNavCriteria, setNavigationCriteriaIdAttribute

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

getAllFilters

public void getAllFilters(String groupName,
 Collection<NavigationCriteria> navigationCriterias,
 Collection<NavigationFilter2> filters,
 Collection<ESITarget> targets,
 String auth,
 VdbBuilder vdbBuilder,
 AccountabilityMap accMap)
                   throws WTException

Renders the all Filters related to the input navigation criteria.

Supported API: true

Parameters:

groupName - - Element group name.

navigationCriterias - - A collection of NavigationCritera objects for which filter information has to be rendered.

filters - - A collection of filters to be rendered.

targets - - A collection of associated ESI targets.

auth - - This parameter contains authentication information required for executing certain Windchill adapter.

vdbBuilder - - The VdbBuilder to use when creating output.

Throws:

WTException

buildGroups

protected void buildGroups()
                    throws WTException

Output generator for the class. Does the following:

1. Obtains a list of navigation filters associated to navigation criteria.
2. Identify the type of filter and call respective renderer APIs.
3. Calls renderPlantFilter().
4. Calls renderAttributeStructureFilter().
5. Calls renderATONavigationFilter().


Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

WTException

validate

protected void validate()
                 throws ESIRendererException

Make sure the object is ready to process. If navigation criterias, authentication, or adapterName are null, throws an exception.

Supported API: true

Overrides:

validate in class NavigationCriteriaAssociatedObjectRenderer

Throws:

ESIRendererException

adjustAttributeFilter

protected void adjustAttributeFilter(com.infoengine.object.factory.Element element,
 List<AttributeStructFilterRule> attributeRule)

For each entry in the attributeRule object, create a new Info*Engine Att object related to the AttributeStructFilterRule and add it to the element argument.
Supported API: true

Parameters:

element - - The Info*Engine element that is to be updated.

attributeRule - - A collection of AttributeStructFilterRule objects.

adjustExpressionForAttributeFilter

protected void adjustExpressionForAttributeFilter(com.infoengine.object.factory.Element element,
 AttributeStructFilterRule filterRule,
 AttributeStructFilterDelegate attsDelgate,
 StringBuilder rule)
                                           throws WTException

For each entry in the expressions(AttributeStructFilterExpression) object, create a new Info*Engine Att object related to the element argument.
Supported API: true

Parameters:

element - - The Info*Engine element that is to be updated.

filterRule - - An object of AttributeStructFilterRule

attsDelgate - - An object of AttributeStructFilterDelegate

rule -

Throws:

WTException

adjustAttributeFilterElement

protected com.infoengine.object.factory.Element adjustAttributeFilterElement(com.infoengine.object.factory.Element element,
 NavigationCriteria navigationCriteria,
 String groupName,
 AttributeStructFilter attributeFilter,
 Collection<ESITarget> targets,
 String standardConfigSpecId)

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:

element - - The element to be updated.

navigationCriteria - - Persistable object in the context of which this AttributeStructFilter information has to rendered.

groupName - - The logical name of the group to which the element will be added.

attributeFilter - - The AttributeStructFilter that is being processed.

targets - - The collection of ESITarget objects.

standardConfigSpecId - - The object id of persistable object.

Returns:

updated element.