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

Class AbstractSourceSynchronizationProvider

java.lang.Object

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

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

All Implemented Interfaces:

ISourceSynchronizationProvider, org.eclipse.gmf.runtime.common.core.service.IProvider

public abstract class AbstractSourceSynchronizationProvider
extends org.eclipse.gmf.runtime.common.core.service.AbstractProvider
implements ISourceSynchronizationProvider

Abstact implementation of ISourceSynchronizationProvider that supports compound deltas and takes into account uneditable elements

Field Summary

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

EXT_POINT_TAG, HANDLER_ID_TAG, ID_ATTRIBUTE_TAG

Constructor Summary

Constructors

Constructor and Description
AbstractSourceSynchronizationProvider() Constructor

Method Summary

Modifier and Type	Method and Description
protected abstract org.eclipse.gmf.runtime.common.core.command.ICommand	doEmit(ModelChangeDelta delta)
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.
abstract boolean	isEditable(ModelChangeDelta delta) Returns false if the change involves an element that cannot be edited, e.g.
protected abstract boolean	matchesEmitCriteria(ModelChangeDelta delta)
boolean	provides(org.eclipse.gmf.runtime.common.core.service.IOperation operation)
protected boolean	supports(ModelChangeDelta delta)

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, removeProviderChangeListener

Constructor Detail

AbstractSourceSynchronizationProvider

public AbstractSourceSynchronizationProvider()

Constructor

Method Detail

isEditable

public abstract boolean isEditable(ModelChangeDelta delta)

Returns false if the change involves an element that cannot be edited, e.g. a read only element.

Parameters:

delta - ModelChangeDelta that may or may not involve an element that cannot be edited.

Returns:

false if the change involves an element that cannot be edited, e.g. a read only element, true otherwise.

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.

doEmit

protected abstract org.eclipse.gmf.runtime.common.core.command.ICommand doEmit(ModelChangeDelta delta)
                                                                        throws java.lang.Exception

Throws:

java.lang.Exception

provides

public boolean provides(org.eclipse.gmf.runtime.common.core.service.IOperation operation)

Specified by:

provides in interface org.eclipse.gmf.runtime.common.core.service.IProvider

See Also:

IProvider.provides(org.eclipse.gmf.runtime.common.core.service.IOperation)

supports

protected boolean supports(ModelChangeDelta delta)

matchesEmitCriteria

protected abstract boolean matchesEmitCriteria(ModelChangeDelta delta)