wt.epm.ndi.impl
Class EPMDownloadData

java.lang.Object
  wt.epm.ndi.impl.EPMDownloadData

public class EPMDownloadData

extends Object

Provides functionality to get EPMNDNeutralData. Dependencies and Attributes are fetched only when asked. when fetched, dependencies and attributes for all documents are fetched together. Supported API: false Extendable: false

Field Summary

private NDICache	cache
private EPMNeutralDataImpl	ndata
private static ArrayList	profilers

Constructor Summary

EPMDownloadData(EPMWorkspace workspace, WTCollection objects)
Constructs EPMDownloadData using documents and family tables in workspace.

EPMDownloadData(EPMWorkspace workspace, WTCollection objects, boolean includeMissingInstances)
Constructs EPMDownloadData using documents and family tables in workspace.

Method Summary

WTKeyedMap	getDocumentMap() Returns documents map where key is EPMDocument and value is it's EPMNDDocument.
EPMNDFamilyTableMember	getEPMNDFamilyTableMember(EPMFamilyTable familyTable, EPMDocument document) Returns EPMNDFamilyTableMember for specified Family table and document.
EPMNDMemberLink	getEPMNDMemberLink(EPMMemberLink link) Returns EPMNDMemberLink for a specified link.
EPMNDReferenceLink	getEPMNDReferenceLink(EPMReferenceLink link) Returns EPMNDReferenceLink for a specified link.
EPMNeutralData	getEPMNeutralData() Return EPMNeutralData
static void	printProfileData() Prints information about the time spent in EPMDownloadData queries.

Methods inherited from class java.lang.Object

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

Field Detail

cache

private NDICache cache

ndata

private EPMNeutralDataImpl ndata

profilers

private static ArrayList profilers

Constructor Detail

EPMDownloadData

public EPMDownloadData(EPMWorkspace workspace,
                       WTCollection objects)
                throws WTException

Constructs EPMDownloadData using documents and family tables in workspace.

Parameters:

workspace -

objects - Compatible documents/family tables. If objects are not compatible, WTException may be thrown when calling methods on Neutral data. If family tables are not found in the objects, compatible family tables are searched in workspace.

EPMDownloadData

public EPMDownloadData(EPMWorkspace workspace,
                       WTCollection objects,
                       boolean includeMissingInstances)
                throws WTException

Constructs EPMDownloadData using documents and family tables in workspace.

Parameters:

workspace -

objects - Compatible documents/family tables.

Method Detail

printProfileData

public static void printProfileData()

Prints information about the time spent in EPMDownloadData queries. If EPMDownloadData is called within active Transaction, this method is automatically called at the end of Transaction. You need to call this method at the end of your work if there is no active Transaction. Note: Profile data is collected only if wt.epm.ndi.impl.EPMDownloadData.log.time property is set to true.

Throws:

WTException

getEPMNeutralData

public EPMNeutralData getEPMNeutralData()
                                 throws WTException

Return EPMNeutralData

Returns:

EPMNeutralData

Throws:

WTException

getEPMNDMemberLink

public EPMNDMemberLink getEPMNDMemberLink(EPMMemberLink link)
                                   throws WTException

Returns EPMNDMemberLink for a specified link. If link is not associated with any of documents of EPMDownloadData, IllegalStateException is thrown.

Parameters:

link - EPMMemberLink

Returns:

EPMNDMemberLink

Throws:

WTException

getEPMNDReferenceLink

public EPMNDReferenceLink getEPMNDReferenceLink(EPMReferenceLink link)
                                         throws WTException

Returns EPMNDReferenceLink for a specified link. If link is not associated with any of documents of EPMDownloadData, IllegalStateException is thrown.

Parameters:

link - EPMReferenceLink

Returns:

EPMNDReferenceLink

Throws:

WTException

getEPMNDFamilyTableMember

public EPMNDFamilyTableMember getEPMNDFamilyTableMember(EPMFamilyTable familyTable,
                                                        EPMDocument document)
                                                 throws WTException

Returns EPMNDFamilyTableMember for specified Family table and document. If document is specified when creating EPMDownloadData, IllegalStateException is thrown. If family table is not associated with any of documents of EPMDownloadData, IllegalStateException is thrown.

Returns:

EPMNDFamilyTableMember

Throws:

WTException

getDocumentMap

public WTKeyedMap getDocumentMap()
                          throws WTException

Returns documents map where key is EPMDocument and value is it's EPMNDDocument.

Returns:

WTKeyedMap

Throws:

WTException