Package com.ptc.windchill.collector.api.cad

Class CadCollector

java.lang.Object

com.ptc.windchill.collector.api.cad.CadCollector

All Implemented Interfaces:

Collector

public final class CadCollector
extends Object
implements Collector

CAD specific collector object able to gather data objects per configured specification and options.
This is specific collector object type with methods for gathering data for CAD source objects.

Supported API: true
Extendable: false

 Here is an example how to create CadCollector new instance and use it to get result.

 CadCollector collector = CadCollector.newInstance(seeds, criteria)
                 .dependents(GatherDependents.ONLY_REQUIRED)
                 .associatedParts(GatherAssociatedParts.ALL)
                 .container(myContainer)
                 .workspace(myWorkspace);

 CadCollectedResult result = collector.collect();

 Required parameters are CAD seeds and navigation criteria, others are optional.
 

See Also:

• newInstance(WTCollection, NavigationCriteria)
• collect()
• CadCollectedResult

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CadCollector.GatherAssociatedParts	Define which associated parts to gather.
static enum	CadCollector.GatherDependents	Define which dependents to gather.
static enum	CadCollector.GatherDrawings	Define which drawings to gather.
static enum	CadCollector.GatherFamilyGenerics	Define which family generic objects to gather.
static enum	CadCollector.GatherFamilyMembers	Define which family members to gather.

Method Summary

Modifier and Type	Method	Description
CadCollector	associatedParts(CadCollector.GatherAssociatedParts option)	Set optional parameter defining which associated parts to gather.
CadCollectedResult	collect()	Gather data objects according to a configured specification and selected options.
CadCollector	container(WTContainer wtContainer)	Set container optional parameter.
CadCollector	dependents(CadCollector.GatherDependents option)	Set optional parameter defining which dependents to gather.
CadCollector	drawings(CadCollector.GatherDrawings option)	Set optional parameter defining which drawings to gather.
CadCollector	familyGenerics(CadCollector.GatherFamilyGenerics option)	Set optional parameter defining which family generic objects to gather.
CadCollector	familyMembers(CadCollector.GatherFamilyMembers option)	Set optional parameter defining which family members to gather.
static CadCollector	newInstance(WTCollection seeds, NavigationCriteria criteria)	Factory to create new instance from required parameters.
String	toString()	Convenient instance representation useful for logging and debugging.
CadCollector	workspace(EPMWorkspace epmWorkspace)	Set workspace optional parameter.

Methods inherited from class java.lang.Object

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

Method Details

newInstance

public static CadCollector newInstance(WTCollection seeds,
 NavigationCriteria criteria)
                                throws WTPropertyVetoException

Factory to create new instance from required parameters.

Parameters:

seeds - input CAD objects.

criteria - input navigation criteria.

Throws:

WTPropertyVetoException - if input seeds are invalid.

Supported API: true

workspace

public CadCollector workspace(EPMWorkspace epmWorkspace)
                       throws WTPropertyVetoException

Set workspace optional parameter.

Parameters:

epmWorkspace - workspace object.

Returns:

CadCollector object to allow chaining for convenient compact calls.

Throws:

WTPropertyVetoException - if input parameter value was invalid.

Supported API: true

container

public CadCollector container(WTContainer wtContainer)
                       throws WTPropertyVetoException

Set container optional parameter.

Parameters:

wtContainer - container object.

Returns:

CadCollector object to allow chaining for convenient compact calls.

Throws:

WTPropertyVetoException - if input parameter value was invalid.

Supported API: true

dependents

public CadCollector dependents(CadCollector.GatherDependents option)
                        throws WTPropertyVetoException

Set optional parameter defining which dependents to gather.

Parameters:

option - CadCollector.GatherDependents value defining which dependents to gather.

Returns:

CadCollector object to allow chaining for convenient compact calls.

Throws:

WTPropertyVetoException - if input parameter value was invalid.

Supported API: true

associatedParts

public CadCollector associatedParts(CadCollector.GatherAssociatedParts option)
                             throws WTPropertyVetoException

Set optional parameter defining which associated parts to gather.

Parameters:

option - CadCollector.GatherAssociatedParts value defining which associated parts to gather.

Returns:

CadCollector object to allow chaining for convenient compact calls.

Throws:

WTPropertyVetoException - if input parameter value was invalid.

Supported API: true

drawings

public CadCollector drawings(CadCollector.GatherDrawings option)
                      throws WTPropertyVetoException

Set optional parameter defining which drawings to gather.

Parameters:

option - CadCollector.GatherDrawings value defining which drawings to gather.

Returns:

CadCollector object to allow chaining for convenient compact calls.

Throws:

WTPropertyVetoException - if input parameter value was invalid.

Supported API: true

familyGenerics

public CadCollector familyGenerics(CadCollector.GatherFamilyGenerics option)
                            throws WTPropertyVetoException

Set optional parameter defining which family generic objects to gather.

Parameters:

option - CadCollector.GatherFamilyGenerics value defining which family generic objects to gather.

Returns:

CadCollector object to allow chaining for convenient compact calls.

Throws:

WTPropertyVetoException - if input parameter value was invalid.

Supported API: true

familyMembers

public CadCollector familyMembers(CadCollector.GatherFamilyMembers option)
                           throws WTPropertyVetoException

Set optional parameter defining which family members to gather.

Parameters:

option - CadCollector.GatherFamilyMembers value defining which family members to gather.

Returns:

CadCollector object to allow chaining for convenient compact calls.

Throws:

WTPropertyVetoException - if input parameter value was invalid.

Supported API: true

collect

public CadCollectedResult collect()
                           throws WTException,
WTPropertyVetoException

Gather data objects according to a configured specification and selected options.
Supported API: true

Specified by:

collect in interface Collector

Returns:

instance of CollectedResult from where you can get access to all collected objects.

Throws:

WTException - contains error message if collect operation failed and may describe invalid input.

WTPropertyVetoException - if input was invalid.

See Also:

• 

Supported API: true

toString

public String toString()

Convenient instance representation useful for logging and debugging.

Overrides:

toString in class Object

Returns:

readable instance representation.

Supported API: true