com.ptc.windchill.esi.bom
Class BOMTreeNavigatorImpl

java.lang.Object
  com.ptc.windchill.esi.bom.BOMTreeNavigatorImpl

All Implemented Interfaces:

BOMTreeNavigator, Externalizable, Serializable

public class BOMTreeNavigatorImpl
extends Object
implements BOMTreeNavigator, Externalizable

Default ESI implementation of the BOMTreeNavigator.

Supported API: true

Extendable: true

See Also:

Serialized Form

Method Summary

protected String	getAdapter() Gets the value of the attribute: adapter; The name of the Windchill adapter to pass to the Query-Tree webject.
protected String	getAuth() Gets the value of the attribute: auth; The authentication information to pass to the Query-Tree webject.
Collection	getBomLeafUfids() Gets the value of the attribute: bomLeafUfids; A collection WTPart UFIDs that point to component parts.
Collection	getBomNodeUfids() Gets the value of the attribute: bomNodeUfids; A collection WTPart UFIDs that point to assembly parts.
protected String	getConfigspec() Gets the value of the attribute: configspec; The Config Spec.
protected int	getDepth() Gets the value of the attribute: depth; the number of levels to navigate.
Collection	getLeafNodeUfids() Returns a collection part UFIDs for all of the nodes in the tree that are not BOMs.
protected WTPart	getRoot() Gets the value of the attribute: root; The top-level assembly part.
protected void	processTree() If the bomNodeUfids attribute is null: calls validate() to insure that the attibute state contains all required information call the Windchill Adapter Query-Tree webject Parse the webject result and obtain all parts that have a child.
protected void	setBomLeafUfids(Collection a_BomLeafUfids) Sets the value of the attribute: bomLeafUfids; A collection WTPart UFIDs that point to component parts.
protected void	setBomNodeUfids(Collection a_BomNodeUfids) Sets the value of the attribute: bomNodeUfids; A collection WTPart UFIDs that point to assembly parts.
void	setData(WTPart root, int depth, String configSpec, String auth, String adapter) Sets the attributes on the object.
protected void	validate() Makes sure all attributes are in the correct state.Throws a WTException if: the root attribute is nullthe depth attribute is < 1the auth attribute is null or blank or spacesthe adapter attribute is null or blank or spaces Supported API: true

Methods inherited from class java.lang.Object

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

Method Detail

getBomNodeUfids

public Collection getBomNodeUfids()

Gets the value of the attribute: bomNodeUfids; A collection WTPart UFIDs that point to assembly parts. Initialized to null. Set by processTree().

Supported API: true

Specified by:

getBomNodeUfids in interface BOMTreeNavigator

Returns:

Collection

setBomNodeUfids

protected void setBomNodeUfids(Collection a_BomNodeUfids)

Sets the value of the attribute: bomNodeUfids; A collection WTPart UFIDs that point to assembly parts. Initialized to null. Set by processTree().

Supported API: true

Parameters:

a_BomNodeUfids -

getBomLeafUfids

public Collection getBomLeafUfids()

Gets the value of the attribute: bomLeafUfids; A collection WTPart UFIDs that point to component parts. Initialized to null. Set by processTree().

Supported API: true

Returns:

Collection

setBomLeafUfids

protected void setBomLeafUfids(Collection a_BomLeafUfids)

Sets the value of the attribute: bomLeafUfids; A collection WTPart UFIDs that point to component parts. Initialized to null. Set by processTree().

Supported API: true

Parameters:

a_BomLeafUfids -

getRoot

protected WTPart getRoot()

Gets the value of the attribute: root; The top-level assembly part.

Supported API: true

Returns:

WTPart

getConfigspec

protected String getConfigspec()

Gets the value of the attribute: configspec; The Config Spec. value to use when navigating the BOM. See the Query-Tree Webject documentation for acceptable and default values.

Supported API: true

Returns:

String

getDepth

protected int getDepth()

Gets the value of the attribute: depth; the number of levels to navigate.

Supported API: true

Returns:

int

getAdapter

protected String getAdapter()

Gets the value of the attribute: adapter; The name of the Windchill adapter to pass to the Query-Tree webject.

Supported API: true

Returns:

String

getAuth

protected String getAuth()

Gets the value of the attribute: auth; The authentication information to pass to the Query-Tree webject.

Supported API: true

Returns:

String

processTree

protected void processTree()
                    throws WTException

If the bomNodeUfids attribute is null:

• calls validate() to insure that the attibute state contains all required information
• call the Windchill Adapter Query-Tree webject
• Parse the webject result and obtain all parts that have a child. Add those parts to the bomNodeUfids collection
• for each element that has no children, determine whether the part is a BOM. If so, add the element to the bomNodeUfids attribute. If not, add the element to the bomLeafUfids attribute.

Supported API: true

Throws:

WTException

setData

public void setData(WTPart root,
                    int depth,
                    String configSpec,
                    String auth,
                    String adapter)
             throws WTException

Sets the attributes on the object. Throws a WTException if:

• the root argument is null
• the depth argument is < 1
• the auth argument is null or blank
• the adapter argument is null or blank

Supported API: true

Specified by:

setData in interface BOMTreeNavigator

Parameters:

root - The assembly part for the top-level BOM.

depth - The number of levels of BOM.

configSpec - The Config Spec. value to use when navigating the BOM. See the Query-Tree Webject documentation for acceptable and default values.

auth - This parameter contains authentication information from I*E.

adapter - This parameter contains the name of the Windchill adapter.

Throws:

WTException

validate

protected void validate()
                 throws WTException

Makes sure all attributes are in the correct state.Throws a WTException if:

• the root attribute is null
• the depth attribute is < 1
• the auth attribute is null or blank or spaces
• the adapter attribute is null or blank or spaces

Supported API: true

Throws:

WTException

getLeafNodeUfids

public Collection getLeafNodeUfids()
                            throws WTException

Returns a collection part UFIDs for all of the nodes in the tree that are not BOMs.

Supported API: true

Specified by:

getLeafNodeUfids in interface BOMTreeNavigator

Returns:

Collection

Throws:

WTException