Package org.jetbrains.mps.openapi.module

Interface SRepository

public interface SRepository

A storage for modules. One might think of it as an actual mapping between SModuleId module ids (which act as keys in the mapping) and SModule modules themselves. SRepository gains a special access class which gives out a read/write locks to the repository objects.

See Also:

REPOSITORY STRUCTURE There can be multiple repositories available. Given a repository, references to modules/models/nodes can be resolved. There's no need in making ids unique globally as each subsystem knows, which exact repository it needs to use at any moment. (e.g. the type-system knows where it stores its type-nodes, so it will not try to resolve references to them ) A repository contains modules, modules have model roots, each model root can load models. Also module can be a models container itself (without model root). A model is then a set of "root" nodes. Each "root" node is a root of a tree of nodes. So that overall, repository is a tree structure. repository -module1 model root 1 model1 root_node_1 child_node_1 child_node_1_1 child_node2 model root 2 Relations between different repositories is in a 'work-in-progress' state at the moment.

Method Summary

Modifier and Type	Method	Description
void	addRepositoryListener(SRepositoryListener listener)	Register a listener for the repository.
default SModel	getModel(SModelId modelId)	Support SModelReference.resolve(SRepository) mechanism for models that don't bear module identity as part of their reference (aka 'globally unique' model identity, SModelId.isGloballyUnique()).
ModelAccess	getModelAccess()
SModule	getModule(SModuleId moduleId)
Iterable<SModule>	getModules()	Returns an unmodifiable collection of modules.
SRepository	getParent()	Deprecated.
RepositoryAccess	getRepositoryAccess()	Deprecated.
void	removeRepositoryListener(SRepositoryListener listener)	Remove a listener.
void	saveAll()

Method Detail

getParent

@Deprecated
SRepository getParent()

Deprecated.

getModule

@Nullable
SModule getModule(@NotNull
                  SModuleId moduleId)

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

getModel

@Nullable
default SModel getModel(@NotNull
                        SModelId modelId)

Support SModelReference.resolve(SRepository) mechanism for models that don't bear module identity as part of their reference (aka 'globally unique' model identity, SModelId.isGloballyUnique()).

Parameters:

modelId - global identity of a model SModelId.isGloballyUnique() shall be true

Returns:

model in this repository with the given global identity, or null of none found or supplied id is not unique one.

getModules

@NotNull
Iterable<SModule> getModules()

Returns an unmodifiable collection of modules.

getModelAccess

@NotNull
ModelAccess getModelAccess()

Returns:

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

getRepositoryAccess

@Deprecated
RepositoryAccess getRepositoryAccess()

Deprecated.

saveAll

void saveAll()

addRepositoryListener

void addRepositoryListener(@NotNull
                           SRepositoryListener listener)

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)

removeRepositoryListener

void removeRepositoryListener(@NotNull
                              SRepositoryListener listener)

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