com.ibm.xtools.comparemerge.emf.controller

Class EmfMergeManager

java.lang.Object

AbstractMergeManager

com.ibm.xtools.comparemerge.emf.controller.EmfMergeManager

public class EmfMergeManager
extends AbstractMergeManager

The MergeManager implementation for EMF-based models merged with the EMF Merge Backend.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EmfMergeManager.ChangeChangeConflictAcceptCommandValue Extra interface for getChangeChangeConflictAcceptCommand().

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List	_conflicts List of conflicts in the merge session
protected DeltaResolver	_deltaResolver Delta Resolver
protected com.ibm.xtools.comparemerge.emf.delta.deltagenerator.matcher.Matcher	_matcher Matcher used by the merge manager.
protected DeltaContainer	_newerDeltaContainer Delta container used to contain deltas generated from base and right contributor
protected DeltaContainer	_olderDeltaContainer Delta container used to contain deltas generated from base and right contributor
protected int	_sessionId ID used to uniquely identify a merge session from the others.
protected boolean	_sessionOpen Tracks whether there is an open merge session
protected IContributorProvider	contributorProvider
protected org.eclipse.emf.ecore.xmi.XMLParserPool	defaultXMLParserPool
protected static java.lang.String	EMF_CONTENT_TYPE_ID EMF content type id
protected org.eclipse.emf.common.util.URI	savedNewerResourceURI

Constructor Summary

Constructors

Constructor and Description
EmfMergeManager() Default Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Called when the compare/merge session is about to be disposed.
protected void	collectKeepMatchingIds(java.util.List deltas, java.util.Set<java.lang.String> keepMatchingIds)
protected boolean	conflictingResourceNameCheck()
protected ClosureUtils.IClosureIOHelper	createClosureIOHelper(org.eclipse.emf.common.util.URI resourceUri, IInputOutputDescriptor descriptor) Factory method that should create object which can load closure into logic resource
protected IClosureURIConverterExtension	createClosureURIConverterExtension(org.eclipse.emf.common.util.URI resourceUri, IInputOutputDescriptor desc) Factory method that should create helper method for URI converter to handle closure case
protected ConflictAnalyzer	createConflictAnalyzer() Creates a new instance of the Conflict Analyzer.
protected DeltaGenerator	createDeltaGenerator() Creates a new instance of the Delta Generator.
protected DeltaResolver	createDeltaResolver() Creates a new instance of the Delta Resolver.
protected IDeltaTreeGrouper	createDeltaTreeGrouper(java.lang.String deltaTreeBuilderID)
protected com.ibm.xtools.comparemerge.emf.internal.logicalmodel.ILogicalModelChangeSet	createLogicalModelMergeChangeSet() Creates the Logical model change set that is controlling the fragment loading
protected com.ibm.xtools.comparemerge.emf.delta.deltagenerator.matcher.Matcher	createMatcher() Creates a new instance of the Matcher.
protected org.eclipse.emf.ecore.resource.Resource	createResource(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, org.eclipse.emf.common.util.URI resourceUri) Create resource for the compare/merge session.
protected org.eclipse.emf.ecore.resource.ResourceSet	createResourceSet() Creates a new instance of the ResourceSet to be used when loading models in memory.
protected org.eclipse.emf.ecore.resource.URIConverter	createURIConverter(org.eclipse.emf.common.util.URI resourceUri, IInputOutputDescriptor desc, boolean disableModelRefResolution, boolean disableSubUnitRefResolution) Factory method which create URI converter
protected void	disposeResource(org.eclipse.emf.ecore.resource.Resource resource)
protected void	disposeResources() Clean-up everything.
protected void	enterErrorMode() Enters the "Error mode" in case of major error in doMerge()/doCompare().
java.lang.Object	executeRunnable(IMergeManagerRunnable runnable) A function used to perform some generic operation in a model-specific way.
protected java.lang.String	extractErrorMessage(org.eclipse.emf.ecore.resource.Resource resource, java.lang.Exception ex, IInputOutputDescriptor desc) Will extract the error message generated when loading the EMF Resource.
protected com.ibm.xtools.comparemerge.emf.delta.deltagenerator.matcher.Matcher	findNameMatcher() Finds matcher that can look-up EObjects in the EMF Resource by their name and the full path from the root of the resource (URI Fragment).
protected com.ibm.xtools.comparemerge.emf.delta.deltagenerator.matcher.Matcher	findUUIDMatcher() Finds matcher that can look-up EObjects in the EMF Resource by its UUID.
protected DeltaContainer	generateDeltas(IInputOutputDescriptor base, org.eclipse.emf.ecore.resource.Resource baseResource, IInputOutputDescriptor contrib, org.eclipse.emf.ecore.resource.Resource contribResource) Creates and runs the delta generator to produce the deltas between the base and a given contributor
org.eclipse.emf.common.command.Command	getAcceptCommand(Delta delta) Returns an accept command for the given delta
org.eclipse.emf.common.command.Command	getAcceptDeltasCommand(java.util.List deltas) Returns the fuse accept deltas command
org.eclipse.emf.common.command.Command	getAcceptMergedValueCommand(Delta delta, java.lang.Object mergedValue) Creates accept command for add add conflict delta with the given merged value
org.eclipse.emf.ecore.resource.Resource	getAncestorResource() Retrieves the Resouce for the Left contributor, or null
org.eclipse.emf.ecore.resource.Resource	getBaseResource() Will retrieve the resource that is base resource all deltas generated against.
int	getCalculatedBaseIndex(Location location, Delta delta) Return an index for a location of a delta calculated to the base resource.
int	getCalculatedContributorIndex(Location location, Delta delta, org.eclipse.emf.ecore.resource.Resource contributor) Return an index for a location of a delta calculated to the merged resource.
int	getCalculatedMergedIndex(Location location, Delta delta) Return an index for a location of a delta calculated to the merged resource.
int	getCalculatedResourceIndex(org.eclipse.emf.ecore.resource.Resource resource, Location location, Delta delta) Return an index for a location of a delta calculated for a given resource which can be either Base, one of Contributors or Merged.
org.eclipse.emf.common.command.Command	getChangeChangeConflictAcceptCommand(Conflict conflict, java.lang.Object v) Returns an accept command for the change-change conflict
org.eclipse.emf.common.command.Command	getChangeChangeConflictRejectCommand(Conflict conflict) Returns a reject command for the change-change conflict
org.eclipse.emf.common.command.Command	getChangeChangeConflictResetCommand(Conflict conflict) This commands reset resolution for change-change conflicts
org.eclipse.emf.common.command.Command	getClearSubsessionResultsCommand(ChangeDelta delta)
Delta	getConflictDelta(Conflict conflict, ContributorType contributor) Finds a conflicting delta from the requested contributor
Delta	getConflictResolutionDelta(Conflict conflict) Determines the Delta that was accepted to resolve the conflict
java.util.List	getConflicts() Returns a list of conflicts generated by the session.
java.lang.String	getContentTypeID() Returns the content type ID for this session
org.eclipse.emf.ecore.resource.Resource[]	getContributors() Retrieves references to the contributor resouces of this merge session.
org.eclipse.emf.common.command.Command	getDecrementCommand(ChangeDelta changeDelta) Instantiate and return a command , which will remove delta increment and re-apply delta state (if accepted) Typicaly done to erase results of merge subsession.
protected IDeltaTreeBuilder[]	getDefaultDeltaTreeBuilders()
protected IDeltaTreeFilter[]	getDefaultDeltaTreeFilters()
java.lang.String	getDefaultDeltaTreeSorter()
protected IDeltaTreeSorter[]	getDefaultDeltaTreeSorters()
DeltaContainer	getDeltaContainer(org.eclipse.emf.ecore.resource.Resource contributor) Returns a delta container generated by the session for a particular contributor.
DeltaContainer[]	getDeltaContainers() Retrieves all the deltaContainers related to this merge session.
ContributorType	getDeltaContributor(Delta delta) Determine the Contributor that caused the requested delta
Delta	getDeltaForContributor(Conflict conflict, ContributorType contributor) Will retrieve the conflicting Delta caused by a given Contributor.
java.util.List	getDeltas(org.eclipse.emf.ecore.resource.Resource contributor) Returns a list of deltas generated by the session for a particular contributor.
IDeltaTreeBuilder[]	getDeltaTreeBuilders(org.eclipse.core.runtime.content.IContentType contentType)
IDeltaTreeFilter[]	getDeltaTreeFilters(org.eclipse.core.runtime.content.IContentType contentType)
IDeltaTreeSorter[]	getDeltaTreeSorters(org.eclipse.core.runtime.content.IContentType contentType)
java.util.Collection	getDependentDeltas(Delta delta, org.eclipse.emf.ecore.resource.Resource contributor, boolean accept) Returns collectionf of other deltas in a given contributor that would also be accepted or rejected together with the given delta.
protected static java.lang.String	getDescriptorAbsolutePath(IInputOutputDescriptor desc) Gets an absolute file path for the descriptor, if this is possible.
protected static java.lang.String	getDescriptorPlatformPath(IInputOutputDescriptor desc) Will generate workspace-relative ("platform") path for a given descriptor or return null if the descriptor is stream-based or located outside of the workspace
protected static org.eclipse.core.resources.IFile	getFileInWorkspace(java.lang.String absolutePath) Will find an IFile reative to the current workspace, or NULL if it is located elsewhere, such as in the TMP directory
org.eclipse.emf.common.command.Command	getIncrementCommand(ChangeDelta changeDelta, java.lang.Object newValue) Instantiate and return a command , which will create delta increment and re-apply delta state (if accepted) Typicaly done to store results of merge subsession.
protected java.io.InputStream	getInputStream(IInputOutputDescriptor descriptor)
org.eclipse.emf.ecore.resource.Resource	getLeftResource() Retrieves the Resouce for the Left contributor
protected java.util.Map	getLoadOptions() Get the load options required to load a resource.
com.ibm.xtools.comparemerge.emf.delta.deltagenerator.matcher.Matcher	getMatcher() Retrieves reference to the matcher that is used to identify (match) EMF objects by their IDS in the EMF resource.
org.eclipse.emf.ecore.resource.Resource	getMergedResource() Retrieves the Resouce for the Merged contributor, or null
java.lang.String	getMultilineText(java.lang.Object deltaObject)
java.util.Set	getNonconflictingDeltas(org.eclipse.emf.ecore.resource.Resource contributor) Retrieves all the non conflicting deltas associated with the given contributor
java.util.List<PseudoConflict>	getPseudoConflicts(Delta delta)
org.eclipse.emf.common.command.Command	getRejectCommand(Delta delta) Returns a reject command for the given delta.
org.eclipse.emf.common.command.Command	getResolveDeltasCommand(java.util.List deltas, ResolutionType resolution)
org.eclipse.emf.ecore.resource.Resource	getResource(ContributorType contributor) Retrieves the Resouce for the requested contributor.
ContributorType	getResourceContributor(org.eclipse.emf.ecore.resource.Resource resource) Determine the Contributor for a requested resource
protected java.util.Set	getResourceProxies(org.eclipse.emf.ecore.resource.Resource resource)
java.util.List	getResources() Retrieves references to the contributor resouces of this merge session.
org.eclipse.emf.ecore.resource.Resource	getRightResource() Retrieves the Resouce for the Right contributor
protected java.util.Map	getSaveOptions()
protected void	getTargetAffectedResources(java.util.List deltas, java.util.Set affectedResources) This is a funciton used in fuse session mainly for validateEdit.
org.eclipse.emf.common.command.Command	getUnresolveCommand(Conflict c, java.util.List<?> src)
int	getUnresolvedConflictCount() Retrieves the total number of unresolved conflicts in the merge session
int	getUnresolvedDeltaCount() Retrieves the total number of unresolved deltas in the merge session
protected org.eclipse.emf.ecore.xmi.XMLParserPool	getXMLParserPool()
void	init(MergeSessionInfo sessionInfo) Overrides init() to initialise variable _resourceSet with default implementation of the ResourceSet which is EMF's ResourceSetImpl().
protected void	initDeltaResolver(DeltaResolver deltaResolver)
boolean	isClosureMode()
static boolean	isClosureRoot(IInputOutputDescriptor descriptor) Returns true if descriptor describes closure root
boolean	isEmptySession() Determines if the C/M session has no differences/conflicts
boolean	isMergeCompleted() Determines whether merge operation has been completed.
boolean	isMyFileMustBeMergeByMeInEclipseOnly()
protected boolean	isSparseModeEnabled() Check if sparse mode enabled
boolean	isTextChangeConflict(Conflict conflict)
protected boolean	needDispose(ContributorType contributor, org.eclipse.emf.ecore.resource.Resource resource, IInputOutputDescriptor descriptor) Determines if this resource is to be un-loaded when merge manager is closed.
protected org.eclipse.emf.ecore.resource.Resource	openMemoryResource(IInputOutputDescriptor desc)
protected org.eclipse.emf.ecore.resource.Resource	openResource(java.lang.String fileType, org.eclipse.emf.common.util.URI resourceUri, IInputOutputDescriptor desc) Opens a new EMF Resource for a given IInputOutputDescriptor.
protected void	preExecuteRunnable(IMergeManagerRunnable runnable) This method should always be called before executeRunnable method is called.
protected void	prepareResourceURIs() Generates _ancestorUri, _olderUri, _newerUri and _principalUri.
protected MergeStatusType	prepareSession() A hook used to tune the Compare/Merge Session before it is run.
protected void	pullTogetherResource(org.eclipse.emf.ecore.resource.Resource resource)
void	run(org.eclipse.core.runtime.IProgressMonitor monitor) Perform the actual Compare or Merge.
void	runDeltaGenerators() Executed the delta generators and, if needed, the conflict analyzer.
void	runDeltaGenerators(org.eclipse.core.runtime.IProgressMonitor monitor)
protected void	runSession(org.eclipse.core.runtime.IProgressMonitor monitor) Runs all back-end components to detect all Deltas, Conflicts etc.
boolean	saveMergedContributorAs(IInputOutputDescriptor output) During the merge session will save the merge result into mergedOutput IInputOutputDescriptor.
void	saveMergedContributorCopy(java.lang.String toPath) During the merge session will save a copy of the merge result to a specified file path.
void	saveMergedContributorCopy(java.lang.String toPath, java.lang.String rootModelName)
void	setContentType(org.eclipse.core.runtime.content.IContentType contentType)
void	setMergedResource(org.eclipse.emf.ecore.resource.Resource resource)
void	setResourceModifier(ResourceModifier modifier) Sets a Model Modifier - a facility used by the Delta Resolver to resolve the Deltas, in particular ADD and DELETE. To be set before the run() is called (i.e.
protected void	setURIConverter(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, org.eclipse.emf.ecore.resource.URIConverter converter)
java.util.List	sortDeltasByContributor(java.util.List deltas) Will create a new list containing all Deltas organized by therir contributors: Left is first, Right is second.
boolean	useReflectiveTypesAndNames() Checks if the reflective types and names should be used for rendering descriptions and labels
protected static boolean	validateSaveTarget(java.io.File f)

Methods inherited from class java.lang.Object

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

Field Detail

EMF_CONTENT_TYPE_ID

protected static final java.lang.String EMF_CONTENT_TYPE_ID

EMF content type id

See Also:

Constant Field Values

_sessionOpen

protected boolean _sessionOpen

Tracks whether there is an open merge session

_matcher

protected com.ibm.xtools.comparemerge.emf.delta.deltagenerator.matcher.Matcher _matcher

Matcher used by the merge manager.

_olderDeltaContainer

protected DeltaContainer _olderDeltaContainer

Delta container used to contain deltas generated from base and right contributor

_newerDeltaContainer

protected DeltaContainer _newerDeltaContainer

Delta container used to contain deltas generated from base and right contributor

_conflicts

protected java.util.List _conflicts

List of conflicts in the merge session

_deltaResolver

protected DeltaResolver _deltaResolver

Delta Resolver

_sessionId

protected int _sessionId

ID used to uniquely identify a merge session from the others.

savedNewerResourceURI

protected org.eclipse.emf.common.util.URI savedNewerResourceURI

defaultXMLParserPool

protected org.eclipse.emf.ecore.xmi.XMLParserPool defaultXMLParserPool

contributorProvider

protected final IContributorProvider contributorProvider

Constructor Detail

EmfMergeManager

public EmfMergeManager()

Default Constructor. Must be simple as the Merge Manager is created via ext point.

Method Detail

init

public void init(MergeSessionInfo sessionInfo)

Overrides init() to initialise variable _resourceSet with default implementation of the ResourceSet which is EMF's ResourceSetImpl(). Can be overridden to provide custom ResourceSet.

See Also:

com.ibm.xtools.comparemerge.core.controller.AbstractMergeManager#init(com.ibm.xtools.comparemerge.core.utils.MergeSessionInfo)

setResourceModifier

public void setResourceModifier(ResourceModifier modifier)

Sets a Model Modifier - a facility used by the Delta Resolver to resolve the Deltas, in particular ADD and DELETE.
To be set before the run() is called (i.e. before the DeltaResolver is created).

Parameters:

modifier - to be used or null if none to use.
Default is null

conflictingResourceNameCheck

protected boolean conflictingResourceNameCheck()

run

public void run(org.eclipse.core.runtime.IProgressMonitor monitor)

Perform the actual Compare or Merge. Should not throw. Will log errors to the Error Log.

See Also:

IRunnableWithProgress.run(org.eclipse.core.runtime.IProgressMonitor)

pullTogetherResource

protected void pullTogetherResource(org.eclipse.emf.ecore.resource.Resource resource)

runSession

protected void runSession(org.eclipse.core.runtime.IProgressMonitor monitor)
                   throws java.lang.Exception

Runs all back-end components to detect all Deltas, Conflicts etc. May be overridden.

Throws:

java.lang.Exception - in case of errors in the BE. Can be OutOfMemory error, runtime exceptions from EMF layer etc.

runDeltaGenerators

public void runDeltaGenerators()

Executed the delta generators and, if needed, the conflict analyzer. Called from runSession() or from outside to re-generate the deltas/conflicts.

runDeltaGenerators

public void runDeltaGenerators(org.eclipse.core.runtime.IProgressMonitor monitor)

collectKeepMatchingIds

protected void collectKeepMatchingIds(java.util.List deltas,
                                      java.util.Set<java.lang.String> keepMatchingIds)

generateDeltas

protected final DeltaContainer generateDeltas(IInputOutputDescriptor base,
                                              org.eclipse.emf.ecore.resource.Resource baseResource,
                                              IInputOutputDescriptor contrib,
                                              org.eclipse.emf.ecore.resource.Resource contribResource)

Creates and runs the delta generator to produce the deltas between the base and a given contributor

Returns:

generated deltas

createMatcher

protected com.ibm.xtools.comparemerge.emf.delta.deltagenerator.matcher.Matcher createMatcher()

Creates a new instance of the Matcher. Can be overridden. Called from runSession().

In case of FUSIN scenario will try to find a "Name" matcher, otherwise will try to find an UUID matcher.

Returns:

a suitable matcher for this C/M session or NULL if not found

findUUIDMatcher

protected com.ibm.xtools.comparemerge.emf.delta.deltagenerator.matcher.Matcher findUUIDMatcher()

Finds matcher that can look-up EObjects in the EMF Resource by its UUID. Can be overridden. Called from createMatcher(). By default uses URIFragmentMatcher.

Returns:

suitable matcher or NULL if not found.

findNameMatcher

protected com.ibm.xtools.comparemerge.emf.delta.deltagenerator.matcher.Matcher findNameMatcher()

Finds matcher that can look-up EObjects in the EMF Resource by their name and the full path from the root of the resource (URI Fragment). Can be overridden. Called from createMatcher(). By default uses URIFragmentMatcher.

Returns:

suitable matcher or NULL if not found.

createDeltaGenerator

protected DeltaGenerator createDeltaGenerator()

Creates a new instance of the Delta Generator. Can be overridden. Called from runSession().

createDeltaResolver

protected DeltaResolver createDeltaResolver()

Creates a new instance of the Delta Resolver. Can be overridden. Called from runSession().

initDeltaResolver

protected void initDeltaResolver(DeltaResolver deltaResolver)

createConflictAnalyzer

protected ConflictAnalyzer createConflictAnalyzer()

Creates a new instance of the Conflict Analyzer. Can be overridden. Called from runSession().

disposeResources

protected void disposeResources()

Clean-up everything. Should not throw!

disposeResource

protected void disposeResource(org.eclipse.emf.ecore.resource.Resource resource)

needDispose

protected boolean needDispose(ContributorType contributor,
                              org.eclipse.emf.ecore.resource.Resource resource,
                              IInputOutputDescriptor descriptor)

Determines if this resource is to be un-loaded when merge manager is closed.

Returns:

true if this resource is to be un-loaded when merge manager is closed.

prepareSession

protected MergeStatusType prepareSession()

A hook used to tune the Compare/Merge Session before it is run. May be used to set additional parameters or features on the session or perform the compatibility check.

Returns:

MergeStatusType must be MergeStatusType.COMPLETED if everything is OK and the engine may proceed the actual comapre/merge. Otherwise, the function must call the setStatus() and the compare/merge will exit with this status.

prepareResourceURIs

protected void prepareResourceURIs()

Generates _ancestorUri, _olderUri, _newerUri and _principalUri.
First, it will attempth to detect the contributor located inside the workspace. This will be used as a "principal URI" used to create all resource, which is very important for the platform and relative references to be correctly resolved when the EMF model is being loaded. Normally the LEFT contributor is the NEWER and is generally located in the workspace - therefore it takes priority over RIGHT when creating the principal URI.
Second, it will generate four other unique URIs by modifying the file name (but keeing the file path and file extension).
So, no matter where the original contributors come from (TMP dir, stream, cvs repository, history item etc) they all will be open as if they are located in the workspace. However, if none of the contributors are inside the workspace, the fake platform URI will be used, which could lead to problems resolving references and loading resources.

getFileInWorkspace

protected static org.eclipse.core.resources.IFile getFileInWorkspace(java.lang.String absolutePath)

Will find an IFile reative to the current workspace, or NULL if it is located elsewhere, such as in the TMP directory

Parameters:

absolutePath - to find the file for

Returns:

IFile if found, or null

openMemoryResource

protected org.eclipse.emf.ecore.resource.Resource openMemoryResource(IInputOutputDescriptor desc)

openResource

protected org.eclipse.emf.ecore.resource.Resource openResource(java.lang.String fileType,
                                                               org.eclipse.emf.common.util.URI resourceUri,
                                                               IInputOutputDescriptor desc)
                                                        throws java.lang.Exception

Opens a new EMF Resource for a given IInputOutputDescriptor. May be overriden to implement customised ResourceSet or special Resource. Opens a new Resource for a given IInputOutputDescriptor.

Parameters:

fileType - of the EMF resource to be opened. Can be different from the actual file extension (when merging from ClearCase).

resourceUri - the URI fot the resource being created. The URI must be UNIQUE within the session. Its file name and extension are very important and used by the EMF engine to locate a proper Resource Factory to handle the model type.

desc - for which to open a resource. Holds a file path as String or IStreamContentAccessor

Returns:

opened resource

Throws:

java.io.IOException

java.lang.Exception

isSparseModeEnabled

protected boolean isSparseModeEnabled()

Check if sparse mode enabled

getResourceProxies

protected java.util.Set getResourceProxies(org.eclipse.emf.ecore.resource.Resource resource)

createURIConverter

protected org.eclipse.emf.ecore.resource.URIConverter createURIConverter(org.eclipse.emf.common.util.URI resourceUri,
                                                                         IInputOutputDescriptor desc,
                                                                         boolean disableModelRefResolution,
                                                                         boolean disableSubUnitRefResolution)

Factory method which create URI converter

Parameters:

resourceUri -

desc -

disableModelRefResolution -

disableSubUnitRefResolution -

createClosureURIConverterExtension

protected IClosureURIConverterExtension createClosureURIConverterExtension(org.eclipse.emf.common.util.URI resourceUri,
                                                                           IInputOutputDescriptor desc)

Factory method that should create helper method for URI converter to handle closure case

Parameters:

resourceUri -

desc -

createClosureIOHelper

protected ClosureUtils.IClosureIOHelper createClosureIOHelper(org.eclipse.emf.common.util.URI resourceUri,
                                                              IInputOutputDescriptor descriptor)

Factory method that should create object which can load closure into logic resource

Parameters:

resourceUri -

descriptor -

createResource

protected org.eclipse.emf.ecore.resource.Resource createResource(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                                 org.eclipse.emf.common.util.URI resourceUri)

Create resource for the compare/merge session.

setURIConverter

protected void setURIConverter(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                               org.eclipse.emf.ecore.resource.URIConverter converter)

createResourceSet

protected org.eclipse.emf.ecore.resource.ResourceSet createResourceSet()

Creates a new instance of the ResourceSet to be used when loading models in memory.

Returns:

a reference to the ResourceSet to be used when loading models in memory.

getLoadOptions

protected java.util.Map getLoadOptions()

Get the load options required to load a resource.

Returns:

a map of load options

getSaveOptions

protected java.util.Map getSaveOptions()

getXMLParserPool

protected org.eclipse.emf.ecore.xmi.XMLParserPool getXMLParserPool()

enterErrorMode

protected void enterErrorMode()

Enters the "Error mode" in case of major error in doMerge()/doCompare(). The C/M session can not continue.

See Also:

com.ibm.xtools.comparemerge.core.controller.AbstractMergeManager#enterErrorMode()

close

public void close()

Called when the compare/merge session is about to be disposed. Should not throw!

isMergeCompleted

public boolean isMergeCompleted()

Determines whether merge operation has been completed. There is no more conflict to resolve.

Returns:

true when the merge has resolved all conflicts and it is safe to save the merged results.

See Also:

com.ibm.xtools.comparemerge.core.controller.AbstractMergeManager#isMergeCompleted()

saveMergedContributorAs

public boolean saveMergedContributorAs(IInputOutputDescriptor output)
                                throws java.io.IOException

During the merge session will save the merge result into mergedOutput IInputOutputDescriptor.

Throws:

java.io.IOException - if i/o error occured

validateSaveTarget

protected static boolean validateSaveTarget(java.io.File f)

saveMergedContributorCopy

public void saveMergedContributorCopy(java.lang.String toPath)
                               throws java.io.IOException

During the merge session will save a copy of the merge result to a specified file path.

Throws:

java.io.IOException - if i/o error occured

saveMergedContributorCopy

public void saveMergedContributorCopy(java.lang.String toPath,
                                      java.lang.String rootModelName)
                               throws java.io.IOException

Throws:

java.io.IOException

isEmptySession

public boolean isEmptySession()

Determines if the C/M session has no differences/conflicts

Returns:

Returns true if the C/M session has no differences/conflicts

getMatcher

public com.ibm.xtools.comparemerge.emf.delta.deltagenerator.matcher.Matcher getMatcher()

Retrieves reference to the matcher that is used to identify (match) EMF objects by their IDS in the EMF resource. Also used to generate IDS for a given EMF object.

Returns:

Returns reference to the matcher that is used to identify (match) EMF objects by their IDS in the EMF resource. Also used to generate IDS for a given EMF object.

getContributors

public org.eclipse.emf.ecore.resource.Resource[] getContributors()

Retrieves references to the contributor resouces of this merge session.

Returns:

Array of Resources.

getResources

public java.util.List getResources()

Retrieves references to the contributor resouces of this merge session.

Returns:

Array of Resources.

getDeltaContainers

public DeltaContainer[] getDeltaContainers()

Retrieves all the deltaContainers related to this merge session. If it is 3 way merge, there are 2 delta containers. Each of them corresponds to a contributor. Otherwise, it is 2 way merge, there is only 1 delta container.

Returns:

Array of delta containers.

getDeltas

public java.util.List getDeltas(org.eclipse.emf.ecore.resource.Resource contributor)

Returns a list of deltas generated by the session for a particular contributor.

Parameters:

contributor - a contributing resource

Returns:

a list of deltas

getConflicts

public java.util.List getConflicts()

Returns a list of conflicts generated by the session.

Returns:

a list of conflicts

getDeltaContainer

public DeltaContainer getDeltaContainer(org.eclipse.emf.ecore.resource.Resource contributor)

Returns a delta container generated by the session for a particular contributor.

Parameters:

contributor - a contributing resource

Returns:

delta container

getBaseResource

public org.eclipse.emf.ecore.resource.Resource getBaseResource()

Will retrieve the resource that is base resource all deltas generated against. In the case of three-way session it is the same a the Ancestor, in the case of two-way session it is the same as OLDER (Right) contributor.

Returns:

resource that is base for all deltas

getAncestorResource

public org.eclipse.emf.ecore.resource.Resource getAncestorResource()

Retrieves the Resouce for the Left contributor, or null

Returns:

the Resouce for the Left contributor, or null

getRightResource

public org.eclipse.emf.ecore.resource.Resource getRightResource()

Retrieves the Resouce for the Right contributor

Returns:

the Resouce for the Right contributor

getLeftResource

public org.eclipse.emf.ecore.resource.Resource getLeftResource()

Retrieves the Resouce for the Left contributor

Returns:

the Resouce for the Left contributor

setMergedResource

public void setMergedResource(org.eclipse.emf.ecore.resource.Resource resource)

getMergedResource

public org.eclipse.emf.ecore.resource.Resource getMergedResource()

Retrieves the Resouce for the Merged contributor, or null

Returns:

the Resouce for the Merged contributor, or null

getResource

public org.eclipse.emf.ecore.resource.Resource getResource(ContributorType contributor)

Retrieves the Resouce for the requested contributor.

Returns:

the Resouce for the requested contributor.

getResourceContributor

public ContributorType getResourceContributor(org.eclipse.emf.ecore.resource.Resource resource)

Determine the Contributor for a requested resource

Parameters:

resource - to find a contributor

Returns:

the contibutor for a requested resource

getDeltaContributor

public ContributorType getDeltaContributor(Delta delta)

Determine the Contributor that caused the requested delta

Parameters:

delta - for which to find the contributor

Returns:

the contibutor for a requested delta

getConflictDelta

public Delta getConflictDelta(Conflict conflict,
                              ContributorType contributor)

Finds a conflicting delta from the requested contributor

Parameters:

conflict - holding the Delta

contributor - causing the Delta to be found

Returns:

the actual delta

getIncrementCommand

public org.eclipse.emf.common.command.Command getIncrementCommand(ChangeDelta changeDelta,
                                                                  java.lang.Object newValue)

Instantiate and return a command , which will create delta increment and re-apply delta state (if accepted) Typicaly done to store results of merge subsession.

Parameters:

changeDelta - - change delta to be incremented

newValue - - new value for the delta increment

Returns:

- instance of the command

getClearSubsessionResultsCommand

public org.eclipse.emf.common.command.Command getClearSubsessionResultsCommand(ChangeDelta delta)

Parameters:

delta - - change delta which needs to be cleared from all the sub session results

Returns:

- Instantiate and return an instance of a command, which will clear given delta from all merge subsession results

getDecrementCommand

public org.eclipse.emf.common.command.Command getDecrementCommand(ChangeDelta changeDelta)

Instantiate and return a command , which will remove delta increment and re-apply delta state (if accepted) Typicaly done to erase results of merge subsession.

Parameters:

changeDelta - - change delta to be dencremented

Returns:

- instance of the command

sortDeltasByContributor

public java.util.List sortDeltasByContributor(java.util.List deltas)

Will create a new list containing all Deltas organized by therir contributors: Left is first, Right is second.

Parameters:

deltas - to sort

Returns:

sorted list

getDeltaForContributor

public Delta getDeltaForContributor(Conflict conflict,
                                    ContributorType contributor)

Will retrieve the conflicting Delta caused by a given Contributor.

Parameters:

conflict - caused by this delta

contributor - the delta is caused by. Contributor may only be ContributorType.LEFT or ContributorType.RIGHT

Returns:

Delta found

Throws:

java.lang.IllegalArgumentException - if nothing found

getConflictResolutionDelta

public Delta getConflictResolutionDelta(Conflict conflict)

Determines the Delta that was accepted to resolve the conflict

Parameters:

conflict - that was resolved using the requested Delta

Returns:

Delta or null if the Conflict is not resolved or ignored

getContentTypeID

public java.lang.String getContentTypeID()

Returns the content type ID for this session

Returns:

the content type ID or default EMF_CONTENT_TYPE_ID if none found

setContentType

public void setContentType(org.eclipse.core.runtime.content.IContentType contentType)

isClosureMode

public final boolean isClosureMode()

useReflectiveTypesAndNames

public final boolean useReflectiveTypesAndNames()

Checks if the reflective types and names should be used for rendering descriptions and labels

Returns:

true if reflective types and names should be used false otherwise

extractErrorMessage

protected java.lang.String extractErrorMessage(org.eclipse.emf.ecore.resource.Resource resource,
                                               java.lang.Exception ex,
                                               IInputOutputDescriptor desc)

Will extract the error message generated when loading the EMF Resource.

Parameters:

resource - to extract the error from

ex - the exception thrown by the EMF

Returns:

the localized error message

getUnresolvedDeltaCount

public int getUnresolvedDeltaCount()

Retrieves the total number of unresolved deltas in the merge session

Returns:

Returns the total number of unresolved deltas

getUnresolvedConflictCount

public int getUnresolvedConflictCount()

Retrieves the total number of unresolved conflicts in the merge session

Returns:

Returns the total number of unresolved conflicts.

getNonconflictingDeltas

public java.util.Set getNonconflictingDeltas(org.eclipse.emf.ecore.resource.Resource contributor)

Retrieves all the non conflicting deltas associated with the given contributor

Parameters:

contributor - Given contributor

Returns:

Set of non conflicting deltas.

getAcceptCommand

public org.eclipse.emf.common.command.Command getAcceptCommand(Delta delta)

Returns an accept command for the given delta

Parameters:

delta - Given delta

Returns:

The accept command

getAcceptDeltasCommand

public org.eclipse.emf.common.command.Command getAcceptDeltasCommand(java.util.List deltas)

Returns the fuse accept deltas command

Parameters:

deltas - Given list of deltas to accept

Returns:

The accept deltas command

getResolveDeltasCommand

public org.eclipse.emf.common.command.Command getResolveDeltasCommand(java.util.List deltas,
                                                                      ResolutionType resolution)

getRejectCommand

public org.eclipse.emf.common.command.Command getRejectCommand(Delta delta)

Returns a reject command for the given delta.

Parameters:

delta - Given delta

Returns:

The reject command

getChangeChangeConflictAcceptCommand

public org.eclipse.emf.common.command.Command getChangeChangeConflictAcceptCommand(Conflict conflict,
                                                                                   java.lang.Object v)

Returns an accept command for the change-change conflict

Parameters:

conflict - Given change-change conflict

v - New value to be accepted, used to identify the change delta that is going to be accepted with this command

Returns:

the accept command

getAcceptMergedValueCommand

public org.eclipse.emf.common.command.Command getAcceptMergedValueCommand(Delta delta,
                                                                          java.lang.Object mergedValue)

Creates accept command for add add conflict delta with the given merged value

Parameters:

delta - The target delta object

mergedValue - The value to be applied to the target merged model

Returns:

The accept command

getChangeChangeConflictRejectCommand

public org.eclipse.emf.common.command.Command getChangeChangeConflictRejectCommand(Conflict conflict)

Returns a reject command for the change-change conflict

Parameters:

conflict - Given change-change conflict

Returns:

the reject command

getCalculatedResourceIndex

public int getCalculatedResourceIndex(org.eclipse.emf.ecore.resource.Resource resource,
                                      Location location,
                                      Delta delta)

Return an index for a location of a delta calculated for a given resource which can be either Base, one of Contributors or Merged.

Parameters:

resource - in which to compute the index

location - Location containing index to be calculated

delta - delta whose location;s index to calculate

Returns:

calulated index

getCalculatedMergedIndex

public int getCalculatedMergedIndex(Location location,
                                    Delta delta)

Return an index for a location of a delta calculated to the merged resource.

Parameters:

location - Location containing index to calculated

delta - delta

Returns:

calulated index

getCalculatedBaseIndex

public int getCalculatedBaseIndex(Location location,
                                  Delta delta)

Return an index for a location of a delta calculated to the base resource.

Parameters:

location - Location containing index to calculated

delta - delta

Returns:

calulated index

getCalculatedContributorIndex

public int getCalculatedContributorIndex(Location location,
                                         Delta delta,
                                         org.eclipse.emf.ecore.resource.Resource contributor)

Return an index for a location of a delta calculated to the merged resource.

Parameters:

location - Location containing index to calculated

delta - delta

Returns:

calulated index

getDependentDeltas

public java.util.Collection getDependentDeltas(Delta delta,
                                               org.eclipse.emf.ecore.resource.Resource contributor,
                                               boolean accept)

Returns collectionf of other deltas in a given contributor that would also be accepted or rejected together with the given delta.

Parameters:

delta - for which to find other dependent deltas

contributor - causing the deltas to be retrieved of null for deltas from both contributors

accept - must be true for accept and false for reject

Returns:

dependent deltas including the composites and leaf deltas or empty collection

preExecuteRunnable

protected void preExecuteRunnable(IMergeManagerRunnable runnable)
                           throws java.lang.Exception

This method should always be called before executeRunnable method is called. It is used to do preprocessing for executeRunnable operation.

Parameters:

runnable -

Throws:

java.lang.Exception

executeRunnable

public java.lang.Object executeRunnable(IMergeManagerRunnable runnable)
                                 throws java.lang.Exception

A function used to perform some generic operation in a model-specific way. Subclasses may wrap the runnable in a required undo interval or similar. Normally used to accept/reject deltas or perform similar operations with the merged model.

Parameters:

runnable - to execute

Returns:

result of the execution

Throws:

java.lang.Exception

getTargetAffectedResources

protected void getTargetAffectedResources(java.util.List deltas,
                                          java.util.Set affectedResources)

This is a funciton used in fuse session mainly for validateEdit. Given a list of deltas. This method computes what resources (belong to target model of the fuse session) that will be affected (dirtied) after applying all the deltas from the list.

Parameters:

deltas - list of deltas

affectedResources - set of resources that will be dirtied.

getDescriptorAbsolutePath

protected static java.lang.String getDescriptorAbsolutePath(IInputOutputDescriptor desc)

Gets an absolute file path for the descriptor, if this is possible. There is not absolute file path in case descriptor represents a remote resource, such as history item or repository item.

Parameters:

desc - to get the absolute path for

Returns:

absolute file path, or null if it is not available

getDescriptorPlatformPath

protected static java.lang.String getDescriptorPlatformPath(IInputOutputDescriptor desc)

Will generate workspace-relative ("platform") path for a given descriptor or return null if the descriptor is stream-based or located outside of the workspace

Parameters:

desc - to get the platform path for

Returns:

platform path or null

getDeltaTreeFilters

public IDeltaTreeFilter[] getDeltaTreeFilters(org.eclipse.core.runtime.content.IContentType contentType)

getDefaultDeltaTreeFilters

protected IDeltaTreeFilter[] getDefaultDeltaTreeFilters()

getDefaultDeltaTreeSorter

public java.lang.String getDefaultDeltaTreeSorter()

getDeltaTreeSorters

public IDeltaTreeSorter[] getDeltaTreeSorters(org.eclipse.core.runtime.content.IContentType contentType)

getDefaultDeltaTreeSorters

protected IDeltaTreeSorter[] getDefaultDeltaTreeSorters()

getDeltaTreeBuilders

public IDeltaTreeBuilder[] getDeltaTreeBuilders(org.eclipse.core.runtime.content.IContentType contentType)

createDeltaTreeGrouper

protected IDeltaTreeGrouper createDeltaTreeGrouper(java.lang.String deltaTreeBuilderID)

getDefaultDeltaTreeBuilders

protected IDeltaTreeBuilder[] getDefaultDeltaTreeBuilders()

createLogicalModelMergeChangeSet

protected com.ibm.xtools.comparemerge.emf.internal.logicalmodel.ILogicalModelChangeSet createLogicalModelMergeChangeSet()

Creates the Logical model change set that is controlling the fragment loading

Returns:

the logical model change set

getInputStream

protected java.io.InputStream getInputStream(IInputOutputDescriptor descriptor)

getMultilineText

public java.lang.String getMultilineText(java.lang.Object deltaObject)

isMyFileMustBeMergeByMeInEclipseOnly

public boolean isMyFileMustBeMergeByMeInEclipseOnly()

isClosureRoot

public static boolean isClosureRoot(IInputOutputDescriptor descriptor)

Returns true if descriptor describes closure root

Parameters:

descriptor -

getPseudoConflicts

public java.util.List<PseudoConflict> getPseudoConflicts(Delta delta)

getUnresolveCommand

public org.eclipse.emf.common.command.Command getUnresolveCommand(Conflict c,
                                                                  java.util.List<?> src)

getChangeChangeConflictResetCommand

public org.eclipse.emf.common.command.Command getChangeChangeConflictResetCommand(Conflict conflict)

This commands reset resolution for change-change conflicts

Parameters:

conflict -

isTextChangeConflict

public boolean isTextChangeConflict(Conflict conflict)