com.ibm.xtools.comparemerge.emf.controller

Class EmfMergeController

java.lang.Object

AbstractStructureController

com.ibm.xtools.comparemerge.emf.controller.EmfMergeController

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener

public class EmfMergeController
extends AbstractStructureController
implements java.beans.PropertyChangeListener

The main Controller for the StructureViewer and ContentViewer.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INDENT

Constructor Summary

Constructors

Constructor and Description
EmfMergeController(EmfStructureMergeViewer viewer) Constructs a new EmfMergeController

Method Summary

Modifier and Type	Method and Description
boolean	canAutoAdvance() Determines if the Auto-Advance action can be enabled.
protected boolean	canSaveToLeftOrRight()
void	closeCompareMergeSession() Close C/M session, if any.
protected void	combine(java.util.List<Delta> allDeltas, java.util.Set<Delta> leftDeltas, java.util.Set<Delta> rightDeltas)
protected void	doSaveDeltas(java.lang.String toPath) Deprecated.
protected void	doSaveDeltas2(java.lang.String toPath) Saves the rendered representation of deltas to a specified file path.
ICommand	getAcceptAllCommand(java.lang.String label, ContributorType contributor) Returns the command accepting all Differences associated with the specified contributor and applying them to the Merged model.
ICommand	getAcceptAllNonconflictingCommand(java.lang.String label) Returns the command for accepting all Non-Conflicting Diffs from both contributors.
ICommand	getAcceptCommand(java.lang.String label, ContributorType contributor, IContentViewerInput input) Returns the command for accepting the specified contributor's difference and applying it to the Merged model If the Difference is a part of conflict, the Conflict will also be resolved, and the other conflicting Diff will be rejected.
ICommand	getAddAddConflictAcceptCommand(java.lang.String label, IContentViewerInput input, java.lang.Object mergedValue) Returns the command for resolve the conflict with given custom value.
ICommand	getChangeChangeConflictAcceptCommand(java.lang.String label, IContentViewerInput input, java.lang.Object customValue) Returns the command for resolve the conflict with given custom value.
ICommand	getChangeChangeConflictResetCommand(java.lang.String label, IContentViewerInput input, java.lang.Object customValue)
IConflictRenderer	getConflictRenderer() Returns a conflict renderer.
org.eclipse.core.runtime.content.IContentType	getContentType() Returns content type for the controller.
IDifferenceRenderer	getDifferenceRenderer() Returns a difference renderer.
EmfMergeManager	getEmfMergeManager() Returns the EMF merge manager.
ICommand	getIgnoreAllCommand(java.lang.String label) Returns the command for ignoring ALL conflicts in the current MergeSession.
ICommand	getIgnoreCommand(java.lang.String label, IContentViewerInput input) Returns the command for Ignoring the Conflict.
ICommand	getIgnoreGroupedConflictCommand(java.lang.String label, IContentViewerInput input) Constructs command to ignore the "Grouped Conflict" - an artificial conflict consisting of several other conflicts.
java.lang.Object	getProperty(java.lang.String key)
ICommand	getProxyCommand(java.lang.String label, java.util.Collection emfCommands) Returns a proxy command for the specified EMF commands
ICommand	getRejectAllCommand(java.lang.String label, ContributorType contributor) Returns the command for rejecting ALL Differences from specified contributor.
ICommand	getRejectCommand(java.lang.String label, ContributorType contributor, IContentViewerInput input) Returns the command for rejecting the specified contributor's Difference.
ICommand	getResolveAllCommand(java.lang.String label, ContributorType contributor) Returns the command for resolving ALL Conflicts using the specified contributor.
ICommand	getResolveCommand(java.lang.String label, ContributorType contributor, IContentViewerInput input) Returns the command for resolving the Conflict by accepting the conflicting Difference from a specified Contributor
ICommand	getResolveGroupedConflictCommand(java.lang.String label, ContributorType contributor, IContentViewerInput input) Constructs command to resolve the "Grouped Conflict" - an artificial conflict consisting of several other conflicts - with a given contributor.
void	propertyChange(java.beans.PropertyChangeEvent event) This method is called from the EMF Compare/Merge back end when the Delta or Conflict is resolved.
void	saveMergedContributorAs(ContributorType contributor)
void	saveMergedContributorCopy()
java.lang.String	translateUnprintables(java.lang.String s) Translates unprintable characters.

Methods inherited from class java.lang.Object

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

Field Detail

INDENT

public static final java.lang.String INDENT

See Also:

Constant Field Values

Constructor Detail

EmfMergeController

public EmfMergeController(EmfStructureMergeViewer viewer)

Constructs a new EmfMergeController

Parameters:

viewer - the associated EmfStructureMergeViewer

Method Detail

getDifferenceRenderer

public IDifferenceRenderer getDifferenceRenderer()

Returns a difference renderer.

Returns:

a difference renderer

getConflictRenderer

public IConflictRenderer getConflictRenderer()

Returns a conflict renderer.

Returns:

a conflict renderer

closeCompareMergeSession

public void closeCompareMergeSession()

Close C/M session, if any. Must also refresh other panes (Structure Pane, Content Pane, Merged Pane). Should also notify the IMergeStatusCallback about the status of the session - COMPLETED, FAILED, CANCELLED etc.

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#closeCompareMergeSession()

canAutoAdvance

public boolean canAutoAdvance()

Determines if the Auto-Advance action can be enabled.

Returns:

Returns true if the Auto-Advance action can be enabled.

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#canAutoAdvance()

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent event)

This method is called from the EMF Compare/Merge back end when the Delta or Conflict is resolved. Might be useful to refresh the sate of the tree nodes.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

See Also:

PropertyChangeListener.propertyChange(java.beans.PropertyChangeEvent)

getAcceptCommand

public ICommand getAcceptCommand(java.lang.String label,
                                 ContributorType contributor,
                                 IContentViewerInput input)

Returns the command for accepting the specified contributor's difference and applying it to the Merged model
If the Difference is a part of conflict, the Conflict will also be resolved, and the other conflicting Diff will be rejected.

Parameters:

label - for the new ICommand.

contributor - the source contributor (for e.g. ContributorType.LEFT) to accept the Difference from

input - the compare merge input object that holds the Difference to be accepted

Returns:

the command to be executed or null if none

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#getAcceptCommand(java.lang.String, com.ibm.xtools.comparemerge.core.utils.ContributorType, com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput)

getAcceptAllCommand

public ICommand getAcceptAllCommand(java.lang.String label,
                                    ContributorType contributor)

Returns the command accepting all Differences associated with the specified contributor and applying them to the Merged model.
If the Difference is a part of conflict, the Conflict will also be resolved.

Parameters:

label - for the new ICommand.

contributor - the source contributor (for e.g. ContributorType.LEFT) to accept all Diffs from.

Returns:

the command to be executed or null if none

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#getAcceptAllCommand(java.lang.String, com.ibm.xtools.comparemerge.core.utils.ContributorType)

getAcceptAllNonconflictingCommand

public ICommand getAcceptAllNonconflictingCommand(java.lang.String label)

Returns the command for accepting all Non-Conflicting Diffs from both contributors. Differences causing a conflict will not be affected.

Returns:

the command to be executed or null if none

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#getAcceptAllNonconflictingCommand(java.lang.String)

combine

protected void combine(java.util.List<Delta> allDeltas,
                       java.util.Set<Delta> leftDeltas,
                       java.util.Set<Delta> rightDeltas)

getRejectCommand

public ICommand getRejectCommand(java.lang.String label,
                                 ContributorType contributor,
                                 IContentViewerInput input)

Returns the command for rejecting the specified contributor's Difference. Rejecting the conflicting Difference MAY resolve the conflict.

Parameters:

label - for the new ICommand.

contributor - the contributor (for e.g. ContributorType.LEFT) to rejects the Difference from

input - the compare merge input object that holds the Difference to be rejected

Returns:

the command to be executed or null if none

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#getRejectCommand(java.lang.String, com.ibm.xtools.comparemerge.core.utils.ContributorType, com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput)

getRejectAllCommand

public ICommand getRejectAllCommand(java.lang.String label,
                                    ContributorType contributor)

Returns the command for rejecting ALL Differences from specified contributor. Rejecting the conflicting Difference MAY resolve the conflict.

Parameters:

label - for the new ICommand.

contributor - to reject all Differences from

Returns:

the command to be executed or null if none

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#getRejectAllCommand(java.lang.String, com.ibm.xtools.comparemerge.core.utils.ContributorType)

getResolveCommand

public ICommand getResolveCommand(java.lang.String label,
                                  ContributorType contributor,
                                  IContentViewerInput input)

Returns the command for resolving the Conflict by accepting the conflicting Difference from a specified Contributor

Parameters:

label - for the new ICommand.

contributor - to reject all Differences from

input - the compare merge input object that holds the Conflict to be resolved

Returns:

the command to be executed or null if none

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#getResolveCommand(java.lang.String, com.ibm.xtools.comparemerge.core.utils.ContributorType, com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput)

getResolveAllCommand

public ICommand getResolveAllCommand(java.lang.String label,
                                     ContributorType contributor)

Returns the command for resolving ALL Conflicts using the specified contributor. All non-conflicting Diffs will not be affected.

Parameters:

label - for the new ICommand.

contributor - to resolve all Conflicts with

Returns:

the command to be executed or null if none

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#getResolveAllCommand(java.lang.String, com.ibm.xtools.comparemerge.core.utils.ContributorType)

getIgnoreCommand

public ICommand getIgnoreCommand(java.lang.String label,
                                 IContentViewerInput input)

Returns the command for Ignoring the Conflict. This will reject all Differences causing this Conflict an will keep the Ancestor's value

Parameters:

label - for the new ICommand.

input - the compare merge input object that holds the Conflict to be ignored

Returns:

the command to be executed or null if none

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#getIgnoreCommand(java.lang.String, com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput)

getIgnoreAllCommand

public ICommand getIgnoreAllCommand(java.lang.String label)

Returns the command for ignoring ALL conflicts in the current MergeSession. All conflicting Diffs (from both contributors) will be rejected. All non-conflicting Diffs will not be affected.

Parameters:

label - for the new ICommand.

Returns:

the command to be executed or null if none

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#getIgnoreAllCommand(java.lang.String)

getIgnoreGroupedConflictCommand

public ICommand getIgnoreGroupedConflictCommand(java.lang.String label,
                                                IContentViewerInput input)

Constructs command to ignore the "Grouped Conflict" - an artificial conflict consisting of several other conflicts. When the command is executed, they all will be ignored.

Parameters:

input - - the currently selected Grouped Conflict

getResolveGroupedConflictCommand

public ICommand getResolveGroupedConflictCommand(java.lang.String label,
                                                 ContributorType contributor,
                                                 IContentViewerInput input)

Constructs command to resolve the "Grouped Conflict" - an artificial conflict consisting of several other conflicts - with a given contributor. When the command is executed, all child conflicts are resolved.

Parameters:

contributor - to resolve the conflict with

input - - the currently selected Grouped Conflict

getProxyCommand

public ICommand getProxyCommand(java.lang.String label,
                                java.util.Collection emfCommands)

Returns a proxy command for the specified EMF commands

Parameters:

label - the label for the proxy command

emfCommands - the collection of EMF commands

Returns:

the proxy command

getEmfMergeManager

public EmfMergeManager getEmfMergeManager()

Returns the EMF merge manager.

Returns:

the EMF merge manager

doSaveDeltas2

protected void doSaveDeltas2(java.lang.String toPath)
                      throws java.io.IOException

Saves the rendered representation of deltas to a specified file path.

Parameters:

toPath - the file path to save to

Throws:

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

doSaveDeltas

@Deprecated
protected void doSaveDeltas(java.lang.String toPath)
                                  throws java.io.IOException

Deprecated.

Saves the rendered representation of deltas to a specified file path.

Parameters:

toPath - the file path to save to

Throws:

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

translateUnprintables

public java.lang.String translateUnprintables(java.lang.String s)

Translates unprintable characters. Override if you have other translations to add, but always return super(). NOTE: This function should ONLY translate those characters that cannot be printed to a file. For example, the '<<' character is translated to discrete '<' + '<' so the file is displayable on Linux. Other translations (e.g. \n, \t, etc) are handled in the DefaultDifferenceRenderer.

Parameters:

s - -- string in

Returns:

String -- translated result

saveMergedContributorCopy

public void saveMergedContributorCopy()

canSaveToLeftOrRight

protected boolean canSaveToLeftOrRight()

saveMergedContributorAs

public void saveMergedContributorAs(ContributorType contributor)
                             throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

getProperty

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

getChangeChangeConflictAcceptCommand

public ICommand getChangeChangeConflictAcceptCommand(java.lang.String label,
                                                     IContentViewerInput input,
                                                     java.lang.Object customValue)

Returns the command for resolve the conflict with given custom value.

Parameters:

label - for the new ICommand.

customValue - override value for the merge target

See Also:

com.ibm.xtools.comparemerge.ui.controller.ICompareMergeController#getChangeChangeConflictAcceptCommand(java.lang.String, com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput, java.lang.Object)

getChangeChangeConflictResetCommand

public ICommand getChangeChangeConflictResetCommand(java.lang.String label,
                                                    IContentViewerInput input,
                                                    java.lang.Object customValue)

getAddAddConflictAcceptCommand

public ICommand getAddAddConflictAcceptCommand(java.lang.String label,
                                               IContentViewerInput input,
                                               java.lang.Object mergedValue)

Returns the command for resolve the conflict with given custom value.

Parameters:

label - for the new ICommand.

mergedValue - override value for the merge target

getContentType

public org.eclipse.core.runtime.content.IContentType getContentType()

Returns content type for the controller. NOTE: Clients should use this method since it handles closure mode. Direct access to content type manager should not be used