de.uni_hildesheim.sse.ui

Class VarModelListener

java.lang.Object

net.ssehub.easy.dslCore.ui.editors.AbstractModelChangeListener

de.uni_hildesheim.sse.ui.VarModelListener

All Implemented Interfaces:

IModelListener<Project>, IModelReloadListener<Project>

public class VarModelListener
extends AbstractModelChangeListener
implements IModelReloadListener<Project>, IModelListener<Project>

A de.uni_hildesheim.sse.model.varModel.Project listener, which receives notifications about changes of the variability model and then forces an update of the de.uni_hildesheim.sse.ui.XtextEditor instance that is used to edit the corresponding document in which the variability model is defined. Note that receiving a change notification will also trigger updates of other running editors via the de.uni_hildesheim.sse.dslcore.ui.editors.ModelChangeNotifier.

Author:

kroeher

Field Summary

Fields inherited from class net.ssehub.easy.dslCore.ui.editors.AbstractModelChangeListener

isListening, underlyingModel, xtextDocument, xtextEditor

Constructor Summary

Constructors

Constructor and Description
VarModelListener() Constructs a variability model listener that updates a registered de.uni_hildesheim.sse.ui.XtextEditor instance if the underlying de.uni_hildesheim.sse.model.varModel.Project instance, which is edited in the registered editor, changes.

Method Summary

Modifier and Type	Method and Description
protected IModel	getUnderlyingModel(java.net.URI modelFileUri, boolean forceBuild) Returns the de.uni_hildesheim.sse.utils.modelManagement.IModel instance (an IVML-, VIL-, or VTL-model) based on the URI of the org.eclipse.core.resources.IResource (the document) currently in use by the editor that is registered to this listener.
void	notifyReloadFailed(Project model) Is called to notify that model was not successfully reloaded, e.g., due to syntactic or semantic errors.
void	notifyReplaced(Project oldModel, Project newModel) Is called to notify that oldModel is replaced by newModel.
protected boolean	registerToUnderlyingModel(IModel underlyingModel) Adds this listener to the underlying model in order to receive events if this model changes.
void	unregister() Unregisters this listener from the underlying model in order to receive no events about changes of the model anymore.

Methods inherited from class net.ssehub.easy.dslCore.ui.editors.AbstractModelChangeListener

buildModel, isListening, register, setXtextDocument, updateRegisteredEditor

Methods inherited from class java.lang.Object

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

Constructor Detail

VarModelListener

public VarModelListener()

Constructs a variability model listener that updates a registered de.uni_hildesheim.sse.ui.XtextEditor instance if the underlying de.uni_hildesheim.sse.model.varModel.Project instance, which is edited in the registered editor, changes.

Method Detail

notifyReplaced

public void notifyReplaced(Project oldModel,
                           Project newModel)

Description copied from interface: IModelListener

Is called to notify that oldModel is replaced by newModel. The listener registrations for oldModel will be adjusted accordingly.
Do not modify the the listeners of oldModel or newModel during this method.

Specified by:

notifyReplaced in interface IModelListener<Project>

Parameters:

oldModel - the old model being replaced

newModel - the new model (the replacement)

notifyReloadFailed

public void notifyReloadFailed(Project model)

Description copied from interface: IModelReloadListener

Is called to notify that model was not successfully reloaded, e.g., due to syntactic or semantic errors. Please note that successful reloads are notified through IModelListener.

Specified by:

notifyReloadFailed in interface IModelReloadListener<Project>

Parameters:

model - the model that was not updated

unregister

public void unregister()

Description copied from class: AbstractModelChangeListener

Unregisters this listener from the underlying model in order to receive no events about changes of the model anymore. This method must be called if the registered editor is disposed.

Specified by:

unregister in class AbstractModelChangeListener

registerToUnderlyingModel

protected boolean registerToUnderlyingModel(IModel underlyingModel)

Description copied from class: AbstractModelChangeListener

Adds this listener to the underlying model in order to receive events if this model changes.

Specified by:

registerToUnderlyingModel in class AbstractModelChangeListener

Parameters:

underlyingModel - the de.uni_hildesheim.sse.utils.modelManagement.IModel to which this listener must be registered

Returns:

true if the registration of this listener to the given mode was successful, false otherwise

getUnderlyingModel

protected IModel getUnderlyingModel(java.net.URI modelFileUri,
                                    boolean forceBuild)

Description copied from class: AbstractModelChangeListener

Returns the de.uni_hildesheim.sse.utils.modelManagement.IModel instance (an IVML-, VIL-, or VTL-model) based on the URI of the org.eclipse.core.resources.IResource (the document) currently in use by the editor that is registered to this listener. Note that this method will be called internally to retrieve the underlying model.

Specified by:

getUnderlyingModel in class AbstractModelChangeListener

Parameters:

modelFileUri - the java.net.URI of the org.eclipse.core.resources.IResource (the document) currently in use by the editor that is registered to this listener.

forceBuild - true if the model should be build if it cannot resolved. false if no build should be forced.

Returns:

the de.uni_hildesheim.sse.utils.modelManagement.IModel (an IVML-, VIL-, or VTL-model) which is currently edited in the registered editor of this listener.