com.vp.plugin.model

Interface IProject

public interface IProject

Method Summary

Modifier and Type	Method and Description
AddLinkedProjectResult	addLinkedProject(java.io.File aLinkedProjectFile, java.awt.Component aInvoker) Add the linked project
boolean	addNickname(java.lang.String aNickname) Add a nickname into this project.
void	addProjectDiagramListener(IProjectDiagramListener listener)
void	addProjectListener(IProjectListener listener)
void	addProjectModelListener(IProjectModelListener listener)
int	allLevelModelElementCount()
int	allLevelModelElementCount(java.lang.String modelType)
java.util.Iterator	allLevelModelElementIterator() Retrieve root level model elements from project.
java.util.Iterator	allLevelModelElementIterator(java.lang.String modelType) Retrieve root level model elements from project.
java.util.Iterator	allLevelModelElementIterator(java.lang.String[] modelTypes) Retrieve root level model elements from project.
java.util.Iterator	diagramIterator()
void	disposeTransientModels()
java.lang.String	getCommentTableSortColumn()
IDiagramUIModel	getDiagramById(java.lang.String id)
IDiagramElement	getDiagramElementById(java.lang.String id)
java.lang.String	getId()
java.lang.String	getLanguage()
IProject[]	getLinkedProjects() Get the linked project
ILogicalView	getLogicalView() Get logical view of project.
IModelElement	getModelElementByAddress(java.lang.String aAddress)
IModelElement	getModelElementById(java.lang.String id)
java.lang.String	getName()
java.lang.String	getNickname() Retrieve the current nickname of this project.
java.lang.String[]	getNicknames() Retrieve nicknames defined in this project.
java.io.File	getProjectFile()
IProjectProperties	getProjectProperties()
java.lang.String	getProjectPublisherBasePath()
boolean	isCommentTableSortAscending()
boolean	isModelQualityBackgroundCheck()
boolean	isModified() To detect is the project being modified.
java.util.Iterator	modelElementIterator() Retrieve root level model elements from project.
java.util.Iterator	modelElementIterator(java.lang.String modelType) Retrieve root level model elements from project.
java.util.Iterator	modelElementIterator(java.lang.String[] modelTypes) Retrieve root level model elements from project.
boolean	removeLinkedProject(IProject aLinkedProject) Remove the linked project
void	removeProjectDiagramListener(IProjectDiagramListener listener)
void	removeProjectListener(IProjectListener listener)
void	removeProjectModelListener(IProjectModelListener listener)
void	setCommentTableSortAscending(boolean aCommentTableSortAscending)
void	setCommentTableSortColumn(java.lang.String aCommentTableSortColumn)
void	setName(java.lang.String name) Project renaming is a significant action and is not allowed to be done via API.
void	setNickname(java.lang.String aNickname) Switch the current nickname of this project.
void	setProjectPublisherBasePath(java.lang.String aBasePath)
IProjectTransaction	startProjectTransaction()
IModelElement[]	toAllLevelModelElementArray() Retrieve all level model elements from project.
IModelElement[]	toAllLevelModelElementArray(java.lang.String modelType) Retrieve all level model elements from project.
IModelElement[]	toAllLevelModelElementArray(java.lang.String[] modelTypes) Retrieve all level model elements from project.
IDiagramUIModel[]	toDiagramArray()
IModelElement[]	toModelElementArray() Retrieve root level model elements from project.
IModelElement[]	toModelElementArray(java.lang.String modelType) Retrieve root level model elements from project.
IModelElement[]	toModelElementArray(java.lang.String[] modelTypes) Retrieve root level model elements from project.
java.util.Iterator	transientAllLevelModelElementIterator()
java.util.Iterator	transientAllLevelModelElementIterator(java.lang.String modelType)

Method Detail

getId

java.lang.String getId()

setName

void setName(java.lang.String name)
      throws java.lang.UnsupportedOperationException

Project renaming is a significant action and is not allowed to be done via API. Please perform renaming through Visual Paradigm's user interface. Make sure you (or any team member else who want to rename project) has 'Update Project' administrator right granted.

Throws:

java.lang.UnsupportedOperationException - if renaming a Teamwork Project.

getName

java.lang.String getName()

getProjectProperties

IProjectProperties getProjectProperties()

getProjectFile

java.io.File getProjectFile()

isModified

boolean isModified()

To detect is the project being modified.

getNicknames

java.lang.String[] getNicknames()

Retrieve nicknames defined in this project. An example on how to create nickname can be found at http://knowhow.visual-paradigm.com/?p=2234

Returns:

the nicknames defined in this project.

addNickname

boolean addNickname(java.lang.String aNickname)

Add a nickname into this project. An example on how to create nickname can be found at http://knowhow.visual-paradigm.com/?p=2234

Parameters:

aNickname - the nickname will be added into this project.

Returns:

false means the aNickname already exists before adding nickname.

setNickname

void setNickname(java.lang.String aNickname)

Switch the current nickname of this project. An example on how to create nickname can be found at http://knowhow.visual-paradigm.com/?p=2234

Parameters:

aNickname - nickname will be switched to.

getNickname

java.lang.String getNickname()

Retrieve the current nickname of this project. An example on how to create nickname can be found at http://knowhow.visual-paradigm.com/?p=2234

Returns:

the current nickname of this project.

getLanguage

java.lang.String getLanguage()

getModelElementByAddress

IModelElement getModelElementByAddress(java.lang.String aAddress)

getModelElementById

IModelElement getModelElementById(java.lang.String id)

modelElementIterator

java.util.Iterator modelElementIterator()

Retrieve root level model elements from project.

Returns:

root level model elements

modelElementIterator

java.util.Iterator modelElementIterator(java.lang.String modelType)

Retrieve root level model elements from project.

Parameters:

modelType - type of model element to retrieve

Returns:

root level model elements

modelElementIterator

java.util.Iterator modelElementIterator(java.lang.String[] modelTypes)

Retrieve root level model elements from project.

Parameters:

modelTypes - types of model elements to retrieve

Returns:

root level model elements

toModelElementArray

IModelElement[] toModelElementArray()

Retrieve root level model elements from project.

Returns:

root level model elements

toModelElementArray

IModelElement[] toModelElementArray(java.lang.String modelType)

Retrieve root level model elements from project.

Parameters:

modelType - type of model element to retrieve

Returns:

root level model elements

toModelElementArray

IModelElement[] toModelElementArray(java.lang.String[] modelTypes)

Retrieve root level model elements from project.

Parameters:

modelTypes - types of model elements to retrieve

Returns:

root level model elements

allLevelModelElementIterator

java.util.Iterator allLevelModelElementIterator()

Retrieve root level model elements from project.

Returns:

root level model elements

allLevelModelElementIterator

java.util.Iterator allLevelModelElementIterator(java.lang.String modelType)

Retrieve root level model elements from project.

Parameters:

modelType - type of model element to retrieve

Returns:

root level model elements

allLevelModelElementIterator

java.util.Iterator allLevelModelElementIterator(java.lang.String[] modelTypes)

Retrieve root level model elements from project.

Parameters:

modelTypes - types of model elements to retrieve

Returns:

root level model elements

transientAllLevelModelElementIterator

java.util.Iterator transientAllLevelModelElementIterator()

transientAllLevelModelElementIterator

java.util.Iterator transientAllLevelModelElementIterator(java.lang.String modelType)

disposeTransientModels

void disposeTransientModels()

toAllLevelModelElementArray

IModelElement[] toAllLevelModelElementArray()

Retrieve all level model elements from project.

Returns:

model elements of the project

toAllLevelModelElementArray

IModelElement[] toAllLevelModelElementArray(java.lang.String modelType)

Retrieve all level model elements from project.

Parameters:

modelType - type of model element to retrieve

Returns:

model elements of the project

toAllLevelModelElementArray

IModelElement[] toAllLevelModelElementArray(java.lang.String[] modelTypes)

Retrieve all level model elements from project.

Parameters:

modelTypes - types of model elements to retrieve

Returns:

model elements of the project

allLevelModelElementCount

int allLevelModelElementCount()

allLevelModelElementCount

int allLevelModelElementCount(java.lang.String modelType)

getDiagramById

IDiagramUIModel getDiagramById(java.lang.String id)

diagramIterator

java.util.Iterator diagramIterator()

toDiagramArray

IDiagramUIModel[] toDiagramArray()

getDiagramElementById

IDiagramElement getDiagramElementById(java.lang.String id)

addProjectListener

void addProjectListener(IProjectListener listener)

removeProjectListener

void removeProjectListener(IProjectListener listener)

addProjectModelListener

void addProjectModelListener(IProjectModelListener listener)

removeProjectModelListener

void removeProjectModelListener(IProjectModelListener listener)

addProjectDiagramListener

void addProjectDiagramListener(IProjectDiagramListener listener)

removeProjectDiagramListener

void removeProjectDiagramListener(IProjectDiagramListener listener)

getLinkedProjects

IProject[] getLinkedProjects()

Get the linked project

addLinkedProject

AddLinkedProjectResult addLinkedProject(java.io.File aLinkedProjectFile,
                                        java.awt.Component aInvoker)

Add the linked project

Parameters:

aInvoker - component used to show progress dialog, etc.... Not allow null, if no component, please use ViewManager.getRootFrame().

Returns:

success or failed?

removeLinkedProject

boolean removeLinkedProject(IProject aLinkedProject)

Remove the linked project

setCommentTableSortColumn

void setCommentTableSortColumn(java.lang.String aCommentTableSortColumn)

getCommentTableSortColumn

java.lang.String getCommentTableSortColumn()

setCommentTableSortAscending

void setCommentTableSortAscending(boolean aCommentTableSortAscending)

isCommentTableSortAscending

boolean isCommentTableSortAscending()

setProjectPublisherBasePath

void setProjectPublisherBasePath(java.lang.String aBasePath)

getProjectPublisherBasePath

java.lang.String getProjectPublisherBasePath()

isModelQualityBackgroundCheck

boolean isModelQualityBackgroundCheck()

getLogicalView

ILogicalView getLogicalView()

Get logical view of project. For more details, please refer to http://knowhow.visual-paradigm.com/?p=3860

Parameters:

logical - view of project.

startProjectTransaction

IProjectTransaction startProjectTransaction()