com.ptc.hli.ecad
Class ECADDocument

java.lang.Object
  com.ptc.hli.ecad.ECADDocument

public class ECADDocument

extends Object

The ECADDocument class represents an individual CAD document within an assembly. It may be of type "ASSEMBLY", "BOARD", "COMPONENT", "SCHEMATIC", "SOURCE". or "CONTENT".

Supported API: true

Extendable: false

Field Summary

private HashMap	assemblies
static String	ASSEMBLY Label for the ECAD Document Type attribute "ASSEMBLY" Supported API: true
static EPMDocumentType	ASSEMBLY_TYPE
static String	BOARD Label for the ECAD Document Type attribute "BOARD" Supported API: true
static EPMDocumentType	BOARD_TYPE
static String	CADENCE Label for the Authoring Application attribute Cadence Supported API: true
static String	COMPONENT Label for the ECAD Document Type attribute "COMPONENT" Supported API: true
static EPMDocumentType	COMPONENT_TYPE
static String	CONTENT Label for the ECAD Document Type attribute "CONTENT" Supported API: true
static EPMDocumentType	CONTENT_TYPE
private Vector	describeBy
private ECADDesign	design
private EPMDocument	document
private static String	ECADHLIRESOURCE
private Folder	folderCache
private HashMap	links
static String	MENTORB Label for the Authoring Application attribute Mentor Board Station Supported API: true
static String	MENTORE Label for the Authoring Application attribute Mentor Expedition Supported API: true
static String	SCHEMATIC Label for the ECAD Document Type attribute "SCHEMATIC" Supported API: true
static EPMDocumentType	SCHEMATIC_TYPE
static String	SOURCE Label for the ECAD Document Type attribute "SOURCE" Supported API: true
static EPMDocumentType	SOURCE_TYPE
private String	targetRevision

Constructor Summary

ECADDocument(EPMDocument document)
Construst an ECADDocument with the given EPMDocument

Supported API: false

Method Summary

void	addAssembly(ECADAssembly assembly) Associate an ECADAssembly with this ECADDocument Supported API: false
void	addLink(String number, EPMDependencyLink link)
void	deleteAttrValue(String attrDefName) Delete the value(s) of the named Attribute associated with this ECADDocument Supported API: true
Collection	getAssemblies() Get a collection of all ECADAssemblies associated with this ECADDocument Supported API: false
ECADAssembly	getAssembly(String assemblyNumber) Get the numbered ECADAssembly associated with this ECADDocument Supported API: false
Object	getAttrValue(String attrDefName) Get the value of the named Attribute associated with this ECADDocument Supported API: true
String	getAuthoringApplication() Return the Authoring Application of the ECADDocument Supported API: true
long	getBranch() Get the Branch ID associated with this ECADDocument Supported API: false
String	getContext()
Vector	getDescribeBy()
String	getDescription() Return the description of the ECADDocument Supported API: true
ECADDesign	getDesign() Get the ECADDesign for this assembly Supported API: false
String	getDocFolderPath() Path of folder holding EPM documents.
static ECADDocument	getDocument(String number, String version, WTContainerRef containerRef) Static method to return the ECADDocument with the given number, version.
String	getDocumentType() Return the Document Type of the ECADDocument Supported API: true
EPMDocument	getEPMDocument() Get the EPMDocument associated with this ECADDocument Supported API: false
Folder	getFolder() Return the Folder of the ECADDocument Supported API: true
String	getIteration() Return the iteration of the ECADDocument Supported API: true
String	getLifeCycleName() Return the LifeCycle name of the ECADDocument Supported API: true
EPMDependencyLink	getLink(String number)
Iterator	getLinkIterator()
Collection	getLinks()
String	getName() Return the name of the ECADDocument Supported API: true
String	getNumber() Return the number of the ECADDocument Supported API: true
private static Folder	getOriginalFolder(EPMDocument doc) Path of design's superfolder.
String	getProjectName() Return the project name of the ECADDocument Supported API: true
String	getSolution()
String	getTargetRevision() Return the target Revision for the CADDocument Supported API: true
protected String	getTeamTemplateName() Return the name of the Team Template for this ECADDocument Supported API: false
String	getTopFolderPath()
String	getVersion() Return the version of the ECADDocument Supported API: true
static boolean	isLatestDocument(String number, String version, WTContainerRef containerRef)
boolean	isPersistent() Check the persisted status of the EPMDocument underlying the ECADDocument.
protected void	loadFileGroups(HashSet hSet)
static EPMDocument	lookupDocument(String number, String version, WTContainerRef containerRef) Static method to return the EPMDocument with the given number, version.
static ECADDocument	newECADDocument(String number, String name, String authoringApp, String type, String revision, WTContainerRef containerRef) Factory method to construct a new ECADDocument from the number, name, authoringApplication, type and revision.
static ECADDocument	newECADDocument(String number, String name, String authoringApp, String type, WTContainerRef containerRef) Factory method to construct a new ECADDocument from the number, name, authoringApplication and type.
void	removeAssembly(String assemblyNumber) Remove the association between an ECADAssembly and this ECADDocument Supported API: false
void	removeLink(EPMDependencyLink link)
void	removeLink(String number)
void	setAttrValue(String attrDefName, Object newValue) Set the value of the named Attribute associated with this ECADDocument Supported API: true
void	setDescribeBy(Vector describeByLinks)
void	setDescription(String newDescription) Set the description of the ECADDocument Supported API: true
void	setDesign(ECADDesign _design) Set the ECADDesign for this assembly Supported API: false
void	setLifeCycle(String lifeCycleName, WTContainerRef containerRef)
void	setTargetRevision(String _targetRevision) Set the target Revision of the CADDocument Supported API: true
protected void	setTeamTemplate(String templateName)
String	toString() Override of the toString method for outputting the ECADDocument Supported API: false
void	update(EPMDocument document) Update the EPMDocument associated with this ECADDocument Supported API: false

Methods inherited from class java.lang.Object

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

Field Detail

MENTORB

public static final String MENTORB

Label for the Authoring Application attribute Mentor Board Station

Supported API: true

See Also:

Constant Field Values

MENTORE

public static final String MENTORE

Label for the Authoring Application attribute Mentor Expedition

Supported API: true

See Also:

Constant Field Values

CADENCE

public static final String CADENCE

Label for the Authoring Application attribute Cadence

Supported API: true

See Also:

Constant Field Values

ASSEMBLY

public static final String ASSEMBLY

Label for the ECAD Document Type attribute "ASSEMBLY"

Supported API: true

See Also:

Constant Field Values

BOARD

public static final String BOARD

Label for the ECAD Document Type attribute "BOARD"

Supported API: true

See Also:

Constant Field Values

COMPONENT

public static final String COMPONENT

Label for the ECAD Document Type attribute "COMPONENT"

Supported API: true

See Also:

Constant Field Values

SCHEMATIC

public static final String SCHEMATIC

Label for the ECAD Document Type attribute "SCHEMATIC"

Supported API: true

See Also:

Constant Field Values

SOURCE

public static final String SOURCE

Label for the ECAD Document Type attribute "SOURCE"

Supported API: true

See Also:

Constant Field Values

CONTENT

public static final String CONTENT

Label for the ECAD Document Type attribute "CONTENT"

Supported API: true

See Also:

Constant Field Values

ASSEMBLY_TYPE

public static final EPMDocumentType ASSEMBLY_TYPE

BOARD_TYPE

public static final EPMDocumentType BOARD_TYPE

COMPONENT_TYPE

public static final EPMDocumentType COMPONENT_TYPE

SCHEMATIC_TYPE

public static final EPMDocumentType SCHEMATIC_TYPE

SOURCE_TYPE

public static final EPMDocumentType SOURCE_TYPE

CONTENT_TYPE

public static final EPMDocumentType CONTENT_TYPE

ECADHLIRESOURCE

private static final String ECADHLIRESOURCE

See Also:

Constant Field Values

design

private ECADDesign design

document

private EPMDocument document

assemblies

private HashMap assemblies

links

private HashMap links

targetRevision

private String targetRevision

folderCache

private Folder folderCache

describeBy

private Vector describeBy

Constructor Detail

ECADDocument

public ECADDocument(EPMDocument document)

Construst an ECADDocument with the given EPMDocument

Supported API: false

Method Detail

setDesign

public void setDesign(ECADDesign _design)

Set the ECADDesign for this assembly

Supported API: false

getDesign

public ECADDesign getDesign()

Get the ECADDesign for this assembly

Supported API: false

Returns:

ECADDesign

getNumber

public String getNumber()

Return the number of the ECADDocument

Supported API: true

Returns:

String - the number of the ECADDocument

getName

public String getName()

Return the name of the ECADDocument

Supported API: true

Returns:

String - the name of the ECADDocument

getDescription

public String getDescription()

Return the description of the ECADDocument

Supported API: true

Returns:

String - the description of the ECADDocument

setDescription

public void setDescription(String newDescription)
                    throws WTPropertyVetoException

Set the description of the ECADDocument

Supported API: true

Throws:

WTPropertyVetoException

getVersion

public String getVersion()

Return the version of the ECADDocument

Supported API: true

Returns:

String - the version of the ECADDocument

getIteration

public String getIteration()

Return the iteration of the ECADDocument

Supported API: true

Returns:

String - the iteration of the ECADDocument

getDocumentType

public String getDocumentType()

Return the Document Type of the ECADDocument

Supported API: true

Returns:

String - the Document Type of the ECADDocument

getAuthoringApplication

public String getAuthoringApplication()

Return the Authoring Application of the ECADDocument

Supported API: true

Returns:

String - the Authoring Application of the ECADDocument

getProjectName

public String getProjectName()

Return the project name of the ECADDocument

Supported API: true

Returns:

String - the project name of the ECADDocument

getLifeCycleName

public String getLifeCycleName()

Return the LifeCycle name of the ECADDocument

Supported API: true

Returns:

String - the LifeCycle name of the ECADDocument

getFolder

public Folder getFolder()

Return the Folder of the ECADDocument

Supported API: true

Returns:

Folder - the Folder of the ECADDocument

isPersistent

public boolean isPersistent()

Check the persisted status of the EPMDocument underlying the ECADDocument.

Supported API: true

Returns:

boolean - true if the document has been persisted

newECADDocument

public static ECADDocument newECADDocument(String number,
                                           String name,
                                           String authoringApp,
                                           String type,
                                           WTContainerRef containerRef)
                                    throws WTException

Factory method to construct a new ECADDocument from the number, name, authoringApplication and type.

Supported API: true

Throws:

IllegalArgumentException, - WTException

WTException

newECADDocument

public static ECADDocument newECADDocument(String number,
                                           String name,
                                           String authoringApp,
                                           String type,
                                           String revision,
                                           WTContainerRef containerRef)
                                    throws WTException

Factory method to construct a new ECADDocument from the number, name, authoringApplication, type and revision.

Supported API: true

Throws:

IllegalArgumentException, - WTException

WTException

getDocument

public static ECADDocument getDocument(String number,
                                       String version,
                                       WTContainerRef containerRef)
                                throws WTException

Static method to return the ECADDocument with the given number, version.

Supported API: true

Returns:

ECADDocument or null if non exists.

Throws:

IllegalArgumentException, - WTException

WTException

toString

public String toString()

Override of the toString method for outputting the ECADDocument

Supported API: false

Returns:

String - detailed contents of the ECADDocument

getEPMDocument

public EPMDocument getEPMDocument()

Get the EPMDocument associated with this ECADDocument

Supported API: false

Returns:

EPMDocument

addAssembly

public void addAssembly(ECADAssembly assembly)

Associate an ECADAssembly with this ECADDocument

Supported API: false

removeAssembly

public void removeAssembly(String assemblyNumber)

Remove the association between an ECADAssembly and this ECADDocument

Supported API: false

getAssembly

public ECADAssembly getAssembly(String assemblyNumber)

Get the numbered ECADAssembly associated with this ECADDocument

Supported API: false

Returns:

ECADAssembly

getAssemblies

public Collection getAssemblies()

Get a collection of all ECADAssemblies associated with this ECADDocument

Supported API: false

Returns:

Collection of ECADAssemblies

addLink

public void addLink(String number,
                    EPMDependencyLink link)

removeLink

public void removeLink(String number)

removeLink

public void removeLink(EPMDependencyLink link)

getLink

public EPMDependencyLink getLink(String number)

getLinks

public Collection getLinks()

getLinkIterator

public Iterator getLinkIterator()

getDescribeBy

public Vector getDescribeBy()

setDescribeBy

public void setDescribeBy(Vector describeByLinks)

update

public void update(EPMDocument document)

Update the EPMDocument associated with this ECADDocument

Supported API: false

getBranch

public long getBranch()

Get the Branch ID associated with this ECADDocument

Supported API: false

Returns:

long BranchIdentifier

lookupDocument

public static EPMDocument lookupDocument(String number,
                                         String version,
                                         WTContainerRef containerRef)
                                  throws WTException

Static method to return the EPMDocument with the given number, version.

Supported API: true

Returns:

EPMDocument or null if non exists.

Throws:

WTException

isLatestDocument

public static boolean isLatestDocument(String number,
                                       String version,
                                       WTContainerRef containerRef)
                                throws WTException

Throws:

WTException

getAttrValue

public Object getAttrValue(String attrDefName)
                    throws WTException

Get the value of the named Attribute associated with this ECADDocument

Supported API: true

Returns:

Object AttributeValue

Throws:

IllegalArgumentException, - WTException

WTException

setAttrValue

public void setAttrValue(String attrDefName,
                         Object newValue)
                  throws WTException

Set the value of the named Attribute associated with this ECADDocument

Supported API: true

Throws:

IllegalArgumentException, - WTException

WTException

deleteAttrValue

public void deleteAttrValue(String attrDefName)
                     throws WTException

Delete the value(s) of the named Attribute associated with this ECADDocument

Supported API: true

Throws:

IllegalArgumentException, - WTException

WTException

loadFileGroups

protected void loadFileGroups(HashSet hSet)
                       throws WTException

Throws:

WTException

getTeamTemplateName

protected String getTeamTemplateName()

Return the name of the Team Template for this ECADDocument

Supported API: false

Returns:

String - the name of the Team Template

setTeamTemplate

protected void setTeamTemplate(String templateName)
                        throws WTPropertyVetoException,
                               WTException

Throws:

WTPropertyVetoException

WTException

setLifeCycle

public void setLifeCycle(String lifeCycleName,
                         WTContainerRef containerRef)
                  throws WTPropertyVetoException,
                         WTException

Throws:

WTPropertyVetoException

WTException

getTargetRevision

public String getTargetRevision()

Return the target Revision for the CADDocument

Supported API: true

Returns:

String - the target Revision of the ECADDocument

setTargetRevision

public void setTargetRevision(String _targetRevision)

Set the target Revision of the CADDocument

Supported API: true

getDocFolderPath

public String getDocFolderPath()

Path of folder holding EPM documents.
E.g., /Administrator/ECAD/mydesign/Docs

Returns:

Full path to design's Doc folder

getOriginalFolder

private static Folder getOriginalFolder(EPMDocument doc)

Path of design's superfolder.
E.g., if the documents folder is /Administrator/ECAD/mydesign/Docs, this shall return /Administrator/ECAD

Returns:

Full path to design's superfolder

getTopFolderPath

public String getTopFolderPath()

getSolution

public String getSolution()

getContext

public String getContext()