org.ucworkbench.model
Interface IUCProject

All Superinterfaces:
IIdentifiable, IUCElement

public interface IUCProject
extends IUCElement, IIdentifiable

This interface is used to represent whole UC Workbench project and it's functionality. UC Workbench provides an adapter factory, so you can get adapt IProject to this interface (only for projects with

See Also:
org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)

Method Summary
 void addModelChangeListener(IModelChangedListener listener)
          Registers
 void finishValidationCaching()
          Finishes the validation caching phase of loading model objects.
 IAliasRepository getAliasRepository()
          Returns Alias Repository for current UC Project.
 IModelFileElement getIFileElementByAlias(java.lang.String elementAlias)
          Returns an
 IProject getIProject()
          Returns corresponding project resource
 IProjectFoldersProvider getProjectFolders()
          Returns object providing information about folder structure in the project
 IProjectInfoProvider getProjectInfo()
          Returns object providing basic information of the project, e.g. project name, customer name...
 IReferencesRepository getReferencesRepository()
          Returns References Repository for current UC Project.
 IRequirementsFolder getRequirementsFolder()
          Returns the folder containing all base requirements artifacts such as use cases, actor definitions, etc.
 ResourceSet getResourceSet()
          Returns a common resource set instance for the whole project.
 org.ucworkbench.model.UCElementType getResourceType(IResource resource)
          Returns type of the resource provided as parameter.
 IScreenFolder getScreenFolder()
          Returns folder containing all application screen sketches.
 ITemplatesFolder getTemplatesFolder()
          Returns folder containing templates for Artifact Generator.
 ITestsFolder getTestsFolder()
          Returns the folder containing all test artifacts such as test cases, etc.
 IUCElement getUCElementByIResource(IResource resource)
          Returns a IUCElement object for specified resource.
 IFileModel parseFileElement(IModelFileElement element)
          This method returns actual
 void removeModelChangeListener(IModelChangedListener listener)
          Unregisters
 void startValidationCaching()
          This mechanism enables freezing of full validation of artifacts during builds.
 void unregisterModel(IFile file)
          Deletes the reference to specified file in UC Project cache.
 
Methods inherited from interface org.ucworkbench.model.IIdentifiable
getID
 

Method Detail

getIProject

IProject getIProject()
Returns corresponding project resource

Returns:

addModelChangeListener

void addModelChangeListener(IModelChangedListener listener)
Registers

Parameters:
listener -

removeModelChangeListener

void removeModelChangeListener(IModelChangedListener listener)
Unregisters

Parameters:
listener -

getIFileElementByAlias

IModelFileElement getIFileElementByAlias(java.lang.String elementAlias)
Returns an

Parameters:
elementAlias - alias to be searched
Returns:
corresponding IFileModel object or null if alias was not found
See Also:
IFileModel.getAliases()

getUCElementByIResource

IUCElement getUCElementByIResource(IResource resource)
Returns a IUCElement object for specified resource. This method can return IUCProject, one of the folder objects, Actor, UseCase, etc. Uses Eclipse adaptation mechanism to obtain objects.

Parameters:
resource - resource for which the element will be found
Returns:
null if no model object can be adapted
See Also:
org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)

parseFileElement

IFileModel parseFileElement(IModelFileElement element)
This method returns actual

Parameters:
element -
Returns:
null if the corresponding file cannot be parsed or its type is not recognized

unregisterModel

void unregisterModel(IFile file)
Deletes the reference to specified file in UC Project cache.

Parameters:
file - resource file

getRequirementsFolder

IRequirementsFolder getRequirementsFolder()
Returns the folder containing all base requirements artifacts such as use cases, actor definitions, etc.

Returns:
requirements folder or null if it is impossible to obtain requirements folder property from the UC Project.

getTestsFolder

ITestsFolder getTestsFolder()
Returns the folder containing all test artifacts such as test cases, etc.

Returns:
tests folder or null if it is impossible to obtain test folder property from the UC Project.

getTemplatesFolder

ITemplatesFolder getTemplatesFolder()
Returns folder containing templates for Artifact Generator.

Returns:
templates folder or null if it is impossible to obtain templates folder property from the UC Project.

getScreenFolder

IScreenFolder getScreenFolder()
Returns folder containing all application screen sketches.

Returns:
screens folder or null if it is impossible to obtain screens folder property from the UC Project.

getResourceType

org.ucworkbench.model.UCElementType getResourceType(IResource resource)
Returns type of the resource provided as parameter.

Parameters:
resource - Eclipse IResource object
Returns:

getReferencesRepository

IReferencesRepository getReferencesRepository()
Returns References Repository for current UC Project.

Returns:
references repository
See Also:
IReferencesRepository

getAliasRepository

IAliasRepository getAliasRepository()
Returns Alias Repository for current UC Project.

Returns:
alias repository
See Also:
IAliasRepository

getProjectInfo

IProjectInfoProvider getProjectInfo()
Returns object providing basic information of the project, e.g. project name, customer name...

Returns:
project information provider
See Also:
IProjectInfoProvider

getProjectFolders

IProjectFoldersProvider getProjectFolders()
Returns object providing information about folder structure in the project

Returns:
project folders provider

startValidationCaching

void startValidationCaching()
This mechanism enables freezing of full validation of artifacts during builds. It is necessary to postpone some validations (e.g. reference target checking) until all artifacts has been parsed and alias repository updated. All models loaded during validation cachcing phase are fully validated immediately after calling


finishValidationCaching

void finishValidationCaching()
Finishes the validation caching phase of loading model objects. All models loaded during validation cachcing phase are fully validated immediately.


getResourceSet

ResourceSet getResourceSet()
Returns a common resource set instance for the whole project. It is used by EMF models (such as testing models).

Returns: