com.ibm.xtools.comparemerge.emf.viewers

Class EmfInputInterpreter

java.lang.Object

AbstractInputInterpreter

com.ibm.xtools.comparemerge.emf.viewers.EmfInputInterpreter

public class EmfInputInterpreter
extends AbstractInputInterpreter

Interpreter for default EMF viewers

Field Summary

Fields

Modifier and Type	Field and Description
static ViewModeDescriptor	EMF_LIST_DESC EMF list view mode descriptor
static ViewModeDescriptor	EMF_NULL_DESC Null view mode descriptor.
static ViewModeDescriptor	EMF_PROPERTY_DESC EMF property view mode descriptor
static ViewModeDescriptor	EMF_STRUCTURE_DESC EMF structure view mode descriptor
static ViewModeDescriptor	MULTILINETEXT_DESC Mulitiline text list view mode descriptor

Constructor Summary

Constructors

Constructor and Description
EmfInputInterpreter(IContentViewerPane contentViewerPane) Constructs a new EmfInputIterpreter

Method Summary

Modifier and Type	Method and Description
boolean	canBrowseContext(ViewModeDescriptor sourceViewMode, ViewModeDescriptor targetViewMode, org.eclipse.jface.viewers.ISelection selection) Allows the interpreter to decide if in browse mode the selections from the specified source view mode can be set as as the input to the specified target view mode.
protected boolean	canBrowseCustomContext(ViewModeDescriptor sourceViewMode, ViewModeDescriptor targetViewMode, org.eclipse.jface.viewers.ISelection selection) Allows the interpreter to decide if in browse mode the selections from the specified source view mode can be set as as the input to the specified target view mode.
boolean	canSupportInput(IContentViewerInput input) Checks if the specified input can be handled by the interpreter.
protected static boolean	canSupportViewMode(ViewModeDescriptor viewMode) Checks if the view mode is an EMF view mode
protected java.lang.Object	createMultilineContext(Delta delta) Creates the multi line context object
protected java.lang.Object	createTextInput(java.lang.String text, java.lang.String fileExtension)
protected Delta	extractDelta(IContentViewerInput input) Will find an information about the Delta represented by the input .
protected static java.lang.Object	findPropertyEntry(java.lang.Object feature, IViewerData viewerData) Find the content for the property viewer
protected IContentDescriptor	getAffectedDescriptor(java.util.List<?> contents, java.lang.Object affectedObject, java.lang.Object parentObject)
protected java.lang.String	getAssociatedFileType(Delta delta) Finds and return the file type associated with the given delta.
java.util.List	getBrowseViewModes(IContentViewerInput input) Returns the list of browse view modes for the specified input.
protected IContentDescriptor	getContent(IContentViewerInput input, ViewModeDescriptor requestedViewMode) Returns the content for the EMF viewers
protected java.lang.Object	getContext(IContentViewerInput input, ViewModeDescriptor requestedViewMode) Returns the context for the default EMF viewers
java.util.List	getCurrentViewModes(IContentViewerInput input) Returns the list of current view modes for the specified input.
protected java.util.List	getCurrentViewModes(IContentViewerInput input, boolean showEmfViews)
protected java.util.List	getCustomBrowseViewModes(IContentViewerInput input, java.util.List currentBrowseViewModes) Returns the list of custom browse view modes for the specified input.
protected java.util.List	getCustomCurrentViewModes(IContentViewerInput input, java.util.List currentDefaultViewModes) Returns the custom current view modes
protected static Delta	getFirstLeafDelta(Delta delta) Returns the first leaf delta by inspecting the children of the specified delta
protected Location	getLocation(Delta delta, org.eclipse.emf.ecore.resource.Resource resource) Return the location for the specified delta and contributor resource
protected EmfMergeManager	getMergeManager() Returns the merge manager associated with the current session
protected java.lang.String	getMultilineContent(Delta delta, boolean newValue, ContributorType contributorType) Retrieves the the multi line text from the given delta
DeleteDelta	getParentDeleteDelta(java.lang.String objectId, DeltaContainer deltaContainer) Return the delta associated with the deletion of the parent of the specified object id
protected org.eclipse.emf.ecore.resource.Resource	getPrimaryResource() Retrieves reference to the EMF Resource that is displayed in the IContentViewerPane this interpreter is serving.
protected boolean	isHandlingContributor(ContributorType contributorType) Checks if this interpreter is associated with the contributor type
protected boolean	isMultilineContent(Delta delta) Verifies whether the delta is related to multi lines or long line text changes
protected static void	revealContent(IContentDescriptor descriptor, IViewerData viewerData) Reveal the content in the viewer
IContentDescriptor	revealContent(IContentViewerInput input, IViewerData viewerData) Reveals the content associated with the current input within the context of the specified content viewer.
protected IContentDescriptor	revealCustomContent(IContentViewerInput input, IViewerData viewerData) Reveals the custom content for the specified input and viewer
boolean	setBrowseContext(org.eclipse.jface.viewers.ISelection selection, IViewerData viewerData) Sets the browse context associated with the current selection within the specified content viewer.
boolean	setContext(IContentViewerInput input, IViewerData viewerData, boolean force) Sets the context associated with the current input within the specified content viewer.
protected boolean	setCustomBrowseContext(org.eclipse.jface.viewers.ISelection selection, IViewerData viewerData) Sets the custom browse context associated with the current selection within the specified content viewer.
protected boolean	setCustomContext(IContentViewerInput input, IViewerData viewerData, boolean force) Sets the custom context for the specified input and viewer
boolean	setInitialBrowseContext(IContentViewerInput input, IViewerData viewerData) Sets the default browse context associated with the current input within the specified content viewer.
protected boolean	setInitialCustomBrowseContext(IContentViewerInput input, IViewerData viewerData) Sets the intial custom browse context associated with the current input within the specified content viewer.
protected static void	setInput(java.lang.Object input, IViewerData viewerData, boolean force) Sets the input to the viewer

Methods inherited from class java.lang.Object

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

Field Detail

EMF_STRUCTURE_DESC

public static final ViewModeDescriptor EMF_STRUCTURE_DESC

EMF structure view mode descriptor

EMF_PROPERTY_DESC

public static final ViewModeDescriptor EMF_PROPERTY_DESC

EMF property view mode descriptor

EMF_LIST_DESC

public static final ViewModeDescriptor EMF_LIST_DESC

EMF list view mode descriptor

EMF_NULL_DESC

public static final ViewModeDescriptor EMF_NULL_DESC

Null view mode descriptor. Used in error situation.

MULTILINETEXT_DESC

public static final ViewModeDescriptor MULTILINETEXT_DESC

Mulitiline text list view mode descriptor

Constructor Detail

EmfInputInterpreter

public EmfInputInterpreter(IContentViewerPane contentViewerPane)

Constructs a new EmfInputIterpreter

Parameters:

contentViewerPane - the content viewer pane

Method Detail

getPrimaryResource

protected org.eclipse.emf.ecore.resource.Resource getPrimaryResource()

Retrieves reference to the EMF Resource that is displayed in the IContentViewerPane this interpreter is serving.

Returns:

Returns reference to the EMF Resource that is displayed in the IContentViewerPane this interpreter is serving.

getFirstLeafDelta

protected static Delta getFirstLeafDelta(Delta delta)

Returns the first leaf delta by inspecting the children of the specified delta

Parameters:

delta - the input delta

Returns:

the leaf delta if found, or null

extractDelta

protected Delta extractDelta(IContentViewerInput input)

Will find an information about the Delta represented by the input .

Parameters:

input - the content viewer input which stores the Delta

Returns:

the delta if found, or null

getLocation

protected Location getLocation(Delta delta,
                               org.eclipse.emf.ecore.resource.Resource resource)

Return the location for the specified delta and contributor resource

Parameters:

delta - the input delta

resource - the contributor resource

Returns:

the location if exists or null

canSupportViewMode

protected static boolean canSupportViewMode(ViewModeDescriptor viewMode)

Checks if the view mode is an EMF view mode

Parameters:

viewMode - the input view mode

Returns:

true if supported, false otherwise

getMergeManager

protected final EmfMergeManager getMergeManager()

Returns the merge manager associated with the current session

Returns:

the merge manager

revealContent

public final IContentDescriptor revealContent(IContentViewerInput input,
                                              IViewerData viewerData)

Reveals the content associated with the current input within the context of the specified content viewer. It is normally the object associated with the Difference or the Conflict which is selected in the StructureViewer. For example, it will be the Tree Node (of some Model), which is part of the Add Difference; or it can be the Node Property (of some Tree Node), which is part of the Property Change Difference.

Parameters:

input - the input associated, which represents the current selection in the StructureViewer

viewerData - the associated viewer data

Returns:

the content descriptor that holds information about the content

See Also:

com.ibm.xtools.comparemerge.ui.viewers.IInputInterpreter#revealContent(com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput, com.ibm.xtools.comparemerge.ui.utils.IViewerData)

setContext

public final boolean setContext(IContentViewerInput input,
                                IViewerData viewerData,
                                boolean force)

Sets the context associated with the current input within the specified content viewer. It is normally the model object associated with the Difference or the Conflict which is selected in the StructureViewer.

Parameters:

input - the input associated, which represents the current selection in the StructureViewer

viewerData - the associated viewer data

force - a flag to indicate if the input needs to set irrespective of its previous input

Returns:

boolean flag indicating success or failure

See Also:

com.ibm.xtools.comparemerge.ui.viewers.IInputInterpreter#setContext(com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput, com.ibm.xtools.comparemerge.ui.utils.IViewerData, boolean)

getCurrentViewModes

public final java.util.List getCurrentViewModes(IContentViewerInput input)

Returns the list of current view modes for the specified input. View modes are used to create appropriate placeholders for hosting content viewers.

Parameters:

input - the input associated

Returns:

a list of ViewModeDescriptor

See Also:

com.ibm.xtools.comparemerge.ui.viewers.IInputInterpreter#getCurrentViewModes(com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput)

getCurrentViewModes

protected java.util.List getCurrentViewModes(IContentViewerInput input,
                                             boolean showEmfViews)

getBrowseViewModes

public final java.util.List getBrowseViewModes(IContentViewerInput input)

Returns the list of browse view modes for the specified input. View modes are used to create appropriate placeholders for hosting content viewers.

Parameters:

input - the input associated

Returns:

a list of ViewModeDescriptor

See Also:

com.ibm.xtools.comparemerge.ui.viewers.IInputInterpreter#getBrowseViewModes(com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput)

getContext

protected final java.lang.Object getContext(IContentViewerInput input,
                                            ViewModeDescriptor requestedViewMode)

Returns the context for the default EMF viewers

Parameters:

input - the input

requestedViewMode - the requested view mode

Returns:

the context which is the input to the viewer

getContent

protected final IContentDescriptor getContent(IContentViewerInput input,
                                              ViewModeDescriptor requestedViewMode)

Returns the content for the EMF viewers

Parameters:

input - the input

requestedViewMode - the requested view mode

Returns:

the context which is the input to the viewer

setInitialBrowseContext

public final boolean setInitialBrowseContext(IContentViewerInput input,
                                             IViewerData viewerData)

Sets the default browse context associated with the current input within the specified content viewer. It is normally the model object associated with the Difference or the Conflict which is selected in the StructureViewer.

Parameters:

input - the input associated, which represents the current selection in the StructureViewer

viewerData - the associated viewer data

Returns:

boolean flag indicating success or failure

See Also:

com.ibm.xtools.comparemerge.ui.viewers.IInputInterpreter#setInitialBrowseContext(com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput, com.ibm.xtools.comparemerge.ui.utils.IViewerData)

canBrowseContext

public final boolean canBrowseContext(ViewModeDescriptor sourceViewMode,
                                      ViewModeDescriptor targetViewMode,
                                      org.eclipse.jface.viewers.ISelection selection)

Allows the interpreter to decide if in browse mode the selections from the specified source view mode can be set as as the input to the specified target view mode.

Parameters:

sourceViewMode - the source view mode from where the input is used

targetViewMode - the target view mode where the input from the source is set

selection - the source selection

Returns:

true if possible, false otherwise

See Also:

com.ibm.xtools.comparemerge.ui.viewers.IInputInterpreter#canBrowseContext(com.ibm.xtools.comparemerge.ui.utils.ViewModeDescriptor, com.ibm.xtools.comparemerge.ui.utils.ViewModeDescriptor, org.eclipse.jface.viewers.ISelection)

setBrowseContext

public final boolean setBrowseContext(org.eclipse.jface.viewers.ISelection selection,
                                      IViewerData viewerData)

Sets the browse context associated with the current selection within the specified content viewer.

Parameters:

selection - the selection from the source viewer

viewerData - the target viewer data

Returns:

boolean flag indicating success or failure

See Also:

com.ibm.xtools.comparemerge.ui.viewers.IInputInterpreter#setBrowseContext(org.eclipse.jface.viewers.ISelection, com.ibm.xtools.comparemerge.ui.utils.IViewerData)

setInput

protected static void setInput(java.lang.Object input,
                               IViewerData viewerData,
                               boolean force)

Sets the input to the viewer

Parameters:

input - the input to the viewer

viewerData - the viewer data

force - flag to indicate whether is input is set irrespective of its its previous input

isHandlingContributor

protected final boolean isHandlingContributor(ContributorType contributorType)

Checks if this interpreter is associated with the contributor type

Parameters:

contributorType - the contributor

Returns:

true is it is, false otherwise

revealContent

protected static void revealContent(IContentDescriptor descriptor,
                                    IViewerData viewerData)

Reveal the content in the viewer

Parameters:

descriptor - the content descriptor

viewerData - the viewer data

findPropertyEntry

protected static java.lang.Object findPropertyEntry(java.lang.Object feature,
                                                    IViewerData viewerData)

Find the content for the property viewer

Parameters:

feature - the feature associated with the delta

viewerData - the viewer data

revealCustomContent

protected IContentDescriptor revealCustomContent(IContentViewerInput input,
                                                 IViewerData viewerData)

Reveals the custom content for the specified input and viewer

Parameters:

input - the input

viewerData - the viewer data

Returns:

the content descriptor

canBrowseCustomContext

protected boolean canBrowseCustomContext(ViewModeDescriptor sourceViewMode,
                                         ViewModeDescriptor targetViewMode,
                                         org.eclipse.jface.viewers.ISelection selection)

Allows the interpreter to decide if in browse mode the selections from the specified source view mode can be set as as the input to the specified target view mode.

Parameters:

sourceViewMode - the source view mode from where the input is used

targetViewMode - the target view mode where the input from the source is set

selection - the source selection

Returns:

true if possible, false otherwise

setCustomContext

protected boolean setCustomContext(IContentViewerInput input,
                                   IViewerData viewerData,
                                   boolean force)

Sets the custom context for the specified input and viewer

Parameters:

input - the input

viewerData - the viewer data

force - flag to indicate whether the input is forced

Returns:

return true if successful, false otherwise

setCustomBrowseContext

protected boolean setCustomBrowseContext(org.eclipse.jface.viewers.ISelection selection,
                                         IViewerData viewerData)

Sets the custom browse context associated with the current selection within the specified content viewer.

Parameters:

selection - the selection from the source viewer

viewerData - the target viewer data

Returns:

boolean flag indicating success or failure

getCustomCurrentViewModes

protected java.util.List getCustomCurrentViewModes(IContentViewerInput input,
                                                   java.util.List currentDefaultViewModes)

Returns the custom current view modes

Parameters:

input -

currentDefaultViewModes -

Returns:

the custom current view modes

setInitialCustomBrowseContext

protected boolean setInitialCustomBrowseContext(IContentViewerInput input,
                                                IViewerData viewerData)

Sets the intial custom browse context associated with the current input within the specified content viewer. It is normally the model object associated with the Difference or the Conflict which is selected in the StructureViewer.

Parameters:

input - the input associated, which represents the current selection in the StructureViewer

viewerData - the associated viewer data

Returns:

boolean flag indicating success or failure

getCustomBrowseViewModes

protected java.util.List getCustomBrowseViewModes(IContentViewerInput input,
                                                  java.util.List currentBrowseViewModes)

Returns the list of custom browse view modes for the specified input. View modes are used to create appropriate placeholders for hosting content viewers.

Parameters:

input - the input associated

currentBrowseViewModes - the EMF browse modes

Returns:

a list of ViewModeDescriptor

canSupportInput

public final boolean canSupportInput(IContentViewerInput input)

Checks if the specified input can be handled by the interpreter.

Parameters:

input - the input associated

Returns:

true if input can be handled, false otherwise

See Also:

com.ibm.xtools.comparemerge.ui.viewers.IInputInterpreter#canSupportInput(com.ibm.xtools.comparemerge.ui.controller.IContentViewerInput)

getParentDeleteDelta

public DeleteDelta getParentDeleteDelta(java.lang.String objectId,
                                        DeltaContainer deltaContainer)

Return the delta associated with the deletion of the parent of the specified object id

Parameters:

objectId - the object id

deltaContainer - the delta container

Returns:

the delta

isMultilineContent

protected boolean isMultilineContent(Delta delta)

Verifies whether the delta is related to multi lines or long line text changes

Parameters:

delta - - The delta object

Returns:

true if the delta is related to multi lines or single long line text changes.

getMultilineContent

protected java.lang.String getMultilineContent(Delta delta,
                                               boolean newValue,
                                               ContributorType contributorType)

Retrieves the the multi line text from the given delta

Parameters:

delta - - The delta object containing the text changes

newValue - - true if the retrieving new text value. false otherwise

Returns:

The text string

createMultilineContext

protected java.lang.Object createMultilineContext(Delta delta)

Creates the multi line context object

Parameters:

delta - - The delta object

Returns:

the multi-line context for the text view mode

getAssociatedFileType

protected java.lang.String getAssociatedFileType(Delta delta)

Finds and return the file type associated with the given delta. The file type is the file extension or file name (if it is mapped by file name to its content type).

Parameters:

delta - - the delta contains the text changes

Returns:

File extension or file name

createTextInput

protected java.lang.Object createTextInput(java.lang.String text,
                                           java.lang.String fileExtension)

getAffectedDescriptor

protected IContentDescriptor getAffectedDescriptor(java.util.List<?> contents,
                                                   java.lang.Object affectedObject,
                                                   java.lang.Object parentObject)