com.ibm.xtools.comparemerge.emf.renderer

Class DefaultDifferenceRenderer

java.lang.Object

com.ibm.xtools.comparemerge.emf.renderer.DefaultDifferenceRenderer

All Implemented Interfaces:

IDifferenceRenderer, org.eclipse.core.runtime.IExecutableExtension

public class DefaultDifferenceRenderer
extends java.lang.Object
implements IDifferenceRenderer

This class provides default implementation of IDifferenceRenderer interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultDifferenceRenderer.ProxyLabelProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.emf.common.notify.AdapterFactory	_adapterFactory AdapterFactory used by this differenceRenderer
protected EmfMergeManager	_mergeManager MergeManager used by this mergeManager
protected static int	MAX_VISIBLE_CONTENT_LENGTH Maximum length of difference/conflict's short description.

Constructor Summary

Constructors

Constructor and Description
DefaultDifferenceRenderer() Constructs a new DefaultDifferenceRenderer
DefaultDifferenceRenderer(org.eclipse.emf.common.notify.AdapterFactory adapterFactory, EmfMergeManager mergeManager) Constructs a new DefaultDifferenceRenderer

Method Summary

Modifier and Type	Method and Description
static boolean	addColorMapEntry(org.eclipse.swt.graphics.RGB rgb, java.lang.String colorName) Adds the given pair of RGB and color name to the ColorMap
protected java.lang.Object	findMatchingObjectInFeature_1(java.lang.String find_matching_object_id, org.eclipse.emf.ecore.resource.Resource in_resource, Location at_location, java.lang.Object affected_object)
static java.lang.String	getColorName(org.eclipse.swt.graphics.RGB rgb) Retrieves the color name associated with the given RGB
static java.util.Map	getColorNamesMap() Retrieves an unmodifiable copy of the current color name map
java.lang.String	getContentType() Returns the content type against which this extension is bound.
protected java.lang.String	getContributorStr(Delta delta) Find the contributor of the given delta and then retrieves a string representation of the contributor.
protected java.lang.String	getEObjectStr(org.eclipse.emf.ecore.EObject object) Retrieves a string representation of the given EObject.
protected java.lang.String	getEObjectStrInResource(org.eclipse.emf.ecore.resource.Resource resource, java.lang.String id)
protected DefaultDifferenceRenderer.ProxyLabelProvider	getItemLabelProvider(java.lang.Object object) Retrieves the item provider adapter of the given object
protected java.lang.String	getLocalizeFeatureName(org.eclipse.emf.ecore.EStructuralFeature feature)
protected java.lang.String	getLocationStr(org.eclipse.emf.ecore.resource.Resource base, org.eclipse.emf.ecore.resource.Resource contrib, Location location, boolean fromloc, boolean isAdd) Provides a string representation of the given location.
java.lang.String	getNameForNavigation(Delta context, org.eclipse.emf.ecore.EObject eObject) Returns the nave of the delta object to use for navigation commands.
java.lang.String	getObjectStr(java.lang.Object object) Retrieves the string representation of the given object.
int	getPriority() This method is use only when there is more than one difference renderers registered for the same content type.
protected java.lang.String	interpretArrayValue(Location location, java.lang.Object value) This method tries its best to provide a string representation of the given array.
protected java.lang.String	interpretChangedValue(Location location, java.lang.Object value)
protected java.lang.String	interpretCollection(Location location, java.lang.Object value) This method tries its best to provide a string representation of the given collection.
protected boolean	needFeatureDescription(Delta delta)
protected java.lang.String	prepareValue(java.lang.String s) Prepare a string representation for better screen display.
static java.lang.String	quote(java.lang.String text, java.lang.String quote)
java.lang.String	renderDescription(Delta delta) Renders a description to be shown in the description viewer when a difference is selected
java.lang.String	renderDescriptionAdd(Delta delta) Provides a detailed description of the given add delta.
java.lang.String	renderDescriptionChange(Delta delta) Provides a detailed description of the given change delta.
java.lang.String	renderDescriptionDelete(Delta delta) Provides a detailed description of the given delete delta.
java.lang.String	renderDescriptionJoin(Delta delta) Provides a detailed description of the given join delta.
java.lang.String	renderDescriptionMorph(Delta delta) Provides a detailed description of the given morph delta.
java.lang.String	renderDescriptionMove(Delta delta) Provide a detailed description of the given move delta.
java.lang.String	renderDescriptionSeparation(Delta delta) Provides a detailed description of the given separation delta.
java.lang.String	renderShortName(Delta delta) Renders a short name to be shown as a difference label in the tree
java.lang.String	renderShortNameAdd(Delta delta) Provides a short string description of the given add delta.
java.lang.String	renderShortNameChange(Delta delta) Provides a short string description of the given change delta.
java.lang.String	renderShortNameChangePresentable(Delta delta) Provides a short string description of the given change delta.
java.lang.String	renderShortNameChangePresentable(Delta delta, java.lang.String changedobjstr)
java.lang.String	renderShortNameDelete(Delta delta) Provides a short string description of the given delete delta.
java.lang.String	renderShortNameJoin(Delta delta) Provides a short string description of the given join delta.
java.lang.String	renderShortNameListChange(java.lang.Object[] args, ChangeDelta changeDelta, Location location, java.lang.String changedobjstr)
java.lang.String	renderShortNameMorph(Delta delta) Provides a short string description of the given morph delta.
java.lang.String	renderShortNameMove(Delta delta) Provides a short string description of the given move delta.
java.lang.String	renderShortNameSeparation(Delta delta) Provides a short string description of the given separation delta.
protected java.lang.String	renderStructuralFeatureValue(org.eclipse.emf.ecore.EStructuralFeature feature, java.lang.Object o) Override this if you want to take a crack at certain features or object types
void	set_adapterFactory(org.eclipse.emf.common.notify.AdapterFactory factory) Sets adapterFactory to be used by DifferenceRenderer
void	set_mergeManager(EmfMergeManager manager) Sets merge manager to be used by DifferenceRenderer
void	setAlternateDifferenceRendering(boolean b) sets alternate difference rendering in case of duplicate rendering.
void	setInitializationData(org.eclipse.core.runtime.IConfigurationElement config, java.lang.String propertyName, java.lang.Object data) This method is called by the implementation of the method IConfigurationElement.createExecutableExtension on a newly constructed extension, passing it its relevant configuration information.
protected java.lang.String	translateUnprintables(java.lang.String s) Translates control characters into their string representations.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_VISIBLE_CONTENT_LENGTH

protected static int MAX_VISIBLE_CONTENT_LENGTH

Maximum length of difference/conflict's short description.

_adapterFactory

protected org.eclipse.emf.common.notify.AdapterFactory _adapterFactory

AdapterFactory used by this differenceRenderer

_mergeManager

protected EmfMergeManager _mergeManager

MergeManager used by this mergeManager

Constructor Detail

DefaultDifferenceRenderer

public DefaultDifferenceRenderer(org.eclipse.emf.common.notify.AdapterFactory adapterFactory,
                                 EmfMergeManager mergeManager)

Constructs a new DefaultDifferenceRenderer

Parameters:

adapterFactory - instance of adapterFactory

mergeManager - instance of mergeManager

DefaultDifferenceRenderer

public DefaultDifferenceRenderer()

Constructs a new DefaultDifferenceRenderer

Method Detail

set_adapterFactory

public void set_adapterFactory(org.eclipse.emf.common.notify.AdapterFactory factory)

Sets adapterFactory to be used by DifferenceRenderer

Parameters:

factory - instance of adapterFactory to be used by DifferenceRenderer

set_mergeManager

public void set_mergeManager(EmfMergeManager manager)

Sets merge manager to be used by DifferenceRenderer

Parameters:

manager - instance of merge manager to be used by DifferenceRenderer

getContentType

public java.lang.String getContentType()

Description copied from interface: IDifferenceRenderer

Returns the content type against which this extension is bound.

Specified by:

getContentType in interface IDifferenceRenderer

Returns:

string representing the content ID

See Also:

IDifferenceRenderer.getContentType()

addColorMapEntry

public static boolean addColorMapEntry(org.eclipse.swt.graphics.RGB rgb,
                                       java.lang.String colorName)

Adds the given pair of RGB and color name to the ColorMap

Parameters:

rgb - - an RGB object representing a specific 24-bit color

colorName - - a localized text color name

Returns:

true if the entry was added, false if it was already there

getColorNamesMap

public static final java.util.Map getColorNamesMap()

Retrieves an unmodifiable copy of the current color name map

Returns:

an unmodifiable copy of the current color name map

getColorName

public static final java.lang.String getColorName(org.eclipse.swt.graphics.RGB rgb)

Retrieves the color name associated with the given RGB

Parameters:

rgb - - an RGB object representing a specific 24-bit color

Returns:

that color's localized name

findMatchingObjectInFeature_1

protected java.lang.Object findMatchingObjectInFeature_1(java.lang.String find_matching_object_id,
                                                         org.eclipse.emf.ecore.resource.Resource in_resource,
                                                         Location at_location,
                                                         java.lang.Object affected_object)

translateUnprintables

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

Translates control characters into their string representations.

Parameters:

s - -- string to translate

Returns:

-- translated string Note: You may override this to provide your own translation of any characters, but you should call super(s) before returning to complete the translation.

prepareValue

protected final java.lang.String prepareValue(java.lang.String s)

Prepare a string representation for better screen display.

Parameters:

s - Given string

Returns:

Prepared string

interpretChangedValue

protected final java.lang.String interpretChangedValue(Location location,
                                                       java.lang.Object value)

renderStructuralFeatureValue

protected java.lang.String renderStructuralFeatureValue(org.eclipse.emf.ecore.EStructuralFeature feature,
                                                        java.lang.Object o)

Override this if you want to take a crack at certain features or object types

Parameters:

feature - -- the structural feature from which the attribute value was taken

o - -- a java object, usually a string or integer but can be anything

Returns:

-- a string representing the best representation of the value or null if you want default handling

interpretArrayValue

protected java.lang.String interpretArrayValue(Location location,
                                               java.lang.Object value)

This method tries its best to provide a string representation of the given array.

Parameters:

location - Each array has many elements. Each element may have many attributes/features. Location is used to identify a particular attribute/feature within the elements.

value - Given array

Returns:

String representation of the array

interpretCollection

protected java.lang.String interpretCollection(Location location,
                                               java.lang.Object value)

This method tries its best to provide a string representation of the given collection.

Parameters:

location - Each collection has many elements. Each element may have many attributes/features. Location is used to identify a particular attribute/feature within the elements.

value - Given collection

Returns:

String representation of the collection

getLocationStr

protected java.lang.String getLocationStr(org.eclipse.emf.ecore.resource.Resource base,
                                          org.eclipse.emf.ecore.resource.Resource contrib,
                                          Location location,
                                          boolean fromloc,
                                          boolean isAdd)

Provides a string representation of the given location.

Parameters:

base - Base Resource

contrib - Contributor Resource

location - Given location

fromloc - If true, string representation of location is with respect to base resource. Otherwise, it is with respect to contributor resource.

isAdd - Determines if the location is associated with an add delta

Returns:

String representation of the given location.

getEObjectStrInResource

protected java.lang.String getEObjectStrInResource(org.eclipse.emf.ecore.resource.Resource resource,
                                                   java.lang.String id)

getItemLabelProvider

protected DefaultDifferenceRenderer.ProxyLabelProvider getItemLabelProvider(java.lang.Object object)

Retrieves the item provider adapter of the given object

Parameters:

object - Given object

Returns:

The item provider adapter of the given object.

getEObjectStr

protected java.lang.String getEObjectStr(org.eclipse.emf.ecore.EObject object)

Retrieves a string representation of the given EObject.

Parameters:

object - Give EObject

Returns:

string representation of the EObject.

getContributorStr

protected java.lang.String getContributorStr(Delta delta)

Find the contributor of the given delta and then retrieves a string representation of the contributor.

Parameters:

delta - Given delta

Returns:

String representation of the given delta.

getObjectStr

public java.lang.String getObjectStr(java.lang.Object object)

Retrieves the string representation of the given object.

Parameters:

object - The given object

Returns:

String representation of the given object.

renderShortNameAdd

public java.lang.String renderShortNameAdd(Delta delta)

Provides a short string description of the given add delta.

Parameters:

delta - Given delta

Returns:

string description of the give delta.

renderDescriptionAdd

public java.lang.String renderDescriptionAdd(Delta delta)

Provides a detailed description of the given add delta.

Parameters:

delta - Given delta

Returns:

detailed description of the given delta.

renderShortNameDelete

public java.lang.String renderShortNameDelete(Delta delta)

Provides a short string description of the given delete delta.

Parameters:

delta - Given delta

Returns:

string description of the give delta.

renderDescriptionDelete

public java.lang.String renderDescriptionDelete(Delta delta)

Provides a detailed description of the given delete delta.

Parameters:

delta - Given delta

Returns:

detailed description of the given delta.

renderShortNameChange

public java.lang.String renderShortNameChange(Delta delta)

Provides a short string description of the given change delta.

Parameters:

delta - Given delta

Returns:

string description of the give delta.

renderShortNameListChange

public java.lang.String renderShortNameListChange(java.lang.Object[] args,
                                                  ChangeDelta changeDelta,
                                                  Location location,
                                                  java.lang.String changedobjstr)

renderShortNameChangePresentable

public java.lang.String renderShortNameChangePresentable(Delta delta)

Provides a short string description of the given change delta.

Parameters:

delta - Given delta

Returns:

string description of the give delta.

renderShortNameChangePresentable

public java.lang.String renderShortNameChangePresentable(Delta delta,
                                                         java.lang.String changedobjstr)

needFeatureDescription

protected boolean needFeatureDescription(Delta delta)

getLocalizeFeatureName

protected java.lang.String getLocalizeFeatureName(org.eclipse.emf.ecore.EStructuralFeature feature)

renderDescriptionChange

public java.lang.String renderDescriptionChange(Delta delta)

Provides a detailed description of the given change delta.

Parameters:

delta - Given delta

Returns:

detailed description of the given delta.

renderShortNameMove

public java.lang.String renderShortNameMove(Delta delta)

Provides a short string description of the given move delta.

Parameters:

delta - Given delta

Returns:

string description of the give delta.

renderDescriptionMove

public java.lang.String renderDescriptionMove(Delta delta)

Provide a detailed description of the given move delta.

Parameters:

delta - Given delta

Returns:

detailed description of the given delta.

renderShortNameJoin

public java.lang.String renderShortNameJoin(Delta delta)

Provides a short string description of the given join delta.

Parameters:

delta - Given delta

Returns:

string description of the give delta.

renderDescriptionJoin

public java.lang.String renderDescriptionJoin(Delta delta)

Provides a detailed description of the given join delta.

Parameters:

delta - Given delta

Returns:

detailed description of the given delta.

renderShortNameSeparation

public java.lang.String renderShortNameSeparation(Delta delta)

Provides a short string description of the given separation delta.

Parameters:

delta - Given delta

Returns:

string description of the give delta.

renderDescriptionSeparation

public java.lang.String renderDescriptionSeparation(Delta delta)

Provides a detailed description of the given separation delta.

Parameters:

delta - Given delta

Returns:

detailed description of the given delta.

renderShortNameMorph

public java.lang.String renderShortNameMorph(Delta delta)

Provides a short string description of the given morph delta.

Parameters:

delta - Given delta

Returns:

string description of the give delta.

renderDescriptionMorph

public java.lang.String renderDescriptionMorph(Delta delta)

Provides a detailed description of the given morph delta.

Parameters:

delta - Given delta

Returns:

detailed description of the given delta.

renderShortName

public java.lang.String renderShortName(Delta delta)

Description copied from interface: IDifferenceRenderer

Renders a short name to be shown as a difference label in the tree

Specified by:

renderShortName in interface IDifferenceRenderer

Parameters:

delta - to render the name for

Returns:

generated string

See Also:

IDifferenceRenderer.renderShortName(com.ibm.xtools.comparemerge.emf.delta.Delta)

renderDescription

public java.lang.String renderDescription(Delta delta)

Description copied from interface: IDifferenceRenderer

Renders a description to be shown in the description viewer when a difference is selected

Specified by:

renderDescription in interface IDifferenceRenderer

Parameters:

delta - to render the description for

Returns:

generated string

See Also:

IDifferenceRenderer.renderDescription(com.ibm.xtools.comparemerge.emf.delta.Delta)

setInitializationData

public void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config,
                                  java.lang.String propertyName,
                                  java.lang.Object data)
                           throws org.eclipse.core.runtime.CoreException

This method is called by the implementation of the method IConfigurationElement.createExecutableExtension on a newly constructed extension, passing it its relevant configuration information. Most executable extensions only make use of the first two call arguments.

Specified by:

setInitializationData in interface org.eclipse.core.runtime.IExecutableExtension

Parameters:

config - the configuration element used to trigger this execution. It can be queried by the executable extension for specific configuration properties

propertyName - the name of an attribute of the configuration element used on the createExecutableExtension(String) call. This argument can be used in the cases where a single configuration element is used to define multiple executable extensions.

data - adapter data in the form of a String, a Hashtable, or null.

Throws:

org.eclipse.core.runtime.CoreException - if error(s) detected during initialization processing

See Also:

IExecutableExtension.setInitializationData(org.eclipse.core.runtime.IConfigurationElement, java.lang.String, java.lang.Object)

getPriority

public int getPriority()

This method is use only when there is more than one difference renderers registered for the same content type. In this case, we pick the object with highest priority. The default implementation is based on the depth of extended classes.

Returns:

The priority of this object. bigger positive number means higher priority.

setAlternateDifferenceRendering

public void setAlternateDifferenceRendering(boolean b)

Description copied from interface: IDifferenceRenderer

sets alternate difference rendering in case of duplicate rendering.

Specified by:

setAlternateDifferenceRendering in interface IDifferenceRenderer

quote

public static java.lang.String quote(java.lang.String text,
                                     java.lang.String quote)

getNameForNavigation

public java.lang.String getNameForNavigation(Delta context,
                                             org.eclipse.emf.ecore.EObject eObject)

Description copied from interface: IDifferenceRenderer

Returns the nave of the delta object to use for navigation commands.

Specified by:

getNameForNavigation in interface IDifferenceRenderer