Package jetbrains.mps.smodel

Class DefaultSModelDescriptor

java.lang.Object

jetbrains.mps.extapi.model.SModelDescriptorStub

jetbrains.mps.extapi.model.SModelBase

jetbrains.mps.extapi.model.EditableSModelBase

jetbrains.mps.smodel.LazyEditableSModelBase

jetbrains.mps.smodel.DefaultSModelDescriptor

All Implemented Interfaces:

GeneratableSModel, ModelWithAttributes, ModelWithDisposeInfo, PersistenceVersionAware, FastNodeFinder.Factory, SModelInternal, EditableSModel, SModel

public class DefaultSModelDescriptor
extends LazyEditableSModelBase
implements GeneratableSModel, PersistenceVersionAware, ModelWithAttributes

Nested Class Summary

Nested classes/interfaces inherited from interface org.jetbrains.mps.openapi.model.SModel

SModel.Problem

Field Summary

Fields inherited from class jetbrains.mps.extapi.model.EditableSModelBase

myTimestampTracker

Fields inherited from interface jetbrains.mps.extapi.model.GeneratableSModel

FILE, HEADER

Constructor Summary

Constructors

Constructor	Description
DefaultSModelDescriptor(LazyLoadFacility persistence, SModelHeader header)

Method Summary

Modifier and Type	Method	Description
void	forEach(BiConsumer<String,String> action)	Iterate over all available attributes.
String	getAttribute(String key)	Retrieve extra model data.
SModelHeader	getHeaderCopy()
ModelFactory	getModelFactory()	Actual ModelFactory which is currently responsible for model load/save, or null if model knowns nothing about persistence at the moment.
String	getModelHash()
int	getPersistenceVersion()	Since we expose persistence aspects of a model from (openapi)SModel, it's reasonable to keep persistence attributes we are not yet ready to expose here in the implementation.
boolean	isDoNotGenerate()
boolean	isGeneratable()	Generally, doNotGenerate is a primary reason to generate (or not) the model.
boolean	isGenerateIntoModelFolder()
protected ModelLoadResult	loadSModel(ModelLoadingState state)	loads model from the source, w/o changing state of SModelDescriptor
protected void	reloadContents()
void	replace(SModelData modelData)
protected boolean	saveModel()	returns true if the content should be reloaded from storage after save
void	setAttribute(String key, String value)	Record extra data with a model
void	setDoNotGenerate(boolean value)
void	setGenerateIntoModelFolder(boolean value)	PROVISIONAL API.
void	setPersistenceVersion(int persistenceVersion)	Indicated persistence version for model serialization
protected boolean	shouldCorrectModelRef()

Methods inherited from class jetbrains.mps.smodel.LazyEditableSModelBase

doUnload, getCurrentModelInternal, getSModelInternal, load

Methods inherited from class jetbrains.mps.extapi.model.EditableSModelBase

addChangeListener, addRootNode, attach, detach, isChanged, isReadOnly, needsReloading, reloadFromSource, removeChangeListener, removeRootNode, rename, resolveDiskConflict, save, setChanged, toString, unload, updateTimestamp

Methods inherited from class jetbrains.mps.extapi.model.SModelBase

addAccessListener, addModelListener, assertCanChange, assertCanRead, changeModelReference, createNode, createNode, fireBeforeModelRenamed, fireConflictDetected, fireModelRenamed, fireModelReplaced, fireModelSaved, fireModelStateChanged, fireProblemsDetected, getLoadingState, getModelData, getModelId, getModelName, getModelRoot, getModule, getName, getNode, getNodeEventDispatch, getProblems, getReference, getRepository, getRootNodes, getSource, isLoaded, removeAccessListener, removeModelListener, replaceModelAndFireEvent, setLoadingState, setModelRoot, setModule

Methods inherited from class jetbrains.mps.extapi.model.SModelDescriptorStub

addDevKit, addEngagedOnGenerationLanguage, addLanguage, addModelImport, addModelListener, clearListeners, createNodeFinder, deleteDevKit, deleteLanguageId, deleteModelImport, fireBeforeModelDisposed, fireBeforeModelFileChanged, fireBeforeModelRenamed, fireModelFileChanged, fireModelRenamed, fireModelStateChanged, getDisposedStacktrace, getLanguageImportVersion, getLanguagesEngagedOnGeneration, getModelDepsManager, getModelImports, getModelListeners, getSModel, importedDevkits, importedLanguageIds, isDisposed, removeEngagedOnGenerationLanguage, removeModelListener, setLanguageImportVersion, updateExternalReferences

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.mps.extapi.model.GeneratableSModel

getGenerationHashes

Methods inherited from interface jetbrains.mps.extapi.model.ModelWithAttributes

getAttribute

Methods inherited from interface org.jetbrains.mps.openapi.model.SModel

addAccessListener, addChangeListener, addModelListener, addRootNode, createNode, createNode, getModelId, getModelName, getModelRoot, getModule, getName, getNode, getProblems, getReference, getRepository, getRootNodes, getSource, isLoaded, isReadOnly, load, removeAccessListener, removeChangeListener, removeModelListener, removeRootNode, unload

Constructor Detail

DefaultSModelDescriptor

public DefaultSModelDescriptor(@NotNull
                               LazyLoadFacility persistence,
                               @NotNull
                               SModelHeader header)

Method Detail

replace

public void replace(SModelData modelData)

loadSModel

protected ModelLoadResult loadSModel(ModelLoadingState state)

Description copied from class: LazyEditableSModelBase

loads model from the source, w/o changing state of SModelDescriptor

Specified by:

loadSModel in class LazyEditableSModelBase

shouldCorrectModelRef

protected boolean shouldCorrectModelRef()

getPersistenceVersion

public int getPersistenceVersion()

Since we expose persistence aspects of a model from (openapi)SModel, it's reasonable to keep persistence attributes we are not yet ready to expose here in the implementation. These attributes shall not be part of SModelData (smodel.SModel), which is purely about nodes and model structure. To me, persistence shall be completely independent aspect, not exposed from SModel, however, at this moment the best we could do is to keep persistence within SModel descriptor and hope for the future changes (deprecate and remove methods like getDataSource, getProblems)

Specified by:

getPersistenceVersion in interface PersistenceVersionAware

Returns:

actual persistence version number of loaded/created model, or -1 if persistence versioning is not supported

setPersistenceVersion

public void setPersistenceVersion(int persistenceVersion)

Description copied from interface: PersistenceVersionAware

Indicated persistence version for model serialization

Specified by:

setPersistenceVersion in interface PersistenceVersionAware

Parameters:

persistenceVersion - persistence version number, or -1 for undefined/unknown

getModelFactory

@Nullable
public ModelFactory getModelFactory()

Description copied from interface: PersistenceVersionAware

Actual ModelFactory which is currently responsible for model load/save, or null if model knowns nothing about persistence at the moment.

Specified by:

getModelFactory in interface PersistenceVersionAware

Returns:

model load/save facility or null if undefined

saveModel

protected boolean saveModel()
                     throws IOException

Description copied from class: EditableSModelBase

returns true if the content should be reloaded from storage after save

Specified by:

saveModel in class EditableSModelBase

Throws:

IOException

isGeneratable

public boolean isGeneratable()

Description copied from interface: GeneratableSModel

Generally, doNotGenerate is a primary reason to generate (or not) the model. However, if there's more than a simple option, this method gives a chance to control "to generate, or not to generate".

Specified by:

isGeneratable in interface GeneratableSModel

Returns:

true if the model can serve as generator input

isGenerateIntoModelFolder

public boolean isGenerateIntoModelFolder()

Specified by:

isGenerateIntoModelFolder in interface GeneratableSModel

setGenerateIntoModelFolder

public void setGenerateIntoModelFolder(boolean value)

Description copied from interface: GeneratableSModel

PROVISIONAL API. Likely to cease once there's better mechanism to override output directory than #isGenerateIntoModelFolder Update the value of generateIntoModelFolder attribute

Specified by:

setGenerateIntoModelFolder in interface GeneratableSModel

getModelHash

public String getModelHash()

Specified by:

getModelHash in interface GeneratableSModel

setDoNotGenerate

public void setDoNotGenerate(boolean value)

Specified by:

setDoNotGenerate in interface GeneratableSModel

isDoNotGenerate

public boolean isDoNotGenerate()

Specified by:

isDoNotGenerate in interface GeneratableSModel

setAttribute

public void setAttribute(@NotNull
                         String key,
                         @Nullable
                         String value)

Description copied from interface: ModelWithAttributes

Record extra data with a model

Specified by:

setAttribute in interface ModelWithAttributes

Parameters:

key - attribute identity

value - attribute value, or null do remove an attribute, if any.

getAttribute

@Nullable
public String getAttribute(@NotNull
                           String key)

Description copied from interface: ModelWithAttributes

Retrieve extra model data.

Specified by:

getAttribute in interface ModelWithAttributes

Parameters:

key - attribute identity. There's no penalty if the key is unknown/unsupported with this model implementation

Returns:

null if there's no value for the key.

forEach

public void forEach(@NotNull
                    BiConsumer<String,String> action)

Description copied from interface: ModelWithAttributes

Iterate over all available attributes. Generally, not present attributes are not reported, however, clients shall expect null values, and implementation may report missing/deleted attributes. For now, the contract is action shall not modify attributes, we might relax this in future (i.e. iterate over a copy of internal storage), if there are scenarios we find it handy.

Specified by:

forEach in interface ModelWithAttributes

Parameters:

action - action to perform for each key-value attribute pair

reloadContents

protected void reloadContents()

Overrides:

reloadContents in class LazyEditableSModelBase

getHeaderCopy

public SModelHeader getHeaderCopy()