Package org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups

Class AbstractDifferenceGroupProvider

java.lang.Object
org.eclipse.emf.common.notify.impl.AdapterImpl
org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups.AbstractDifferenceGroupProvider
All Implemented Interfaces:
Adapter, Adapter.Internal, IDifferenceGroupProvider, IDifferenceGroupProvider2
Direct Known Subclasses:
ByResourceGroupProvider, DefaultGroupProvider, EmptyDifferenceGroupProvider, KindGroupProvider, ThreeWayComparisonGroupProvider
public abstract class AbstractDifferenceGroupProvider extends AdapterImpl implements IDifferenceGroupProvider2
Abstract implementation of IDifferenceGroupProvider.
Since:
4.0

  • Field Details

    • label

      protected String label
      A human-readable label for this group provider. This will be displayed in the EMF Compare UI.
      Since:
      4.1

    • activeByDefault

      protected boolean activeByDefault
      The initial activation state of the group provider.
      Since:
      4.1

  • Constructor Details

    • AbstractDifferenceGroupProvider

      public AbstractDifferenceGroupProvider()
      Default constructor.

  • Method Details

    • getLabel

      public String getLabel()
      Since:
      4.1
      See Also:
      • org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups.IDifferenceGroupProvider#getLabel()

    • setLabel

      public void setLabel(String label)
      Since:
      4.1
      See Also:
      • org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups.IDifferenceGroupProvider#setLabel(java.lang.String)

    • defaultSelected

      public boolean defaultSelected()
      Since:
      4.1
      See Also:
      • org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups.IDifferenceGroupProvider#defaultSelected()

    • setDefaultSelected

      public void setDefaultSelected(boolean active)
      Since:
      4.1
      See Also:
      • org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups.IDifferenceGroupProvider#setDefaultSelected(boolean)

    • isEnabled

      public boolean isEnabled(IComparisonScope scope, Comparison comparison)
      Returns the activation condition based on the scope and comparison objects.
      Specified by:
      isEnabled in interface IDifferenceGroupProvider
      Parameters:
      scope - The scope on which the group provider will be applied.
      comparison - The comparison which is to be displayed in the structural view.
      Returns:
      The activation condition based on the scope and comparison objects.
      Since:
      4.1
      See Also:

    • getCrossReferenceAdapter

      protected final ECrossReferenceAdapter getCrossReferenceAdapter()
      Returns the cross reference adapter used by this difference group provider.
      Returns:
      the crossReferenceAdapter the cross reference adapter used by this difference group provider.

    • getTreeNodes

      public List<TreeNode> getTreeNodes(EObject eObject)
      Returns all TreeNodes that are wrapping the given eObject. It internally use a cross reference adapter.
      Specified by:
      getTreeNodes in interface IDifferenceGroupProvider
      Parameters:
      eObject - the object from which we want inverse reference.
      Returns:
      all TreeNodes targeting the given eObject through TreePackage.Literals.TREE_NODE__DATA.
      See Also:
      • org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups.IDifferenceGroupProvider#getTreeNodes(java.lang.Object)

    • isAdapterForType

      public boolean isAdapterForType(Object type)
      Specified by:
      isAdapterForType in interface Adapter
      Overrides:
      isAdapterForType in class AdapterImpl
      See Also:

    • getGroups

      public Collection<? extends IDifferenceGroup> getGroups(Comparison aComparison)
      This will be called internally by the grouping actions in order to determine how the differences should be grouped in the structural view.
      Specified by:
      getGroups in interface IDifferenceGroupProvider
      Parameters:
      aComparison - The comparison which is to be displayed in the structural view. By default, its containment tree will be displayed.
      Returns:
      The collection of difference groups that are to be displayed in the structural viewer. An empty group will not be displayed at all. If null, we'll fall back to the default behavior.
      Since:
      4.1
      See Also:

    • buildGroups

      protected Collection<? extends IDifferenceGroup> buildGroups(Comparison aComparison)
      Builds the groups for this comparison. The framework expects that all groups are fully initialized ( their sub tree should be built). Extending IDifferenceGroupProvider2 needs to override this method to provid groups.
      Parameters:
      aComparison - comparison against which the groups will be built.
      Returns:
      Newly built collections of IDifferenceGroup.
      Since:
      4.1

    • groupsAreBuilt

      public boolean groupsAreBuilt()
      Tells if the groups of this provider have been already built for a comparison.
      Specified by:
      groupsAreBuilt in interface IDifferenceGroupProvider2
      Returns:
      true if the groups has been built for this comparison or false otherwise.
      Since:
      4.1
      See Also:

    • getComparison

      protected Comparison getComparison()
      Returns:
      comparison against which the groups has been built.
      Since:
      4.1

    • dispose

      public void dispose()
      Dispose this difference group provider.
      Specified by:
      dispose in interface IDifferenceGroupProvider
      Since:
      4.1
      See Also: