com.ibm.xtools.comparemerge.emf.controller

Class EmfMergeFacade

java.lang.Object

com.ibm.xtools.comparemerge.emf.controller.EmfMergeFacade

public class EmfMergeFacade
extends java.lang.Object

This facade provides APIs for invoking the silent compare/merge for the emf/uml models. It also has methods for creating light weight viewer input object that can be used for building the delta tree in the DeltaTreeViewer.

Constructor Summary

Constructors

Constructor and Description
EmfMergeFacade()

Method Summary

Modifier and Type	Method and Description
static DeltaTreeViewerInput	createDeltaTreeViewerInput(EmfMergeManager mergeManager) Creates the light weight viewer input.
static DeltaTreeViewerInput	createDeltaTreeViewerInput(java.lang.String baseModelFilePath, java.lang.String contModelFilePath, org.eclipse.core.runtime.IProgressMonitor monitor, java.lang.StringBuilder outputErrorMessages) Creates the light weight viewer input.
static IInputOutputDescriptor	createDescriptor(org.eclipse.emf.ecore.EObject eObject) Creates io descriptor for compare/merge operation.
static IInputOutputDescriptor	createDescriptor(org.eclipse.emf.ecore.resource.Resource emfResource) Creates io descriptor for compare/merge operation.
static IInputOutputDescriptor	createDescriptor(java.lang.String filePath) Creates io descriptor for compare/merge operation.
static MergeSessionInfo	createSessionInfo(java.lang.String[] inputFilePaths, java.lang.String outputFilePath, MergeModeType mode, IMergeStatusCallback callback) Creates io descriptor for compare/merge operation.
static void	openModelCompareEditor(java.lang.String baseFilePath, java.lang.String contFilePath, ActiveDeltaSetter activeDeltaSetter) Opens the compare editor the the given two model files.
static EmfMergeManager	startSilentMerge(MergeSessionInfo sessionInfo, org.eclipse.core.runtime.IProgressMonitor monitor) Initiates the silent compare or merge session (Two or Three-way).

Methods inherited from class java.lang.Object

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

Constructor Detail

EmfMergeFacade

public EmfMergeFacade()

Method Detail

createDescriptor

public static IInputOutputDescriptor createDescriptor(java.lang.String filePath)

Creates io descriptor for compare/merge operation.

Parameters:

filePath - Path of the model file to be compared.

Returns:

The io descriptor

createDescriptor

public static IInputOutputDescriptor createDescriptor(org.eclipse.emf.ecore.resource.Resource emfResource)

Creates io descriptor for compare/merge operation.

Parameters:

emfResource - The emf resource to be compared.

Returns:

The io descriptor

createDescriptor

public static IInputOutputDescriptor createDescriptor(org.eclipse.emf.ecore.EObject eObject)

Creates io descriptor for compare/merge operation.

Parameters:

eObject - The emf object to be compared.

Returns:

The io descriptor

createSessionInfo

public static MergeSessionInfo createSessionInfo(java.lang.String[] inputFilePaths,
                                                 java.lang.String outputFilePath,
                                                 MergeModeType mode,
                                                 IMergeStatusCallback callback)

Creates io descriptor for compare/merge operation.

Parameters:

inputFilePaths - Paths of the model files to be compared.

outputFilePath - Output file location for the merged result.

mode - Type of matcher. if the elements in the model have unique xmi:id, use MergeModeType.MERGE_BY_ID. Otherwise, use MergeModeType.FUSE_BY_NAME if the name should be used to identify the elements in the model.

Returns:

The compare or merge session info

createDeltaTreeViewerInput

public static DeltaTreeViewerInput createDeltaTreeViewerInput(java.lang.String baseModelFilePath,
                                                              java.lang.String contModelFilePath,
                                                              org.eclipse.core.runtime.IProgressMonitor monitor,
                                                              java.lang.StringBuilder outputErrorMessages)

Creates the light weight viewer input. The input object can be used for building the delta tree in the delta tree viewer. Example: Object input = EmfMergeFacade.createDeltaTreeViewerInput( "c:\\temp\\baseModel.emx", "c:\\temp\\contModel.emx", null); DeltaTreeViewer viewer = new DeltaTreeViewer(parentSWTcomposite, SWT.BORDER); viewer.setInput(input);

Parameters:

baseModelFilePath - Path of the base model file.

contModelFilePath - Path of the contributor model file.

monitor - The progress monitor. (Can be null)

Returns:

The input object for delta tree viewer.

startSilentMerge

public static EmfMergeManager startSilentMerge(MergeSessionInfo sessionInfo,
                                               org.eclipse.core.runtime.IProgressMonitor monitor)

Initiates the silent compare or merge session (Two or Three-way).

Parameters:

sessionInfo - The merge session info

monitor - The progress monitor. (Can be null)

Returns:

The merge manager that was used to run the compare merge session. List of differences can be obtains from the merge manager's delta container for custom rendering or processing. Caller must call the merge manager's close method to dispose the loaded emf resources when the merge manager is no long needed.

createDeltaTreeViewerInput

public static DeltaTreeViewerInput createDeltaTreeViewerInput(EmfMergeManager mergeManager)

Creates the light weight viewer input. The input object can be used for building the delta tree in the delta tree view.

Parameters:

mergeManager - The merge manager that was used to run the compare merge session.

Returns:

The input object for delta tree viewer.

openModelCompareEditor

public static void openModelCompareEditor(java.lang.String baseFilePath,
                                          java.lang.String contFilePath,
                                          ActiveDeltaSetter activeDeltaSetter)

Opens the compare editor the the given two model files. The active delta setter can optionally attached to the compare editor for navigate the delta tree selection. Example: ActiveDeltaSetter setter = new ActiveDeltaSetter(); EmfMergeFacade.openModelCompareEditor("c:\\temp\\baseModel.emx", "c:\\temp\\contModel.emx", setter); IDeltaDescription deltaDescription = ... initialize setter.setActiveDelta(deltaDescription); // set delta selection in compare editor

Parameters:

baseFilePath - base model file path

contFilePath - contributor model file path

activeDeltaSetter - the active delta setter.