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

Class PartCollector

java.lang.Object
com.ptc.windchill.collector.api.part.PartCollector
All Implemented Interfaces:
Collector
public class PartCollector extends Object implements Collector
PartCollector is a generic API for collecting part structures. Given seed
parts and criteria for navigating the structure of these parts returns a
PartCollectorResult object which gives access to the collected parts
comprising the structure along with information about the relationships
between parts in the structure.

PartCollector uses Builder Design pattern to create its instances.
For many input parameters it is better than constructor or static factory.
We create a custom builder from required and optional input parameters
and then an immutable PartCollector object instance using the builder.

Once the collector has been built and collection has been performed
it must be closed to free resources used in the process of collecting.
After the collector is closed it cannot be used again.


Supported API: true

Extendable: false

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    PartCollector.Builder
    Used to build an immutable PartCollector object.


    Supported API: true

    Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    closeCollector()
    This cleans up any internal artifacts that were created in
    collecting dependents, this should be called when you are done
    collecting to free resources.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • closeCollector

      public void closeCollector() throws WTException
      This cleans up any internal artifacts that were created in
      collecting dependents, this should be called when you are done
      collecting to free resources. Once this is called you cannot
      use the collector further.



      Supported API: true
      Throws:
      WTException