Package jetbrains.mps.extapi.model

Class EditableSModelBase

java.lang.Object

jetbrains.mps.extapi.model.SModelDescriptorStub

jetbrains.mps.extapi.model.SModelBase

jetbrains.mps.extapi.model.EditableSModelBase

All Implemented Interfaces:

ModelWithDisposeInfo, FastNodeFinder.Factory, SModelInternal, EditableSModel, SModel

Direct Known Subclasses:

CustomPersistenceModelWithHeader, CustomPersistenceSModel, LazyEditableSModelBase, TransientModelsModule.TransientSModelDescriptor

public abstract class EditableSModelBase
extends SModelBase
implements EditableSModel

Editable model (generally) backed up by file. Implicitly bound to files due to rename and changeModelFile methods, for a generic editable model, see EditableModelDescriptor evgeny, 11/21/12

Nested Class Summary

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

SModel.Problem

Field Summary

Fields

Modifier and Type	Field	Description
protected ModelSourceChangeTracker	myTimestampTracker

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EditableSModelBase(SModelReference modelReference, DataSource source)

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(SNodeChangeListener l)	This class doesn't dispatch change events, no listeners are tracked.
void	addRootNode(SNode node)	Adds the node as a root to this model.
void	attach(SRepository repository)
void	detach()
boolean	isChanged()
boolean	isReadOnly()	No changes are permitted.
boolean	needsReloading()
protected abstract void	reloadContents()
void	reloadFromSource()
void	removeChangeListener(SNodeChangeListener l)	This class doesn't dispatch change events, no listeners are tracked.
void	removeRootNode(SNode node)	Removes the whole subtree from the model.
void	rename(String newModelName, boolean changeFile)
void	resolveDiskConflict()
void	save()	When owning a write action lock, this method will save the model into the storage.
protected abstract boolean	saveModel()	returns true if the content should be reloaded from storage after save
void	setChanged(boolean changed)
String	toString()
void	unload()	Dispose model data, change model's loading state and dispatch state change event.
void	updateTimestamp()

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

addAccessListener, addModelListener, assertCanChange, assertCanRead, changeModelReference, createNode, createNode, doUnload, fireBeforeModelRenamed, fireConflictDetected, fireModelRenamed, fireModelReplaced, fireModelSaved, fireModelStateChanged, fireProblemsDetected, getCurrentModelInternal, getLoadingState, getModelData, getModelId, getModelName, getModelRoot, getModule, getName, getNode, getNodeEventDispatch, getProblems, getReference, getRepository, getRootNodes, getSource, isLoaded, load, 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, getSModelInternal, 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 org.jetbrains.mps.openapi.model.SModel

addAccessListener, addModelListener, createNode, createNode, getModelId, getModelName, getModelRoot, getModule, getName, getNode, getProblems, getReference, getRepository, getRootNodes, getSource, isLoaded, load, removeAccessListener, removeModelListener

Field Detail

myTimestampTracker

protected final ModelSourceChangeTracker myTimestampTracker

Constructor Detail

EditableSModelBase

protected EditableSModelBase(@NotNull
                             SModelReference modelReference,
                             @NotNull
                             DataSource source)

Method Detail

attach

public void attach(@NotNull
                   SRepository repository)

Overrides:

attach in class SModelBase

detach

public void detach()

Overrides:

detach in class SModelBase

isChanged

public boolean isChanged()

Specified by:

isChanged in interface EditableSModel

setChanged

public void setChanged(boolean changed)

Specified by:

setChanged in interface EditableSModel

addRootNode

public void addRootNode(@NotNull
                        SNode node)

Description copied from interface: SModel

Adds the node as a root to this model. Each node in the underlying subtree becomes connected to this model and returns it from the getModel() method.

Specified by:

addRootNode in interface SModel

Overrides:

addRootNode in class SModelBase

removeRootNode

public void removeRootNode(@NotNull
                           SNode node)

Description copied from interface: SModel

Removes the whole subtree from the model.

Specified by:

removeRootNode in interface SModel

Overrides:

removeRootNode in class SModelBase

isReadOnly

public boolean isReadOnly()

Description copied from interface: SModel

No changes are permitted. For read-only models all modification operations always throw IllegalModelChangeError.

Specified by:

isReadOnly in interface SModel

Overrides:

isReadOnly in class SModelBase

unload

public final void unload()

Description copied from class: SModelBase

Dispose model data, change model's loading state and dispatch state change event. Base implementation does nothing if there's no initialized model data. Generally, subclasses shall override SModelBase.doUnload() to perform actual cleanup of instance fields.

Specified by:

unload in interface SModel

Overrides:

unload in class SModelBase

reloadFromSource

public void reloadFromSource()

Specified by:

reloadFromSource in interface EditableSModel

reloadContents

protected abstract void reloadContents()

resolveDiskConflict

public void resolveDiskConflict()

save

public final void save()

Description copied from interface: EditableSModel

When owning a write action lock, this method will save the model into the storage. Throws an exception if there were fatal errors during the load phase. Should only be called when isChanged() == true

Specified by:

save in interface EditableSModel

saveModel

protected abstract boolean saveModel()
                              throws IOException,
                                     ModelSaveException

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

Throws:

IOException

ModelSaveException

rename

public void rename(String newModelName,
                   boolean changeFile)

Specified by:

rename in interface EditableSModel

updateTimestamp

public void updateTimestamp()

Specified by:

updateTimestamp in interface EditableSModel

needsReloading

public boolean needsReloading()

Specified by:

needsReloading in interface EditableSModel

addChangeListener

public void addChangeListener(SNodeChangeListener l)

Description copied from class: SModelBase

This class doesn't dispatch change events, no listeners are tracked.

Specified by:

addChangeListener in interface SModel

Overrides:

addChangeListener in class SModelBase

Parameters:

l - listener to add, tolerates null

removeChangeListener

public void removeChangeListener(SNodeChangeListener l)

Description copied from class: SModelBase

This class doesn't dispatch change events, no listeners are tracked.

Specified by:

removeChangeListener in interface SModel

Overrides:

removeChangeListener in class SModelBase

Parameters:

l - listener to remove, tolerates null and unknown (not registered) listeners

toString

public String toString()

Overrides:

toString in class Object