Class FilterRenderer

All Implemented Interfaces:
ESIRenderer

public class FilterRenderer extends NavigationCriteriaAssociatedObjectRenderer
Renders ATONavigationFilter, AttributeStructFilter

Supported API: true

Extendable: true
  • Method Details

    • getAllFilters

      public void getAllFilters(WTPart context, NavigationCriteria navCriteria, String groupName, String authentication, VdbBuilder builder) throws WTException
      Renders the all Filters related to the input variantSpec.

      Supported API: true
      Parameters:
      context - - Object for which the Filters(ATONavigationFilter, AttributeFilter etc) have to rendered(Part) code.
      navCriteria - - A NavigationCritera object for which filter information has to be rendered
      groupName - - Represents the logical group name in the response.
      authentication - - This parameter contains authentication information required for executing certain Windchill adapter
      builder - - The VdbBuilder to use when creating output.
      Throws:
      WTException
    • buildGroups

      protected void buildGroups() throws ESIRendererException
      Renders the filters(AtoNavigationFIlter and Attribute Filter).The filters are rendered from the NavigaitonCriteria and then iterating over the returned filters one can find the different filters for which we want to display the information
      Supported API: true
      Specified by:
      buildGroups in class BasicESIRenderer
      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.
      Parameters:
      element - The Info*Engine element that is to be updated.
      attributeRule - A collection of AttributeStructFilterRule objects.
      Throws:
      WTException
    • 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 -
      expressions - An array of AttributeStructFilterExpression objects.
      Throws:
      WTException
    • adjustAttributeFilterElement

      protected com.infoengine.object.factory.Element adjustAttributeFilterElement(com.infoengine.object.factory.Element element, Persistable context, String groupName, AttributeStructFilter attributeFilter, Collection<ESITarget> tgts2, 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.
      context - - Persistable object in the context of which this VariantSpec information needs to be rendered i.e Part object.
      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.
      Returns:
      updated element.
    • adjustATONavigationFilterElement

      protected com.infoengine.object.factory.Element adjustATONavigationFilterElement(com.infoengine.object.factory.Element element, Persistable context, String groupName, ATONavigationFilter optionFilter, Collection<ESITarget> targets)
      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.
      context - - Persistable object for which this Filter information needs to be rendered i.e NavigationCriteria object.
      groupName - - The logical name of the group to which the element will be added.
      optionFilter - - The ATONavigationFilter that is being processed.
      targets - - The collection of ESITarget objects.
      Returns:
      updated element.
    • adjustOptionFilterConfigSpecElement

      protected com.infoengine.object.factory.Element adjustOptionFilterConfigSpecElement(com.infoengine.object.factory.Element element, Persistable context, String groupName, ATORuleConfigSpec configSpec, Collection<ESITarget> tgts2, String optionFilterConfigSpecID)
      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.
      context - - Persistable object for which the OptionFilterConfigSpec information needs to be rendered i.e NavigatoinCriteria object.
      groupName - - The logical name of the group to which the element will be added.
      configSpec - - The ATORuleConfigSpec that is being processed.
      targets - - The collection of ESITarget objects.
      Returns:
      updated element.