com.ibm.xtools.comparemerge.emf.fuse

Class FuseController

java.lang.Object

com.ibm.xtools.comparemerge.emf.fuse.FuseController

All Implemented Interfaces:

com.ibm.xtools.comparemerge.emf.internal.fuse.events.IFuseNotifier, org.eclipse.compare.IPropertyChangeNotifier

public class FuseController
extends java.lang.Object
implements org.eclipse.compare.IPropertyChangeNotifier, com.ibm.xtools.comparemerge.emf.internal.fuse.events.IFuseNotifier

Controller for the FuseViewer. Used to fuse EMF models. Uses EmfMergeManager to provide the information.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_DIRTY
static java.lang.String	PROPERTY_FILTER_DIFFS
static java.lang.String	PROPERTY_FILTER_ELEMENTS
static java.lang.String	PROPERTY_SESSION_ERROR
static java.lang.String	PROPERTY_SESSION_OPEN
static java.lang.String	PROPERTY_SHOW_DIFFERENCES
static java.lang.String	PROPERTY_SHOW_MATCHES
static java.lang.String	PROPERTY_SHOW_RELATED_DIFFS

Constructor Summary

Constructors

Constructor and Description
FuseController(FuseViewer parentViewer) Constructor

Method Summary

Modifier and Type	Method and Description
void	addFuseListener(com.ibm.xtools.comparemerge.emf.internal.fuse.events.IFuseListener listener)
void	addPropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)
void	addSubSessionListener(ISubSessionMergeEventListener listener)
void	applyManualMatch() Applies the new manual match for two objects set before via setSourceManualMatch() and setTargetManualMatch().
protected boolean	applyMarkedDifferences(boolean confirmDelete) This will apply all check-marked differences to the target model.
boolean	canApplyManualMatch()
boolean	canManualyMatchNode(com.ibm.xtools.comparemerge.emf.internal.fuse.viewers.AnnotatedTreeViewer tree, com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node)
boolean	canManualyMatchNodeToSelected(com.ibm.xtools.comparemerge.emf.internal.fuse.viewers.AnnotatedTreeViewer tree, com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node)
boolean	commitSession() This will apply all marked differences to the target model, save the result and close the session.
void	disableDeltaFilter(com.ibm.xtools.comparemerge.emf.fuse.filters.IDeltaFilter deltaFilter) Disables the given delta filter.
void	disableElementFilter(com.ibm.xtools.comparemerge.emf.fuse.filters.IElementFilter elementFilter) Disables the given delta filter.
protected void	doSetManualMatch(org.eclipse.emf.ecore.EObject sourceManualMatchObject, org.eclipse.emf.ecore.EObject targetManualMatchObject)
void	enableDeltaFilter(com.ibm.xtools.comparemerge.emf.fuse.filters.IDeltaFilter deltaFilter) Enables the given delta filter.
void	enableElementFilter(com.ibm.xtools.comparemerge.emf.fuse.filters.IElementFilter elementFilter) Enables the given delta filter.
boolean	filterDelta(com.ibm.xtools.comparemerge.emf.fuse.nodes.DeltaInfo deltaInfo) Performs delta filtering by using the previously set filtering strategy.
org.eclipse.emf.common.notify.AdapterFactory	getAdapterFactory()
com.ibm.xtools.comparemerge.emf.internal.fuse.nodes.Difference	getCurrentDifference()
com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode	getCurrentSourceNode()
com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode	getCurrentTargetNode()
java.util.Map	getDeletedObjectPlaceholderMap()
java.util.List	getDeltaFiltersAll()
java.util.List	getDeltaFiltersEnabled()
com.ibm.xtools.comparemerge.emf.fuse.nodes.DeltaInfo	getDeltaInfo(Delta delta)
IDifferenceRenderer	getDifferenceRenderer() If needed, creates and return the Difference Renderer capable of providing human-readable description for the model differences.
com.ibm.xtools.comparemerge.emf.internal.fuse.nodes.CheckmarkNodeHierarchy	getDifferences()
java.util.Map	getDifferencesMap()
com.ibm.xtools.comparemerge.emf.internal.fuse.utils.TreeNavigator	getDifferencesNavigator()
java.util.List	getElementFiltersAll()
java.util.List	getElementFiltersEnabled()
FuseViewer	getFuseViewer()
com.ibm.xtools.comparemerge.emf.fuse.services.IFuseViewerFactory	getFuseViewerFactory()
com.ibm.xtools.comparemerge.emf.fuse.filters.HierarchyElementsFilter	getHierarchyFilterForObject(org.eclipse.emf.ecore.EObject eObject)
com.ibm.xtools.comparemerge.emf.internal.fuse.nodes.ManualMatchNodeHierarchy	getManualMatches()
EmfMergeManager	getMergeManager()
java.util.Map	getNodeMap(org.eclipse.emf.ecore.resource.Resource resource)
java.lang.Object	getProperty(java.lang.String property)
com.ibm.xtools.comparemerge.emf.internal.fuse.utils.FuseSessionInfo	getSessionInfo()
java.util.Map	getSourceNodeMap()
org.eclipse.emf.ecore.resource.Resource	getSourceResource()
com.ibm.xtools.comparemerge.emf.internal.fuse.utils.EObjectStateMap	getSourceStateMap()
com.ibm.xtools.comparemerge.emf.internal.fuse.utils.EObjectStateMap	getStateMap(org.eclipse.emf.ecore.resource.Resource resource)
protected com.ibm.xtools.comparemerge.emf.internal.utils.SubMergeHandler	getSubSessionHandler()
java.util.Map	getTargetNodeMap()
org.eclipse.emf.ecore.resource.Resource	getTargetResource()
com.ibm.xtools.comparemerge.emf.internal.fuse.utils.EObjectStateMap	getTargetStateMap()
boolean	isDeltaFilterEnabled()
boolean	isFuseSession()
boolean	isSessionOpen()
void	notifyFuseListeners(java.lang.String eventId, java.lang.Object source, java.lang.Object data)
void	notifySubSessionListeners(SubSessionMergeEvent event)
void	onSubMergeEvent(SubSessionMergeEvent event)
void	reapplyManualMatches() Re-apply previously stored manual matches from the Manual Matches hierarchy to the Matcher.
void	refresh(boolean preserve, boolean confirmImplicitDeleteDifferences) This will reinitialize already opened fuse session and call refresh on the Fuse Viewer.
void	removeFuseListener(com.ibm.xtools.comparemerge.emf.internal.fuse.events.IFuseListener listener)
void	removePropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)
void	removeSubSessionListener(ISubSessionMergeEventListener listener)
void	resetFilterStateToDefault()
void	setShowRelatedDifferences(boolean show) When enabled, limits the scope of the differences displayed in the Differences Tree only to those related to the selected model element in the source tree.
void	setSourceManualMatch(com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node) Sets the node in the Source tree to be matched
void	setTargetManualMatch(com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node) Sets the node in the Target tree to be matched
void	showDifferences(boolean show) Causes the Fuse Viewer to show/hide the Differences tree
void	showManualMatches(boolean show) Causes the Fuse Viewer to show/hide the Manual Matches tree
void	unapplyManualMatches(boolean removeAll) Removes all check-marked manual matches that were previously applied or all if requested.
boolean	wasManuallyMatched(com.ibm.xtools.comparemerge.emf.internal.fuse.viewers.AnnotatedTreeViewer tree, com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node)
boolean	wasSelectedForManualMatch(com.ibm.xtools.comparemerge.emf.internal.fuse.viewers.AnnotatedTreeViewer tree, com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_DIRTY

public static final java.lang.String PROPERTY_DIRTY

See Also:

Constant Field Values

PROPERTY_SESSION_OPEN

public static final java.lang.String PROPERTY_SESSION_OPEN

See Also:

Constant Field Values

PROPERTY_SESSION_ERROR

public static final java.lang.String PROPERTY_SESSION_ERROR

See Also:

Constant Field Values

PROPERTY_SHOW_DIFFERENCES

public static final java.lang.String PROPERTY_SHOW_DIFFERENCES

See Also:

Constant Field Values

PROPERTY_SHOW_MATCHES

public static final java.lang.String PROPERTY_SHOW_MATCHES

See Also:

Constant Field Values

PROPERTY_SHOW_RELATED_DIFFS

public static final java.lang.String PROPERTY_SHOW_RELATED_DIFFS

See Also:

Constant Field Values

PROPERTY_FILTER_DIFFS

public static final java.lang.String PROPERTY_FILTER_DIFFS

See Also:

Constant Field Values

PROPERTY_FILTER_ELEMENTS

public static final java.lang.String PROPERTY_FILTER_ELEMENTS

See Also:

Constant Field Values

Constructor Detail

FuseController

public FuseController(FuseViewer parentViewer)

Constructor

Method Detail

isSessionOpen

public boolean isSessionOpen()

Returns:

true if the fuse session is successfully open without fatal errors.

commitSession

public boolean commitSession()

This will apply all marked differences to the target model, save the result and close the session. Called just before the fuse viewer is destroyed.

Returns:

true if success

refresh

public final void refresh(boolean preserve,
                          boolean confirmImplicitDeleteDifferences)

This will reinitialize already opened fuse session and call refresh on the Fuse Viewer.

resetFilterStateToDefault

public void resetFilterStateToDefault()

applyMarkedDifferences

protected boolean applyMarkedDifferences(boolean confirmDelete)
                                  throws java.lang.Exception

This will apply all check-marked differences to the target model. Performed when the OK is pressed and the fuse UI is about to be dismissed. May throw runtime exceptions in case of errors in the C/M backend or at the EMF layer. Called from commitSession().

Returns:

false if user canceled operation

Throws:

java.lang.Exception

getSessionInfo

public final com.ibm.xtools.comparemerge.emf.internal.fuse.utils.FuseSessionInfo getSessionInfo()

Returns:

Returns the _sessionInfo.

getDifferencesNavigator

public final com.ibm.xtools.comparemerge.emf.internal.fuse.utils.TreeNavigator getDifferencesNavigator()

Returns:

tree navigator for the differences tree of the Fuse Viewer. Used by the actions to get navigation events and to navigate the tree.

getDifferenceRenderer

public IDifferenceRenderer getDifferenceRenderer()

If needed, creates and return the Difference Renderer capable of providing human-readable description for the model differences. May be overridden to provide a custom renderer.

isFuseSession

public final boolean isFuseSession()

Returns:

true if the current session is in "Fuse" mode (not "Compare")

getFuseViewer

public final FuseViewer getFuseViewer()

Returns:

reference to the parent fuse viewer

getAdapterFactory

public final org.eclipse.emf.common.notify.AdapterFactory getAdapterFactory()

Returns:

EMF Adapter Factory for the current EMF file type or NULL is session is not open. Used by the Content Providers to generate labels/icons for model elements.

getFuseViewerFactory

public final com.ibm.xtools.comparemerge.emf.fuse.services.IFuseViewerFactory getFuseViewerFactory()

Returns:

reference to the Fuse Viewer Factory capable of instantiating content providers, label providers, sorters, filters and difference renderer.

getMergeManager

public final EmfMergeManager getMergeManager()

Returns:

EMF Merge Manager for the current fuse session, or NULL is session is not open.

getSourceResource

public final org.eclipse.emf.ecore.resource.Resource getSourceResource()

Returns:

EMF resource for the source model (on the Left)

getTargetResource

public final org.eclipse.emf.ecore.resource.Resource getTargetResource()

Returns:

EMF resource for the target model (on the Right)

getDifferences

public final com.ibm.xtools.comparemerge.emf.internal.fuse.nodes.CheckmarkNodeHierarchy getDifferences()

Returns:

the Differences hierarchy

getManualMatches

public final com.ibm.xtools.comparemerge.emf.internal.fuse.nodes.ManualMatchNodeHierarchy getManualMatches()

Returns:

the hierarchy of applied manual matches

showDifferences

public void showDifferences(boolean show)

Causes the Fuse Viewer to show/hide the Differences tree

Parameters:

show - true to show, false to hide

showManualMatches

public void showManualMatches(boolean show)

Causes the Fuse Viewer to show/hide the Manual Matches tree

Parameters:

show - true to show, false to hide

setShowRelatedDifferences

public void setShowRelatedDifferences(boolean show)

When enabled, limits the scope of the differences displayed in the Differences Tree only to those related to the selected model element in the source tree.

Parameters:

show - true to enable, otherwise the diffs tree will show all differences

getStateMap

public final com.ibm.xtools.comparemerge.emf.internal.fuse.utils.EObjectStateMap getStateMap(org.eclipse.emf.ecore.resource.Resource resource)

Returns:

state map for elements in a given resource (either Source or Target)

getSourceStateMap

public final com.ibm.xtools.comparemerge.emf.internal.fuse.utils.EObjectStateMap getSourceStateMap()

Returns:

state map for elements in the Source resource

getTargetStateMap

public final com.ibm.xtools.comparemerge.emf.internal.fuse.utils.EObjectStateMap getTargetStateMap()

Returns:

state map for elements in the Target resource

getNodeMap

public final java.util.Map getNodeMap(org.eclipse.emf.ecore.resource.Resource resource)

Returns:

map from EObject to its Node for a given resource

getSourceNodeMap

public final java.util.Map getSourceNodeMap()

Returns:

map from EObject to its Node in the Source model

getTargetNodeMap

public final java.util.Map getTargetNodeMap()

Returns:

map from EObject to its Node in the Target model

getDifferencesMap

public final java.util.Map getDifferencesMap()

Returns:

map from Delta to its wrapping Difference

getDeletedObjectPlaceholderMap

public final java.util.Map getDeletedObjectPlaceholderMap()

Returns:

map from deleted model Object in the Target to its placeholder node in the Source

getDeltaFiltersAll

public final java.util.List getDeltaFiltersAll()

Returns:

list of all existing delta filters. For a list of enabled filters use getDeltaFiltersEnabled()

getDeltaFiltersEnabled

public final java.util.List getDeltaFiltersEnabled()

Returns:

list of delta filters that were enabled. This is a sub-set of all delta filters returned via getDeltaFiltersAll()

enableDeltaFilter

public void enableDeltaFilter(com.ibm.xtools.comparemerge.emf.fuse.filters.IDeltaFilter deltaFilter)

Enables the given delta filter. This will refresh the fuse session.

disableDeltaFilter

public void disableDeltaFilter(com.ibm.xtools.comparemerge.emf.fuse.filters.IDeltaFilter deltaFilter)

Disables the given delta filter. This will refresh the fuse session.

getElementFiltersAll

public final java.util.List getElementFiltersAll()

Returns:

list of all existing delta filters. For a list of enabled filters use getDeltaFiltersEnabled()

getElementFiltersEnabled

public final java.util.List getElementFiltersEnabled()

Returns:

list of delta filters that were enabled. This is a sub-set of all delta filters returned via getDeltaFiltersAll()

getHierarchyFilterForObject

public final com.ibm.xtools.comparemerge.emf.fuse.filters.HierarchyElementsFilter getHierarchyFilterForObject(org.eclipse.emf.ecore.EObject eObject)

Returns:

Hierarchy Filter for a given model element, or null if none.

enableElementFilter

public void enableElementFilter(com.ibm.xtools.comparemerge.emf.fuse.filters.IElementFilter elementFilter)

Enables the given delta filter. This will refresh the fuse session.

disableElementFilter

public void disableElementFilter(com.ibm.xtools.comparemerge.emf.fuse.filters.IElementFilter elementFilter)

Disables the given delta filter. This will refresh the fuse session.

isDeltaFilterEnabled

public boolean isDeltaFilterEnabled()

Returns:

true if at least one delta filter (visible or not) is enabled.

filterDelta

public boolean filterDelta(com.ibm.xtools.comparemerge.emf.fuse.nodes.DeltaInfo deltaInfo)

Performs delta filtering by using the previously set filtering strategy. Will do nothing if no filters enabled and return true.

Parameters:

deltaInfo - to be filtering

Returns:

true if the delta is to be listed in the Difference tree and to be annotated on the model trees.

getCurrentDifference

public com.ibm.xtools.comparemerge.emf.internal.fuse.nodes.Difference getCurrentDifference()

Returns:

currently selected difference in the differences tree

getCurrentSourceNode

public com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode getCurrentSourceNode()

Returns:

currently selected node in the source model tree

getCurrentTargetNode

public com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode getCurrentTargetNode()

Returns:

currently selected node in the target model tree or null

canManualyMatchNode

public boolean canManualyMatchNode(com.ibm.xtools.comparemerge.emf.internal.fuse.viewers.AnnotatedTreeViewer tree,
                                   com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node)

Returns:

true if a given node from a given tree (either Source or Target tree) can be manually matched to some other node in the opposite tree.

canManualyMatchNodeToSelected

public boolean canManualyMatchNodeToSelected(com.ibm.xtools.comparemerge.emf.internal.fuse.viewers.AnnotatedTreeViewer tree,
                                             com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node)

Returns:

true if a given node can be manually matched to a previously selected node in the opposite tree

wasSelectedForManualMatch

public boolean wasSelectedForManualMatch(com.ibm.xtools.comparemerge.emf.internal.fuse.viewers.AnnotatedTreeViewer tree,
                                         com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node)

Returns:

true if a given node was selected for manual match but the manual match was not applied yet

wasManuallyMatched

public boolean wasManuallyMatched(com.ibm.xtools.comparemerge.emf.internal.fuse.viewers.AnnotatedTreeViewer tree,
                                  com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node)

Returns:

true if a given node was previously manually matched.

setSourceManualMatch

public final void setSourceManualMatch(com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node)

Sets the node in the Source tree to be matched

setTargetManualMatch

public final void setTargetManualMatch(com.ibm.xtools.comparemerge.emf.fuse.nodes.AnnotationNode node)

Sets the node in the Target tree to be matched

canApplyManualMatch

public boolean canApplyManualMatch()

Returns:

true if the two previously set objects can be manually matched

applyManualMatch

public void applyManualMatch()

Applies the new manual match for two objects set before via setSourceManualMatch() and setTargetManualMatch(). This will restart the session to re-generate the deltas.

unapplyManualMatches

public void unapplyManualMatches(boolean removeAll)

Removes all check-marked manual matches that were previously applied or all if requested. This will cause the fuse session to restart.

Parameters:

removeAll - to be true if ALL matches to be removed, otherwise only check-marked one will be removed.

reapplyManualMatches

public void reapplyManualMatches()

Re-apply previously stored manual matches from the Manual Matches hierarchy to the Matcher. Called after the Matcher was re-initialized to restore previously set matches.

doSetManualMatch

protected void doSetManualMatch(org.eclipse.emf.ecore.EObject sourceManualMatchObject,
                                org.eclipse.emf.ecore.EObject targetManualMatchObject)

getProperty

public java.lang.Object getProperty(java.lang.String property)

Returns:

value for a given property or null if not set

addPropertyChangeListener

public void addPropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface org.eclipse.compare.IPropertyChangeNotifier

removePropertyChangeListener

public void removePropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface org.eclipse.compare.IPropertyChangeNotifier

notifyFuseListeners

public void notifyFuseListeners(java.lang.String eventId,
                                java.lang.Object source,
                                java.lang.Object data)

addFuseListener

public void addFuseListener(com.ibm.xtools.comparemerge.emf.internal.fuse.events.IFuseListener listener)

Specified by:

addFuseListener in interface com.ibm.xtools.comparemerge.emf.internal.fuse.events.IFuseNotifier

removeFuseListener

public void removeFuseListener(com.ibm.xtools.comparemerge.emf.internal.fuse.events.IFuseListener listener)

Specified by:

removeFuseListener in interface com.ibm.xtools.comparemerge.emf.internal.fuse.events.IFuseNotifier

notifySubSessionListeners

public void notifySubSessionListeners(SubSessionMergeEvent event)

Parameters:

event - - event propagator. pass event from the subsession handler to the listeners

addSubSessionListener

public void addSubSessionListener(ISubSessionMergeEventListener listener)

Parameters:

listener - - add sub session event listener to our local cache. The events will be generated only when sub session handler is instantiated and subsessions are run. That instantiation is lazy. Because of that we do not add/remove listeners directly to the sub session handler's cache

removeSubSessionListener

public void removeSubSessionListener(ISubSessionMergeEventListener listener)

Parameters:

listener - - remove sub session event listener from our local cache. These events are generated only when sub session handler is instantiated and subsessions are run. The instantiation is lazy. Because of that, we do not add/remove listeners directly to the sub session handler's cache

getSubSessionHandler

protected com.ibm.xtools.comparemerge.emf.internal.utils.SubMergeHandler getSubSessionHandler()

Returns:

the _subSessionController

onSubMergeEvent

public void onSubMergeEvent(SubSessionMergeEvent event)

getDeltaInfo

public com.ibm.xtools.comparemerge.emf.fuse.nodes.DeltaInfo getDeltaInfo(Delta delta)