com.ptc.windchill.uwgm.proesrv.rrc
Class RRCFamilyTableHelper

java.lang.Object
  com.ptc.windchill.uwgm.proesrv.rrc.RRCFamilyTableHelper

public final class RRCFamilyTableHelper

extends Object

Process family table attributes: EpmGenericInfo, EpmInstanceInfo

Field Summary

private RequestResultCache	cache
private static String	CANT_GET_FT_ND
private EPMDownloadData	epmNDData
private EPMWorkspace	epmWS
private Folder	folder
private DbObjCache	ftCache
private FamilyTableResult	ftHelperResult
private Set	ftWithContent
private Collection	iterations
private Set	itersWithND
private static Log	log

Constructor Summary

RRCFamilyTableHelper(Collection iterations, RequestResultCache cache)
Construct helper for given collection of iterations

RRCFamilyTableHelper(EPMWorkspace epmWS, Collection iterations, RequestResultCache cache)
Construct helper for given collection of iterations from a WS.

RRCFamilyTableHelper(Folder folder, Collection iterations, RequestResultCache cache)
Construct helper for given collection of iterations from a folder.

Method Summary

private void	checkNeutralDataRequested(com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i epmIter_i, com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra)
(package private) boolean	familyTableInfoRequested(com.ptc.windchill.uwgm.soap.uwgmdb.EpmIteration epmIter)
(package private) static boolean	familyTableInfoRequested(com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra)
private void	processFamilyTable(com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i epmIter_i, EPMDocument doc, com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra) Assign epmIter_i.setEpmFamilyTable().
private void	processGenericInfo(com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i epmIter_i, EPMDocument doc, com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra) Set the EpmGenericInfo for the generic document, i.e.
private void	processGenericInstance(com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i epmIter_i, com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra)
private void	processNeutralData()
private void	retrieveFTInfo()
private void	retrieveNeutralData()
void	setFamilyTableInfo()
private void	setInstanceInfo(com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i epmIter_i, com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i genericIteration, com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static Log log

CANT_GET_FT_ND

private static final String CANT_GET_FT_ND

See Also:

Constant Field Values

iterations

private final Collection iterations

cache

private final RequestResultCache cache

epmWS

private EPMWorkspace epmWS

folder

private Folder folder

ftHelperResult

private FamilyTableResult ftHelperResult

epmNDData

private EPMDownloadData epmNDData

itersWithND

private final Set itersWithND

ftWithContent

private final Set ftWithContent

ftCache

private final DbObjCache ftCache

Constructor Detail

RRCFamilyTableHelper

public RRCFamilyTableHelper(Collection iterations,
                            RequestResultCache cache)

Construct helper for given collection of iterations

Parameters:

iterations - Collection

cache - RequestResultCache

RRCFamilyTableHelper

public RRCFamilyTableHelper(EPMWorkspace epmWS,
                            Collection iterations,
                            RequestResultCache cache)

Construct helper for given collection of iterations from a WS.

Parameters:

epmWS - EPMWorkspace to restrict the query

iterations - Collection

cache - RequestResultCache

RRCFamilyTableHelper

public RRCFamilyTableHelper(Folder folder,
                            Collection iterations,
                            RequestResultCache cache)

Construct helper for given collection of iterations from a folder.

Parameters:

folder - wt.folder.Folder to restrict the query

iterations - Collection

cache - RequestResultCache

Method Detail

setFamilyTableInfo

public void setFamilyTableInfo()
                        throws UwgmErrorException

Throws:

UwgmErrorException

retrieveFTInfo

private void retrieveFTInfo()

processFamilyTable

private void processFamilyTable(com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i epmIter_i,
                                EPMDocument doc,
                                com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra)

Assign epmIter_i.setEpmFamilyTable(). If necessary, create the EpmFamilyTable_i object and process its lazy attributes.

Parameters:

epmIter_i - EpmIteration_i

doc - EPMDocument

ra - RequestedAttributes

processGenericInfo

private void processGenericInfo(com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i epmIter_i,
                                EPMDocument doc,
                                com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra)

Set the EpmGenericInfo for the generic document, i.e. list of its instances. Can add instances to the cache if they are not in the seed objects. Recursively processes added nested generics.

Parameters:

epmIter_i - a generic EpmIteration_i

doc - EPMDocument a generic document

ra - RequestedAttributes

processGenericInstance

private void processGenericInstance(com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i epmIter_i,
                                    com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra)

setInstanceInfo

private void setInstanceInfo(com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i epmIter_i,
                             com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i genericIteration,
                             com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra)

checkNeutralDataRequested

private void checkNeutralDataRequested(com.ptc.windchill.uwgm.soap.impl.uwgmdb.EpmIteration_i epmIter_i,
                                       com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra)

retrieveNeutralData

private void retrieveNeutralData()

processNeutralData

private void processNeutralData()
                         throws UwgmErrorException

Throws:

UwgmErrorException

familyTableInfoRequested

boolean familyTableInfoRequested(com.ptc.windchill.uwgm.soap.uwgmdb.EpmIteration epmIter)

familyTableInfoRequested

static boolean familyTableInfoRequested(com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest.RequestedAttributes ra)