Package jetbrains.mps.project

Class ProjectRepository

java.lang.Object

jetbrains.mps.extapi.module.SRepositoryBase

jetbrains.mps.project.ProjectRepository

All Implemented Interfaces:

SRepositoryExt, ReferenceScopeHelper.Source, SRepository

public class ProjectRepository
extends SRepositoryBase
implements SRepositoryExt, ReferenceScopeHelper.Source

Repository with modules visible in MPS project. IMPORTANT! For the time being, all modules available in this MPS instance are exposed through this repository, although as we move forward with multiple projects story, this convention shall change. Likely, we'll expose modules of the project and all its imports/libraries (and won't expose modules of other opened projects), though this is not yet final. Currently delegates almost everything to the ugly singleton MPSModuleRepository. Keeps own list of listeners and sends out own notifications about modules added/removed (i.e. module added to the global repository triggers moduleAdded for for both global and each project repository

Constructor Summary

Constructors

Constructor	Description
ProjectRepository(Project project, SRepositoryExt rootRepo, SRepositoryRegistry repositoryRegistry)
ProjectRepository(Project project, SRepositoryExt rootRepo, SRepositoryRegistry repositoryRegistry, ModelAccess projectModelAccess)

Method Summary

Modifier and Type	Method	Description
void	addRepositoryListener(SRepositoryListener listener)	Register a listener for the repository.
ModelAccess	getModelAccess()
SModule	getModule(SModuleId ref)
Iterable<SModule>	getModules()	Returns an unmodifiable collection of modules.
Set<SModule>	getModules(MPSModuleOwner moduleOwner)
Set<MPSModuleOwner>	getOwners(SModule module)
Project	getProject()
ReferenceScopeHelper	getReferenceScopeHelper()
<T extends SModule> T	registerModule(T module, MPSModuleOwner owner)	Need register/unregister API for modules because at the moment registration goes through static instance of MPSModuleRepository.
void	removeRepositoryListener(SRepositoryListener listener)	Remove a listener.
void	saveAll()
void	unregisterModule(SModule module, MPSModuleOwner owner)	Unregisters given module only (e.g.

Methods inherited from class jetbrains.mps.extapi.module.SRepositoryBase

dispose, fireBeforeModuleRemoved, fireCommandFinished, fireCommandStarted, fireModuleAdded, fireModuleRemoved, getParent, getRepositoryAccess, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jetbrains.mps.openapi.module.SRepository

getParent, getRepositoryAccess

Constructor Detail

ProjectRepository

public ProjectRepository(@NotNull
                         Project project,
                         @NotNull
                         SRepositoryExt rootRepo,
                         @Nullable
                         SRepositoryRegistry repositoryRegistry)

ProjectRepository

public ProjectRepository(@NotNull
                         Project project,
                         @NotNull
                         SRepositoryExt rootRepo,
                         @Nullable
                         SRepositoryRegistry repositoryRegistry,
                         @NotNull
                         ModelAccess projectModelAccess)

Method Detail

getProject

public Project getProject()

getModule

public SModule getModule(@NotNull
                         SModuleId ref)

Specified by:

getModule in interface SRepository

Returns:

the module which id is equal to the given module id. A repository is able to have only one module for a given module id. null is returned iff there is no such module in the repository

getModules

@NotNull
public Iterable<SModule> getModules()

Description copied from interface: SRepository

Returns an unmodifiable collection of modules.

Specified by:

getModules in interface SRepository

getModelAccess

@NotNull
public ModelAccess getModelAccess()

Specified by:

getModelAccess in interface SRepository

Returns:

a special class which yields a control to the objects which comprise the repository. These are namely modules, models, model roots, nodes.

saveAll

public void saveAll()

Specified by:

saveAll in interface SRepository

registerModule

public <T extends SModule> T registerModule(@NotNull
                                            T module,
                                            @NotNull
                                            MPSModuleOwner owner)

Description copied from interface: SRepositoryExt

Need register/unregister API for modules because at the moment registration goes through static instance of MPSModuleRepository. Not an API right away due to (a) MPSModuleOwner is not an API; (b) not certain whether we shall have separate 'editable' SRepository interface (like EditableSModel), which sounds rather stupid but it's the way it runs in the rest of MPS, or the API shall become part of SRepository, but this rises a question if the API shall fail in a harsh or silent way for repositories that do not support change (c) I don't like return value for the method, but it's the way MPSModuleRepository have it. I don't quite buy "single module in a repo, with multiple *owners*" story. If it's truly needed, we could accomplish the same with register(getModule(moduleRef), anotherOwner), rather than return value Promise: once returns, module is attached to the repository MPSModuleRepository.registerModule(SModule, MPSModuleOwner)

Specified by:

registerModule in interface SRepositoryExt

unregisterModule

public void unregisterModule(@NotNull
                             SModule module,
                             @NotNull
                             MPSModuleOwner owner)

Description copied from interface: SRepositoryExt

Unregisters given module only (e.g. in case of a language, it's not repository responsibility to care about language generators)

Specified by:

unregisterModule in interface SRepositoryExt

See Also:

If to persist, shall describe the contract, e.g. what happens when a module doesn't belong to a repo or is not associated with the supplied owner

getOwners

public Set<MPSModuleOwner> getOwners(@NotNull
                                     SModule module)

Specified by:

getOwners in interface SRepositoryExt

getModules

public Set<SModule> getModules(MPSModuleOwner moduleOwner)

Specified by:

getModules in interface SRepositoryExt

addRepositoryListener

public void addRepositoryListener(@NotNull
                                  SRepositoryListener listener)

Description copied from interface: SRepository

Register a listener for the repository. If a listener is SRepositoryAttachListener, it gets additionally notified and can perform own initialization (e.g. handle modules already in the repository)

Specified by:

addRepositoryListener in interface SRepository

Overrides:

addRepositoryListener in class SRepositoryBase

removeRepositoryListener

public void removeRepositoryListener(@NotNull
                                     SRepositoryListener listener)

Description copied from interface: SRepository

Remove a listener. If a listener is SRepositoryAttachListener, it is notified of detach event.

Specified by:

removeRepositoryListener in interface SRepository

Overrides:

removeRepositoryListener in class SRepositoryBase

getReferenceScopeHelper

public ReferenceScopeHelper getReferenceScopeHelper()

Specified by:

getReferenceScopeHelper in interface ReferenceScopeHelper.Source