Package com.ptc.windchill.collector.api.part

Class PartCollector.Builder

java.lang.Object
com.ptc.windchill.collector.api.part.PartCollector.Builder
Enclosing class:
PartCollector
public static class PartCollector.Builder extends Object
Used to build an immutable PartCollector object.


Supported API: true

Extendable: false

  • Constructor Summary

    Constructors
    Constructor
    Description
    Builder(PartCollector seedCollector, Collection<PartSpatialRule> spatialRules)
    Builds a collector that can collect dependents based a seed collector
    and additional spatial rules.

    The new collector builds upon the results of the seed collector.
    This is provided for performance purposes when doing proximity spatial
    rule processing.
    Builder(WTCollection seeds, NavigationCriteria criteria)
    Builds a collector that can collect dependents for multiple part
    seeds with the given navigation criteria.

    Spatial rule processing is not enabled.



    Supported API: true
    Builder(Iterated seed, NavigationCriteria criteria, boolean spatialRuleProcessingEnabled)
    Builds a collector that can collect dependents for a single part
    seed with the given navigation criteria.

    This constructor allows you to specify whether or not to allow for
    spatial rule processing.
    Builder(Iterated seed, NavigationCriteria criteria, boolean spatialRuleProcessingEnabled, boolean calculateDistance)
    Builds a collector that can collect dependents for a single part
    seed with the given navigation criteria.

    This constructor allows you to specify whether or not to allow for
    spatial rule processing.
    Builder(Iterated seed, NavigationCriteria criteria, Collection<PartSpatialRule> spatialRules)
    Builds a collector that can collect dependents for a single part
    seed with the given navigation criteria and spatial rules.

    This constructor allows you to specify whether or not to allow for
    spatial rule processing.
    Builder(Iterated seed, NavigationCriteria criteria, Collection<PartSpatialRule> spatialRules, boolean calculateDistance)
    Builds a collector that can collect dependents for a single part
    seed with the given navigation criteria and spatial rules.

    This constructor allows you to specify whether or not to allow for
    spatial rule processing.

  • Method Summary

    Modifier and Type
    Method
    Description
    PartCollector
    build()
    Builds the immutable collector.



    Supported API: true

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Builder

      public Builder(WTCollection seeds, NavigationCriteria criteria)
      Builds a collector that can collect dependents for multiple part
      seeds with the given navigation criteria.

      Spatial rule processing is not enabled.



      Supported API: true
      Parameters:
      seeds -
      criteria -

    • Builder

      public Builder(Iterated seed, NavigationCriteria criteria, boolean spatialRuleProcessingEnabled)
      Builds a collector that can collect dependents for a single part
      seed with the given navigation criteria.

      This constructor allows you to specify whether or not to allow for
      spatial rule processing. Even though no rules are specified by in this
      constructor the user may wish to use the collector that this builds as
      the seed collector for another collector that will use spatial rules.



      Supported API: true
      Parameters:
      seed -
      criteria -
      spatialRuleProcessingEnabled -

    • Builder

      public Builder(Iterated seed, NavigationCriteria criteria, boolean spatialRuleProcessingEnabled, boolean calculateDistance)
      Builds a collector that can collect dependents for a single part
      seed with the given navigation criteria.

      This constructor allows you to specify whether or not to allow for
      spatial rule processing. Even though no rules are specified by in this
      constructor the user may wish to use the collector that this builds as
      the seed collector for another collector that will use spatial rules.

      This constructor allows you to specify whether or not to calculate
      the distance of parts collected from the spatial criteria specified.
      If a proximity rule is specified the distance will be from the proximity
      part. If a box or sphere rule is specified the distance will be from
      the centroid of the box or sphere. Also, calculation of distance is only
      supported for one spatial rule.



      Supported API: true
      Parameters:
      seed -
      criteria -
      spatialRuleProcessingEnabled -
      calculateDistance -

    • Builder

      public Builder(Iterated seed, NavigationCriteria criteria, Collection<PartSpatialRule> spatialRules)
      Builds a collector that can collect dependents for a single part
      seed with the given navigation criteria and spatial rules.

      This constructor allows you to specify whether or not to allow for
      spatial rule processing. Even though no rules are specified by in this
      constructor the user may wish to use the collector that this builds as
      the seed collector for another collector that will use spatial rules.



      Supported API: true
      Parameters:
      seed -
      criteria -
      spatialRules -

    • Builder

      public Builder(Iterated seed, NavigationCriteria criteria, Collection<PartSpatialRule> spatialRules, boolean calculateDistance)
      Builds a collector that can collect dependents for a single part
      seed with the given navigation criteria and spatial rules.

      This constructor allows you to specify whether or not to allow for
      spatial rule processing. Even though no rules are specified by in this
      constructor the user may wish to use the collector that this builds as
      the seed collector for another collector that will use spatial rules.

      This constructor allows you to specify whether or not to calculate
      the distance of parts collected from the spatial criteria specified.
      If a proximity rule is specified the distance will be from the proximity
      part. If a box or sphere rule is specified the distance will be from
      the centroid of the box or sphere. Also, calculation of distance is only
      supported for one spatial rule.



      Supported API: true
      Parameters:
      seed -
      criteria -
      spatialRules -

    • Builder

      public Builder(PartCollector seedCollector, Collection<PartSpatialRule> spatialRules)
      Builds a collector that can collect dependents based a seed collector
      and additional spatial rules.

      The new collector builds upon the results of the seed collector.
      This is provided for performance purposes when doing proximity spatial
      rule processing. When doing this it is advisable to get the paths
      you wish to use for proximity rule processing from an initial
      collector and then to build on top of that collector with this
      constructor when applying the spatial rules.



      Supported API: true
      Parameters:
      seedCollector -
      spatialRules -

  • Method Details