com.vp.plugin

Interface ProjectManager

public interface ProjectManager

Manages the project (.vpp)

Method Summary

Modifier and Type	Method and Description
java.lang.String	addHtmlDocumentationImage(java.io.File aImageFile) Import image file into project.
java.lang.String	addHtmlDocumentationImage(java.io.InputStream aImageFile) Import image file into project.
java.lang.String	convertHighlightedTextWithReferenceModelName(java.lang.String aText)
java.lang.String	convertHighlightedTextWithReferenceModelName(java.lang.String aText, java.lang.String aModelNotFoundText) used for the text which supported in HighlightedTextArea (e.g.
java.lang.String	convertHighlightedTextWithStyleAsHTML(java.lang.String aText, boolean aKeepModelAsAddress)
java.lang.String	convertHighlightedTextWithStyleAsHTML(java.lang.String aText, boolean aKeepModelAsAddress, IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler)
java.lang.String	convertHighlightedTextWithStyleAsHTML(java.lang.String aText, boolean aKeepModelAsAddress, IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler, IReferenceModelPresentationOption aPresentationOption)
java.lang.String	convertHighlightedTextWithStyleAsHTML(java.lang.String aText, boolean aKeepModelAsAddress, IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler, IUseCaseDescriptionDiagramUIModel aUseCaseDetails)
java.lang.String	convertHighlightedTextWithStyleAsHTML(java.lang.String aText, boolean aKeepModelAsAddress, IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler, IUserStory aUserStory)
java.lang.String	convertHighlightedTextWithStyleAsHTML(java.lang.String aText, java.lang.String aModelNotFoundText, boolean aKeepModelAsAddress)
java.lang.String	convertHighlightedTextWithStyleAsHTML(java.lang.String aText, java.lang.String aModelNotFoundText, boolean aKeepModelAsAddress, IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler, IReferenceModelPresentationOption aPresentationOption)
java.lang.String	convertHighlightedTextWithStyleAsHTML(java.lang.String aText, java.lang.String aModelNotFoundText, boolean aKeepModelAsAddress, IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler, IUseCaseDescriptionDiagramUIModel aUseCaseDetails)
java.lang.String	convertHighlightedTextWithStyleAsHTML(java.lang.String aText, java.lang.String aModelNotFoundText, boolean aKeepModelAsAddress, IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler, IUserStory aUserStory)
ICandidateItemUtil	createCandidateItemUtil(ITextualAnalysisUIModel aDiagram)
IReferenceModelPresentationOption	createReferenceModelPresentationOption(IUseCaseDescriptionDiagramUIModel aUseCaseDescriptionDiagram) Used to decide how to show the Scenario's model element links, and its font size, and show/hide Testing Procedure
IReferenceModelPresentationOption	createReferenceModelPresentationOption(IUserStory aUserStory)
RelationshipRetriever	createRelationshipRetriever(IProject aCurrentProject) Create RelationshipRetriever for query the relationship of the selected model element in all relative projects.
RelationshipRetriever	createRelationshipRetriever(IProject aCurrentProject, java.lang.String aRelationshipModelType) Create RelationshipRetriever for query the relationship of the selected model element in all relative projects.
RelationshipRetriever	createRelationshipRetriever(IProject aCurrentProject, java.lang.String aRelationshipModelType, IProject[] aTargetRefProjects) Create RelationshipRetriever for query the relationship of the selected model element in current-project and target-ref-projects.
java.lang.String[]	getAllModelTypes(IProject project, boolean rootLevelOnly, boolean includeLinkedProject)
IRelationship[]	getAllRelationships(IModelElement aModelElement, IProject aCurrentProject) Deprecated. Replaced by createRelationshipRetriever(IProject) Time consume on retrieving relationships from reference projects. This function is replaced by RelationshipRetriever, that, RelationshipRetrieve can work for retrieving relationships from N model elements.
CandidateItemInText[]	getCandidateItemsFromText(ITextualAnalysisUIModel aDiagram, java.lang.String aText) Deprecated.
java.lang.String	getDisplayBusinessProcessId(IProject aProject, IDiagramUIModel aModel) Deprecated. Replaced by getDisplayUserId(IProject, IDiagramUIModel)
java.lang.String	getDisplayBusinessProcessId(IProject aProject, IModelElement aModel) Deprecated. Replaced by getDisplayUserId(IProject, IModelElement)
java.lang.String	getDisplayDataFlowId(IProject aProject, IModelElement aModel)
java.lang.String	getDisplayRequirementId(IProject aProject, IModelElement aModel) Deprecated. Replaced by getDisplayUserId(IProject, IModelElement)
java.lang.String	getDisplayUserId(IModelElement aModel)
java.lang.String	getDisplayUserId(IModelElement aModel, boolean aForceNonSubLevelId)
java.lang.String	getDisplayUserId(IProject aProject, IDiagramUIModel aModel)
java.lang.String	getDisplayUserId(IProject aProject, IModelElement aModel)
java.lang.String	getDisplayUserId(IProject aProject, IModelElement aModel, boolean aForceNonSubLevelId)
GlossaryInText[]	getGlossariesFromText(IProject aProject, boolean aIncludeLinkedProject, java.lang.String aText)
GlossaryInText[]	getGlossariesFromText(IProject aProject, java.lang.String aText) parse the text to retrieve the glossaries
java.lang.String	getLink(IDiagramElement diagramElement, boolean withName) Retrieve the link of the diagram element.
java.lang.String	getLink(IDiagramUIModel diagram, boolean withName) Retrieve the link of the diagram.
java.lang.String	getLink(IModelElement modelElement, boolean withName) Retrieve the link of the model element.
ILinkDiagramInfo	getLinkDiagramInfo(IReference aReference)
ModelElementInText[]	getModelElementsFromText(IProject aProject, java.lang.String aText)
IProject	getProject() Get the current project.
PropertyValueInText[]	getPropertyValuesFromText(IProject aProject, IDiagramUIModel aPropertyOwner, java.lang.String aText)
PropertyValueInText[]	getPropertyValuesFromText(IProject aProject, IModelElement aPropertyOwner, java.lang.String aText)
IModelElement[]	getSelectableStereotypesForModelType(java.lang.String aModelType, IProject aProject, boolean aSort)
java.lang.String	getShapeDisplayImagePath(java.io.File imageFile, java.lang.String aShapeType) calculate the displayImagePath (which will be embedded in .vpp)
java.lang.String	getTaggedValueType(ITaggedValue aTaggedValue) Retrieve the ITaggedValue.type as String.
java.lang.String	getTaggedValueType(ITaggedValueDefinition aTaggedValueDefinition) Retrieve the ITaggedValueDefinition.type as String.
void	importShapeDisplayImage(java.lang.String aDisplayImagePath, java.io.File aImageFile, IProject aProject) import the display image into project.
boolean	isBooleanEnumeration(ITaggedValue aTaggedValue) Check does the TaggedValue is a Boolean tagged value.
boolean	isBooleanEnumeration(ITaggedValueDefinition aTaggedValueDefinition) Check does the TaggedValueDefinition is a Boolean tagged value.
DatabaseSetting	loadDatabaseSetting(IProject aProject, DatabaseType aDatabaseType, DatabaseLanguage aLanguage) Read the Database Setting of the project
boolean	newProject()
boolean	openProject()
boolean	openProject(java.io.File file)
java.io.InputStream	readShapeDisplayImage(java.lang.String aDisplayImagePath, IProject aProject) read the display image from project.
java.lang.String	resetHtmlDocumentationFontStyle(java.lang.String htmlDocumentation, java.awt.Font font, java.awt.Color foreground) Reset the font style of a HTML description (documentation).
void	saveDatabaseSetting(IProject aProject, DatabaseType aDatabaseType, DatabaseLanguage aLanguage, DatabaseSetting aDatabaseSetting) Save the Database Setting into the project
boolean	saveProject()
boolean	saveProjectAs()
boolean	saveProjectAs(java.io.File file)
void	showTeamworkCommitDialog() Trigger teamwork commit
void	showTeamworkCommitDialog(java.awt.Component invoker) Trigger teamwork commit

Method Detail

getProject

IProject getProject()

Get the current project.

Returns:

current project

newProject

boolean newProject()

openProject

boolean openProject()

openProject

boolean openProject(java.io.File file)

saveProject

boolean saveProject()

saveProjectAs

boolean saveProjectAs()

saveProjectAs

boolean saveProjectAs(java.io.File file)

getAllModelTypes

java.lang.String[] getAllModelTypes(IProject project,
                                    boolean rootLevelOnly,
                                    boolean includeLinkedProject)

getDisplayBusinessProcessId

java.lang.String getDisplayBusinessProcessId(IProject aProject,
                                             IDiagramUIModel aModel)

Deprecated. Replaced by getDisplayUserId(IProject, IDiagramUIModel)

getDisplayUserId

java.lang.String getDisplayUserId(IProject aProject,
                                  IDiagramUIModel aModel)

getDisplayBusinessProcessId

java.lang.String getDisplayBusinessProcessId(IProject aProject,
                                             IModelElement aModel)

Deprecated. Replaced by getDisplayUserId(IProject, IModelElement)

getDisplayRequirementId

java.lang.String getDisplayRequirementId(IProject aProject,
                                         IModelElement aModel)

Deprecated. Replaced by getDisplayUserId(IProject, IModelElement)

getDisplayUserId

java.lang.String getDisplayUserId(IProject aProject,
                                  IModelElement aModel)

getDisplayUserId

java.lang.String getDisplayUserId(IModelElement aModel)

getDisplayUserId

java.lang.String getDisplayUserId(IProject aProject,
                                  IModelElement aModel,
                                  boolean aForceNonSubLevelId)

getDisplayUserId

java.lang.String getDisplayUserId(IModelElement aModel,
                                  boolean aForceNonSubLevelId)

getDisplayDataFlowId

java.lang.String getDisplayDataFlowId(IProject aProject,
                                      IModelElement aModel)

createRelationshipRetriever

RelationshipRetriever createRelationshipRetriever(IProject aCurrentProject)

Create RelationshipRetriever for query the relationship of the selected model element in all relative projects.

createRelationshipRetriever

RelationshipRetriever createRelationshipRetriever(IProject aCurrentProject,
                                                  java.lang.String aRelationshipModelType)

Create RelationshipRetriever for query the relationship of the selected model element in all relative projects.

Parameters:

aRelationshipModelType - collects the relationship(s) in this type only.

createRelationshipRetriever

RelationshipRetriever createRelationshipRetriever(IProject aCurrentProject,
                                                  java.lang.String aRelationshipModelType,
                                                  IProject[] aTargetRefProjects)

Create RelationshipRetriever for query the relationship of the selected model element in current-project and target-ref-projects.

Parameters:

aRelationshipModelType - collects the relationship(s) in this type only.

aTargetRefProjects - collects relationships from current project + these referenced projects only. NULL stands for collecting from all relative projects.

getAllRelationships

IRelationship[] getAllRelationships(IModelElement aModelElement,
                                    IProject aCurrentProject)

Deprecated. Replaced by createRelationshipRetriever(IProject) Time consume on retrieving relationships from reference projects. This function is replaced by RelationshipRetriever, that, RelationshipRetrieve can work for retrieving relationships from N model elements.

Retrieve the relationships (both FROM/TO, and SIMPLE/END-relationship) from the aModelElement, including current and reference projects.

getSelectableStereotypesForModelType

IModelElement[] getSelectableStereotypesForModelType(java.lang.String aModelType,
                                                     IProject aProject,
                                                     boolean aSort)

convertHighlightedTextWithReferenceModelName

java.lang.String convertHighlightedTextWithReferenceModelName(java.lang.String aText,
                                                              java.lang.String aModelNotFoundText)

used for the text which supported in HighlightedTextArea (e.g. FlowOfEvent's step/procedure/expectedResult)

convertHighlightedTextWithReferenceModelName

java.lang.String convertHighlightedTextWithReferenceModelName(java.lang.String aText)

convertHighlightedTextWithStyleAsHTML

java.lang.String convertHighlightedTextWithStyleAsHTML(java.lang.String aText,
                                                       java.lang.String aModelNotFoundText,
                                                       boolean aKeepModelAsAddress)

convertHighlightedTextWithStyleAsHTML

java.lang.String convertHighlightedTextWithStyleAsHTML(java.lang.String aText,
                                                       boolean aKeepModelAsAddress)

convertHighlightedTextWithStyleAsHTML

java.lang.String convertHighlightedTextWithStyleAsHTML(java.lang.String aText,
                                                       boolean aKeepModelAsAddress,
                                                       IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler)

convertHighlightedTextWithStyleAsHTML

java.lang.String convertHighlightedTextWithStyleAsHTML(java.lang.String aText,
                                                       boolean aKeepModelAsAddress,
                                                       IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler,
                                                       IUseCaseDescriptionDiagramUIModel aUseCaseDetails)

convertHighlightedTextWithStyleAsHTML

java.lang.String convertHighlightedTextWithStyleAsHTML(java.lang.String aText,
                                                       boolean aKeepModelAsAddress,
                                                       IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler,
                                                       IUserStory aUserStory)

convertHighlightedTextWithStyleAsHTML

java.lang.String convertHighlightedTextWithStyleAsHTML(java.lang.String aText,
                                                       boolean aKeepModelAsAddress,
                                                       IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler,
                                                       IReferenceModelPresentationOption aPresentationOption)

convertHighlightedTextWithStyleAsHTML

java.lang.String convertHighlightedTextWithStyleAsHTML(java.lang.String aText,
                                                       java.lang.String aModelNotFoundText,
                                                       boolean aKeepModelAsAddress,
                                                       IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler,
                                                       IUseCaseDescriptionDiagramUIModel aUseCaseDetails)

convertHighlightedTextWithStyleAsHTML

java.lang.String convertHighlightedTextWithStyleAsHTML(java.lang.String aText,
                                                       java.lang.String aModelNotFoundText,
                                                       boolean aKeepModelAsAddress,
                                                       IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler,
                                                       IUserStory aUserStory)

convertHighlightedTextWithStyleAsHTML

java.lang.String convertHighlightedTextWithStyleAsHTML(java.lang.String aText,
                                                       java.lang.String aModelNotFoundText,
                                                       boolean aKeepModelAsAddress,
                                                       IHighlightedTextWithStyleAsHtmlConvertHandler aConvertHandler,
                                                       IReferenceModelPresentationOption aPresentationOption)

createReferenceModelPresentationOption

IReferenceModelPresentationOption createReferenceModelPresentationOption(IUseCaseDescriptionDiagramUIModel aUseCaseDescriptionDiagram)

Used to decide how to show the Scenario's model element links, and its font size, and show/hide Testing Procedure

createReferenceModelPresentationOption

IReferenceModelPresentationOption createReferenceModelPresentationOption(IUserStory aUserStory)

getGlossariesFromText

GlossaryInText[] getGlossariesFromText(IProject aProject,
                                       java.lang.String aText)

parse the text to retrieve the glossaries

getGlossariesFromText

GlossaryInText[] getGlossariesFromText(IProject aProject,
                                       boolean aIncludeLinkedProject,
                                       java.lang.String aText)

getModelElementsFromText

ModelElementInText[] getModelElementsFromText(IProject aProject,
                                              java.lang.String aText)

getPropertyValuesFromText

PropertyValueInText[] getPropertyValuesFromText(IProject aProject,
                                                IModelElement aPropertyOwner,
                                                java.lang.String aText)

getPropertyValuesFromText

PropertyValueInText[] getPropertyValuesFromText(IProject aProject,
                                                IDiagramUIModel aPropertyOwner,
                                                java.lang.String aText)

getCandidateItemsFromText

CandidateItemInText[] getCandidateItemsFromText(ITextualAnalysisUIModel aDiagram,
                                                java.lang.String aText)

Deprecated.

createCandidateItemUtil

ICandidateItemUtil createCandidateItemUtil(ITextualAnalysisUIModel aDiagram)

addHtmlDocumentationImage

java.lang.String addHtmlDocumentationImage(java.io.File aImageFile)

Import image file into project. To be shown on model element's Documentation by the return String

Returns:

image path used to be shown on description (documentation)

See Also:

ViewManager.getDocumentationImagePaths(), ViewManager.getDocumentationImageInputStream(String)

addHtmlDocumentationImage

java.lang.String addHtmlDocumentationImage(java.io.InputStream aImageFile)

Import image file into project. To be shown on model element's Documentation by the return String

Returns:

image path used to be shown on description (documentation)

See Also:

ViewManager.getDocumentationImagePaths(), ViewManager.getDocumentationImageInputStream(String)

resetHtmlDocumentationFontStyle

java.lang.String resetHtmlDocumentationFontStyle(java.lang.String htmlDocumentation,
                                                 java.awt.Font font,
                                                 java.awt.Color foreground)

Reset the font style of a HTML description (documentation).

Parameters:

htmlDocumentation - the original description (documentation)

font - the new font will be applied to the description (documentation)

foreground - the new foreground color will be applied to the description (documentation)

Returns:

the new description (documentation) that applied the new font and foreground

See Also:

IModelElement.setHTMLDocumentation(String), IModelElement.setNickHTMLDocumentation(String), IModelElement.getHTMLDocumentation(), IModelElement.getNickHTMLDocumentation()

getShapeDisplayImagePath

java.lang.String getShapeDisplayImagePath(java.io.File imageFile,
                                          java.lang.String aShapeType)

calculate the displayImagePath (which will be embedded in .vpp)

Returns:

the DisplayImagePath which used to be set into IShapeUIModel.setDisplayImagePath(String)

importShapeDisplayImage

void importShapeDisplayImage(java.lang.String aDisplayImagePath,
                             java.io.File aImageFile,
                             IProject aProject)
                      throws java.lang.Exception

import the display image into project.

Throws:

java.lang.Exception

readShapeDisplayImage

java.io.InputStream readShapeDisplayImage(java.lang.String aDisplayImagePath,
                                          IProject aProject)
                                   throws java.lang.Exception

read the display image from project.

Throws:

java.lang.Exception

isBooleanEnumeration

boolean isBooleanEnumeration(ITaggedValue aTaggedValue)

Check does the TaggedValue is a Boolean tagged value.

Returns:

is Boolean tagged value?

isBooleanEnumeration

boolean isBooleanEnumeration(ITaggedValueDefinition aTaggedValueDefinition)

Check does the TaggedValueDefinition is a Boolean tagged value.

Returns:

is Boolean tagged value?

getTaggedValueType

java.lang.String getTaggedValueType(ITaggedValue aTaggedValue)

Retrieve the ITaggedValue.type as String.

Returns:

type showing in string.

getTaggedValueType

java.lang.String getTaggedValueType(ITaggedValueDefinition aTaggedValueDefinition)

Retrieve the ITaggedValueDefinition.type as String.

Returns:

type showing in string.

getLinkDiagramInfo

ILinkDiagramInfo getLinkDiagramInfo(IReference aReference)

getLink

java.lang.String getLink(IModelElement modelElement,
                         boolean withName)

Retrieve the link of the model element.

Returns:

link of model element

getLink

java.lang.String getLink(IDiagramElement diagramElement,
                         boolean withName)

Retrieve the link of the diagram element.

Returns:

link of diagram element

getLink

java.lang.String getLink(IDiagramUIModel diagram,
                         boolean withName)

Retrieve the link of the diagram.

Returns:

link of diagram

showTeamworkCommitDialog

void showTeamworkCommitDialog()

Trigger teamwork commit

showTeamworkCommitDialog

void showTeamworkCommitDialog(java.awt.Component invoker)

Trigger teamwork commit

Parameters:

the - component used to show dialog.

loadDatabaseSetting

DatabaseSetting loadDatabaseSetting(IProject aProject,
                                    DatabaseType aDatabaseType,
                                    DatabaseLanguage aLanguage)

Read the Database Setting of the project

saveDatabaseSetting

void saveDatabaseSetting(IProject aProject,
                         DatabaseType aDatabaseType,
                         DatabaseLanguage aLanguage,
                         DatabaseSetting aDatabaseSetting)

Save the Database Setting into the project