org.eclipse.emf.emfstore.internal.client.ui.controller
Class UICommitProjectController

java.lang.Object
  org.eclipse.emf.emfstore.internal.client.ui.common.MonitoredEMFStoreAction<T>
      org.eclipse.emf.emfstore.internal.client.ui.controller.AbstractEMFStoreUIController<ESPrimaryVersionSpec>
          org.eclipse.emf.emfstore.internal.client.ui.controller.UICommitProjectController

All Implemented Interfaces:

ESCommitCallback

public class UICommitProjectController
extends AbstractEMFStoreUIController<ESPrimaryVersionSpec>
implements ESCommitCallback

UI-dependent commit controller for committing pending changes on a ESLocalProject.
The controller presents the user a dialog will all changes made before he is able to confirm the commit. If no changes have been made by the user a information dialog is presented that states that there are no pending changes to be committed.

Author:

ovonwesen, emueller

Field Summary

Fields inherited from interface org.eclipse.emf.emfstore.client.callbacks.ESCommitCallback

NOCALLBACK

Constructor Summary

UICommitProjectController(org.eclipse.swt.widgets.Shell shell, ESLocalProject localProject)
Constructor.

Method Summary

boolean	baseVersionOutOfDate(ESLocalProject projectSpace, org.eclipse.core.runtime.IProgressMonitor progressMonitor) Called when the project that should be updated is out of date.
ESPrimaryVersionSpec	doRun(org.eclipse.core.runtime.IProgressMonitor progressMonitor) The actual behavior that should be performed when the MonitoredEMFStoreAction.execute() is called. Must be implemented by clients.
boolean	inspectChanges(ESLocalProject localProject, ESChangePackage changePackage, ESModelElementIdToEObjectMapping idToEObjectMapping) Called right before the actual commit is performed.
void	noLocalChanges(ESLocalProject localProject) Called when there are no changes on the given project space.

Methods inherited from class org.eclipse.emf.emfstore.internal.client.ui.controller.AbstractEMFStoreUIController

confirm, getShell, setShell

Methods inherited from class org.eclipse.emf.emfstore.internal.client.ui.common.MonitoredEMFStoreAction

afterRun, execute, executeSub, isForked, preRun

Methods inherited from class java.lang.Object

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

Constructor Detail

UICommitProjectController

public UICommitProjectController(org.eclipse.swt.widgets.Shell shell,
                                 ESLocalProject localProject)

Constructor.

Parameters:

shell - the parent shell that will be used during commit

localProject - the ESLocalProject that contains the pending changes that should get committed

Method Detail

noLocalChanges

public void noLocalChanges(ESLocalProject localProject)

Called when there are no changes on the given project space.

Specified by:

noLocalChanges in interface ESCommitCallback

Parameters:

localProject - the project that has no local pending changes

See Also:

ESCommitCallback.noLocalChanges(org.eclipse.emf.emfstore.client.ESLocalProject)

baseVersionOutOfDate

public boolean baseVersionOutOfDate(ESLocalProject projectSpace,
                                    org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Called when the project that should be updated is out of date.

A caller may veto against updating the project space by returning false.

Specified by:

baseVersionOutOfDate in interface ESCommitCallback

Parameters:

projectSpace - the project being out of date

progressMonitor - the currently used IProgressMonitor

Returns:

true, if the caller is willing to update the project, false otherwise

See Also:

ESCommitCallback.baseVersionOutOfDate(ESLocalProject, IProgressMonitor)

inspectChanges

public boolean inspectChanges(ESLocalProject localProject,
                              ESChangePackage changePackage,
                              ESModelElementIdToEObjectMapping idToEObjectMapping)

Called right before the actual commit is performed.

Implementors may veto against the commit by returning false.

Specified by:

inspectChanges in interface ESCommitCallback

Parameters:

localProject - the project with the local pending changes

changePackage - the actual changes that are up to be inspected

idToEObjectMapping - a mapping from IDs to EObjects and vice versa.
Contains all IDs of model elements involved in the ESChangePackages as well as those contained by the project in the ESLocalProject

Returns:

true, if the commit should continue, false otherwise

See Also:

ESCommitCallback.inspectChanges(org.eclipse.emf.emfstore.client.ESLocalProject, org.eclipse.emf.emfstore.server.model.ESChangePackage, org.eclipse.emf.emfstore.common.model.ESModelElementIdToEObjectMapping)

doRun

public ESPrimaryVersionSpec doRun(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
                           throws ESException

The actual behavior that should be performed when the MonitoredEMFStoreAction.execute() is called.
Must be implemented by clients.

Specified by:

doRun in class MonitoredEMFStoreAction<ESPrimaryVersionSpec>

Parameters:

progressMonitor - the IProgressMonitor that should be used by clients to update the status of their progress

Returns:

an optional return value

Throws:

ESException - in case an error occurs

See Also:

MonitoredEMFStoreAction.doRun(org.eclipse.core.runtime.IProgressMonitor)