Package jetbrains.mps.persistence

Class DefaultModelRoot

java.lang.Object

jetbrains.mps.extapi.persistence.ModelRootBase

jetbrains.mps.extapi.persistence.FileBasedModelRoot

jetbrains.mps.persistence.DefaultModelRoot

All Implemented Interfaces:

CopyableModelRoot<DefaultModelRoot>, FileListener, FileSystemListener, ModelRoot

public class DefaultModelRoot
extends FileBasedModelRoot
implements CopyableModelRoot<DefaultModelRoot>

This model root is responsible for loading models from the source roots as well as for creating models and register them in itself. It looks for DataSourceFactoryFromName and DataSourceFactoryFromURL instances through the DataSourceFactoryRuleService and finds proper ModelFactory instances via the ModelFactoryRegistry data source kind to model factory association. See a variety of model creation methods below. See collectModels(SourceRoot) for traversing logic of this model root. It is used by MPS to store all the kinds of models (except the java sources and classes stubs) -- therefore the poor naming. PLAN: It makes sense to unite this concept with other file-system-based model root concepts. Probably it is going to be transformed into a single FileSystemModelRoot entity which will be suitable for any model storage system which has a tree-like storage.

Since:

11/9/12

Field Summary

Fields inherited from class jetbrains.mps.extapi.persistence.FileBasedModelRoot

CONTENT_PATH, EXCLUDED, LOCATION, SOURCE_ROOTS

Constructor Summary

Constructors

Constructor	Description
DefaultModelRoot()	Deprecated. Use createDescriptor(IFile, IFile...) if you need to populate ModuleDescriptor.

Method Summary

Modifier and Type	Method	Description
boolean	canCreateModel(String modelName)
boolean	canCreateModels()	There are model roots which are read-only and fix the result of ModelRoot.getModels() right away from the construction FIXME it is strange to have two similar methods: we are better to merge this method into the method ModelRoot.canCreateModel(java.lang.String).
void	copyTo(DefaultModelRoot targetModelRoot)	Copies this model root contents to the targetModelRoot.
static ModelRootDescriptor	createDescriptor(IFile contentRoot, IFile... modelDir)	Build a descriptor that could be added to a ModuleDescriptor to facilitate instantiation of a model root of this specific type when a module loads.
SModel	createFileModel(String modelName, SourceRoot sourceRoot)	Creates a new file based model in the default source root.
SModel	createModel(String modelName)	Creates model in the default source root via default factory
SModel	createModel(SModelName modelName, SourceRoot sourceRoot, DataSourceFactoryFromName dataSourceFactory, ModelFactory modelFactory)	Creates a new model via given factory with given name and under the provided sourceRoot in this ModelRoot.
SModel	createModel(SModelName modelName, SourceRoot sourceRoot, DataSourceType dataSourceType, ModelFactoryType modelFactoryType)	Creates a new model via given factory with given name and under the provided sourceRoot in this ModelRoot.
SModel	createPerRootModel(String modelName, SourceRoot sourceRoot)	Creates a new folder-based (per-root by default) model in the default source root.
static ModelRootDescriptor	createSingleFolderDescriptor(IFile modelDir)	Same as createDescriptor(IFile, IFile...) limited to a single location with source model files
SModel	getModel(SModelId id)
List<SourceRootKind>	getSupportedFileKinds1()	To become abstract in the 3.5
String	getType()	A customizable categorization identifier, such as JavaStubs
Iterable<SModel>	loadModels()	returns all models under the model root if some model is already loaded and registered, it is recommended to return the loaded one instead of loading another time
void	rename(FileDataSource dataSource, String newName)
ModelRootDescriptor	toDescriptor()	Deprecated.

Methods inherited from class jetbrains.mps.extapi.persistence.FileBasedModelRoot

addFile, addSourceRoot, attach, containsFile, deleteFile, dispose, equals, getContentDirectory, getContentRoot, getFiles, getFileSystem, getFileToListen, getPresentation, getSourceRoots, getSupportedFileKinds, hashCode, load, relativize, relativize, removeSourceRoot, save, setContentDirectory, setContentRoot, update

Methods inherited from class jetbrains.mps.extapi.persistence.ModelRootBase

assertCanChange, assertCanRead, getModels, getModule, getRepository, isRegistered, registerModel, setModule, toString, update

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jetbrains.mps.vfs.refresh.FileListener

listeningPreferences

Methods inherited from interface jetbrains.mps.vfs.refresh.FileSystemListener

getListenerDependencies

Constructor Detail

DefaultModelRoot

@Deprecated
public DefaultModelRoot()

Deprecated.

Use createDescriptor(IFile, IFile...) if you need to populate ModuleDescriptor. Proper cons (package-local) shall get invoked from ModelRootFactory only.

FIXME must be made package-local or protected (as long as there's subclass) FIXME one must have either factory creation or a public constructor not both [AP]

Method Detail

getSupportedFileKinds1

@NotNull
public List<SourceRootKind> getSupportedFileKinds1()

Description copied from class: FileBasedModelRoot

To become abstract in the 3.5

Overrides:

getSupportedFileKinds1 in class FileBasedModelRoot

getType

public String getType()

Description copied from interface: ModelRoot

A customizable categorization identifier, such as JavaStubs

Specified by:

getType in interface ModelRoot

getModel

public SModel getModel(@NotNull
                       SModelId id)

Specified by:

getModel in interface ModelRoot

Returns:

the model with a given id one-to-one relation is assumed

loadModels

@NotNull
public Iterable<SModel> loadModels()

Description copied from class: ModelRootBase

returns all models under the model root if some model is already loaded and registered, it is recommended to return the loaded one instead of loading another time

Specified by:

loadModels in class ModelRootBase

Returns:

a sequence of models

canCreateModels

public boolean canCreateModels()

Description copied from interface: ModelRoot

There are model roots which are read-only and fix the result of ModelRoot.getModels() right away from the construction FIXME it is strange to have two similar methods: we are better to merge this method into the method ModelRoot.canCreateModel(java.lang.String).

Specified by:

canCreateModels in interface ModelRoot

Overrides:

canCreateModels in class ModelRootBase

Returns:

whether this model root is read-only in the way described above

canCreateModel

public boolean canCreateModel(@NotNull
                              String modelName)

Specified by:

canCreateModel in interface ModelRoot

Parameters:

modelName - -- the same as in the ModelRoot.createModel(String)

Returns:

whether a model with a name modelName can be created under this model root.

createModel

@Nullable
public SModel createModel(@NotNull
                          String modelName)

Creates model in the default source root via default factory

Specified by:

createModel in interface ModelRoot

Parameters:

modelName - -- might fq name or just simple short model name. Up to implementor

Returns:

null if there was IOException

See Also:

DefaultModelRoot.Defaults.sourceRoot(jetbrains.mps.extapi.persistence.FileBasedModelRoot)

createPerRootModel

@Nullable
public SModel createPerRootModel(@NotNull
                                 String modelName,
                                 @Nullable
                                 SourceRoot sourceRoot)
                          throws ModelCannotBeCreatedException

Creates a new folder-based (per-root by default) model in the default source root.

Returns:

null if there was IOException

Throws:

ModelCannotBeCreatedException

See Also:

DefaultModelRoot.Defaults

createFileModel

@Nullable
public SModel createFileModel(@NotNull
                              String modelName,
                              @Nullable
                              SourceRoot sourceRoot)
                       throws ModelCannotBeCreatedException

Creates a new file based model in the default source root.

Returns:

null if there was IOException

Throws:

ModelCannotBeCreatedException

See Also:

DefaultModelRoot.Defaults

createModel

@NotNull
public SModel createModel(@NotNull
                          SModelName modelName,
                          @Nullable
                          SourceRoot sourceRoot,
                          @Nullable
                          DataSourceType dataSourceType,
                          @Nullable
                          ModelFactoryType modelFactoryType)
                   throws ModelCannotBeCreatedException

Creates a new model via given factory with given name and under the provided sourceRoot in this ModelRoot. Whenever the parameter is null the default one is used.

Throws:

ModelCannotBeCreatedException

createModel

@NotNull
public SModel createModel(@NotNull
                          SModelName modelName,
                          @Nullable
                          SourceRoot sourceRoot,
                          @Nullable
                          DataSourceFactoryFromName dataSourceFactory,
                          @Nullable
                          ModelFactory modelFactory)
                   throws ModelCannotBeCreatedException

Creates a new model via given factory with given name and under the provided sourceRoot in this ModelRoot. Whenever the parameter is null the default one is used. The most 'heavy' method (parameter-wise):

Parameters:

modelName - -- controls the name of the new model

sourceRoot - -- the source root to create the new model in

dataSourceFactory - -- data source factory which method DataSourceFactoryFromName.create(SModelName, SourceRoot) is going to be used to create a new data source from the given model name and source root

modelFactory - -- model factory which defines the persisting strategy of the new model. Note that modelFactory is independent enough from the dataSourceFactory and data sources it creates.

Returns:

new SModel instance with the given name, generated data source lying under the source root, registered in this model root which is created via the given modelFactory

Throws:

ModelCannotBeCreatedException

See Also:

DefaultModelRoot.Defaults

rename

public void rename(FileDataSource dataSource,
                   String newName)
            throws DataSourceFactoryNotFoundException,
                   NoSourceRootsInModelRootException,
                   SourceRootDoesNotExistException

Throws:

DataSourceFactoryNotFoundException

NoSourceRootsInModelRootException

SourceRootDoesNotExistException

copyTo

public void copyTo(@NotNull
                   DefaultModelRoot targetModelRoot)
            throws CopyNotSupportedException

Description copied from interface: CopyableModelRoot

Copies this model root contents to the targetModelRoot. the resulting model root must be equal to the prototype

Specified by:

copyTo in interface CopyableModelRoot<DefaultModelRoot>

Throws:

CopyNotSupportedException

toDescriptor

@Deprecated
public ModelRootDescriptor toDescriptor()

Deprecated.

Obviously whilst the model root descriptors are in the AbstractModule we need this method

createDescriptor

@NotNull
public static ModelRootDescriptor createDescriptor(@NotNull
                                                   IFile contentRoot,
                                                   IFile... modelDir)

Build a descriptor that could be added to a ModuleDescriptor to facilitate instantiation of a model root of this specific type when a module loads. With ModelRootDescriptor/ModuleDescriptor being a mechanism to create/update SModule information, we need a way to construct a descriptor that would end up as DefaultModelRoot. Since there's no relevant API in ModelRootDescriptor itself (which is questionable btw, provided approach for Language/Generator/Solution module descriptor is different), and exposing Memento keys of this root implementation is bad, these factory methods give an way to construct descriptor for most common scenarios. Present approach is that ModelRootDescriptor controls nothing and accepts plain strings, while objects like ModelRootDescriptor/ModuleDescriptor deal with files. DefaultModelRoot is initialized with MRD and constraints/manipulates low-level persistence data. From that perspective the right way to create ModelRootDescriptor is to configure it with plain strings. OTOH, in many cases we've got IFile already, and it looks odd to go to strings when IFile is handy. Besides, need to be very careful to mangle strings properly to place sourceRoots relative to content root without using IFile/File objects. FIXME Perhaps, need a similar method with String parameters to satisfy both worlds?

Parameters:

contentRoot - root folder for model locations

modelDir - at least one folder (usually under contentRoot; could be equal to it) with model source files

Returns:

descriptor for a default model root

createSingleFolderDescriptor

@NotNull
public static ModelRootDescriptor createSingleFolderDescriptor(@NotNull
                                                               IFile modelDir)

Same as createDescriptor(IFile, IFile...) limited to a single location with source model files

Parameters:

modelDir - folder with model source files, serves both as content root and as a source location

Returns:

descriptor for a default model root