com.ibm.xtools.mmi.core.services.sync

Class SourceSynchronizationService

java.lang.Object

org.eclipse.gmf.runtime.common.core.service.AbstractProvider

org.eclipse.gmf.runtime.common.core.service.Service

com.ibm.xtools.mmi.core.services.sync.SourceSynchronizationService

All Implemented Interfaces:

ISourceSynchronizationProvider, java.util.EventListener, org.eclipse.gmf.runtime.common.core.service.IProvider, org.eclipse.gmf.runtime.common.core.service.IProviderChangeListener

public class SourceSynchronizationService
extends org.eclipse.gmf.runtime.common.core.service.Service
implements ISourceSynchronizationProvider

Service implementation supporting the participation of one or more ISourceSynchronizationProvider implementations in emitting updates to PSM model elements based on changes to the Semantic model. This service emits the provided ModelChangeDelta using the ExecutionStrategy.FORWARD strategy. That is, all registered CodeProviders will be invoked in order of priority to generate an ICommand representing their contribution to the overall operation.

See Also:

ISourceSynchronizationProvider, ModelChangeDelta

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.gmf.runtime.common.core.service.Service

org.eclipse.gmf.runtime.common.core.service.Service.ProviderDescriptor

Field Summary

Fields inherited from class org.eclipse.gmf.runtime.common.core.service.Service

INVALID_ELEMENT_MESSAGE_PATTERN

Fields inherited from interface com.ibm.xtools.mmi.core.services.sync.ISourceSynchronizationProvider

EXT_POINT_TAG, HANDLER_ID_TAG, ID_ATTRIBUTE_TAG

Method Summary

Modifier and Type	Method and Description
org.eclipse.gmf.runtime.common.core.command.ICommand	emit(ModelChangeDelta delta) Generates an ICommand based on the provided ModelChangeDelta that, when executed, will complete all operations necessary to alter the corresponding domain element managed by this provider implementation.
static SourceSynchronizationService	getInstance() Retrieves the singleton instance of this service.
protected org.eclipse.gmf.runtime.common.core.service.Service.ProviderDescriptor	newProviderDescriptor(org.eclipse.core.runtime.IConfigurationElement element)

Methods inherited from class org.eclipse.gmf.runtime.common.core.service.Service

addProvider, clearCache, configureProviders, configureProviders, createPriorityCache, execute, executeUnique, getAllProviders, getCachingKey, getPriority, getProviders, isOptimistic, isOptimized, providerChanged, provides, provides, removeProvider

Methods inherited from class org.eclipse.gmf.runtime.common.core.service.AbstractProvider

addProviderChangeListener, fireProviderChange, removeProviderChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.gmf.runtime.common.core.service.IProvider

addProviderChangeListener, provides, removeProviderChangeListener

Method Detail

getInstance

public static SourceSynchronizationService getInstance()

Retrieves the singleton instance of this service.

Returns:

The source synchronization service singleton.

emit

public org.eclipse.gmf.runtime.common.core.command.ICommand emit(ModelChangeDelta delta)

Description copied from interface: ISourceSynchronizationProvider

Generates an ICommand based on the provided ModelChangeDelta that, when executed, will complete all operations necessary to alter the corresponding domain element managed by this provider implementation. The returned ICommand must not attempt to make changes to the Semantic or Notational models directly. The command must also expect to be appended to an encapsulating Compound command that may contain other ICommands contributed by other providers registered against the CodeProviders extension point.

IMPORTANT: If the affected domain element is under source control, the generated ICommand's execute() method must ensure the file is writable (e.g. by performing a checkout if necessary) before modifying the domain element.

Specified by:

emit in interface ISourceSynchronizationProvider

Parameters:

delta - the ModelChangeDelta to be handled.

Returns:

the ICommand whose execution will effect the necessary changes (if any) to the appropriate source elements.

See Also:

ISourceSynchronizationProvider.emit(com.ibm.xtools.mmi.core.delta.ModelChangeDelta)

newProviderDescriptor

protected org.eclipse.gmf.runtime.common.core.service.Service.ProviderDescriptor newProviderDescriptor(org.eclipse.core.runtime.IConfigurationElement element)

Overrides:

newProviderDescriptor in class org.eclipse.gmf.runtime.common.core.service.Service