com.ibm.xtools.mmi.core

Interface ITarget

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

public interface ITarget
extends org.eclipse.emf.ecore.EObject

Interface to be implemented by all Meta-classes that are used for meta-model integration.

This interface provides the capability to assign StructuredReference to the mapped object. This interface provides the capability to assign ITargetSynchronizer to the mapped object.

Method Summary

Modifier and Type	Method and Description
void	activate(ITargetSynchronizer adapter, StructuredReference vr) Activates the mapped object with a ITargetSynchronizer and StructuredReference.
void	deactivate() Deactivates the mapped object
boolean	enableSynchronization(boolean bEnable) Enables/Disables synchronization for the mapped object.
StructuredReference	getStructuredReference() Returns the StructuredReference associated with the mapped object.
ITargetSynchronizer	getTargetSynchronizer() Returns the adapter responsible for synchronizing the features of the Meta-class.
boolean	isActivated() Returns true if the mapped object is activated with a ITargetSynchronizer else false
void	setClean(org.eclipse.emf.ecore.EStructuralFeature kind) Marks the specified structural feature clean.
void	setDirty(org.eclipse.emf.ecore.EStructuralFeature kind, java.lang.Object hint) Marks the specified structural feature dirty, thereby forcing synchronization of the structural feature.
void	synchronizeFeature(org.eclipse.emf.ecore.EStructuralFeature sf, java.lang.Object hint) Synchronizes a particular structural feature of the implementing meta-class.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

activate

void activate(ITargetSynchronizer adapter,
              StructuredReference vr)

Activates the mapped object with a ITargetSynchronizer and StructuredReference.

Parameters:

adapter - Adapter for synchronizing the features of the Meta-class. null is illegal.

vr - StructuredReference associated with the mapped object. null is illegal.

deactivate

void deactivate()

Deactivates the mapped object

getTargetSynchronizer

ITargetSynchronizer getTargetSynchronizer()

Returns the adapter responsible for synchronizing the features of the Meta-class.

Returns:

ITargetSynchronizer

getStructuredReference

StructuredReference getStructuredReference()

Returns the StructuredReference associated with the mapped object.

Returns:

StructuredReference

isActivated

boolean isActivated()

Returns true if the mapped object is activated with a ITargetSynchronizer else false

Returns:

boolean

setDirty

void setDirty(org.eclipse.emf.ecore.EStructuralFeature kind,
              java.lang.Object hint)

Marks the specified structural feature dirty, thereby forcing synchronization of the structural feature. The hint specified while marking a structural feature dirty is passed to ITargetSynchronizer.synchronizeFeature(EObject, EStructuralFeature, Object).

Parameters:

kind - Structural feature of the implementing meta-class

hint - Hint specifying why this Structural feature is marked dirty

setClean

void setClean(org.eclipse.emf.ecore.EStructuralFeature kind)

Marks the specified structural feature clean. Marking a structural feature clean won't trigger ITargetSynchronizer.synchronizeFeature(EObject, EStructuralFeature, Object).

Parameters:

kind - Structural feature of the implementing meta-class

enableSynchronization

boolean enableSynchronization(boolean bEnable)

Enables/Disables synchronization for the mapped object.

Parameters:

bEnable - true to enable synchronization and false to disable.

Returns:

boolean true if it synchronization was previously enabled, false if it was previously disabled

synchronizeFeature

void synchronizeFeature(org.eclipse.emf.ecore.EStructuralFeature sf,
                        java.lang.Object hint)

Synchronizes a particular structural feature of the implementing meta-class. For features that are never synchronized or marked dirty, this invokes ITargetSynchronizer.synchronizeFeature(EObject, EStructuralFeature, Object)

Parameters:

sf - Structural feature of the implementing meta-class to be synchronized.

hint - Hint to be used for synchronizing a feature, null if invoked outside of setDirty(EStructuralFeature, Object).