[Hints] Refactor IHintProvider so it can be used more generally part 2

- This means that model objects could extend IHelpHintProvider - IHelpHintProvider moved to com.archimatetool.model - IHintProvider extends IHelpHintProvider
archimatetool · Jul 1, 2023 · 91fdefb · 91fdefb
1 parent 7790885
commit 91fdefb
Show file tree

Hide file tree

Showing 21 changed files with 199 additions and 45 deletions.
diff --git a/com.archimatetool.canvas/src/com/archimatetool/canvas/model/impl/CanvasModel.java b/com.archimatetool.canvas/src/com/archimatetool/canvas/model/impl/CanvasModel.java
@@ -12,6 +12,7 @@
 import com.archimatetool.canvas.model.ICanvasModel;
 import com.archimatetool.canvas.model.ICanvasPackage;
 import com.archimatetool.model.IArchimatePackage;
+import com.archimatetool.model.IHelpHintProvider;
 import com.archimatetool.model.IHintProvider;
 import com.archimatetool.model.impl.DiagramModel;
 
@@ -207,6 +208,11 @@ public boolean eIsSet(int featureID) {
      */
     @Override
     public int eBaseStructuralFeatureID(int derivedFeatureID, Class<?> baseClass) {
+        if (baseClass == IHelpHintProvider.class) {
+            switch (derivedFeatureID) {
+                default: return -1;
+            }
+        }
         if (baseClass == IHintProvider.class) {
             switch (derivedFeatureID) {
                 case ICanvasPackage.CANVAS_MODEL__HINT_TITLE: return IArchimatePackage.HINT_PROVIDER__HINT_TITLE;
@@ -224,6 +230,11 @@ public int eBaseStructuralFeatureID(int derivedFeatureID, Class<?> baseClass) {
      */
     @Override
     public int eDerivedStructuralFeatureID(int baseFeatureID, Class<?> baseClass) {
+        if (baseClass == IHelpHintProvider.class) {
+            switch (baseFeatureID) {
+                default: return -1;
+            }
+        }
         if (baseClass == IHintProvider.class) {
             switch (baseFeatureID) {
                 case IArchimatePackage.HINT_PROVIDER__HINT_TITLE: return ICanvasPackage.CANVAS_MODEL__HINT_TITLE;

diff --git a/com.archimatetool.canvas/src/com/archimatetool/canvas/model/impl/CanvasModelBlock.java b/com.archimatetool.canvas/src/com/archimatetool/canvas/model/impl/CanvasModelBlock.java
@@ -24,6 +24,7 @@
 import com.archimatetool.model.IDiagramModelContainer;
 import com.archimatetool.model.IDiagramModelImageProvider;
 import com.archimatetool.model.IDiagramModelObject;
+import com.archimatetool.model.IHelpHintProvider;
 import com.archimatetool.model.IHintProvider;
 import com.archimatetool.model.ILockable;
 import com.archimatetool.model.IProperties;
@@ -688,6 +689,11 @@ public int eBaseStructuralFeatureID(int derivedFeatureID, Class<?> baseClass) {
                 default: return -1;
             }
         }
+        if (baseClass == IHelpHintProvider.class) {
+            switch (derivedFeatureID) {
+                default: return -1;
+            }
+        }
         if (baseClass == IHintProvider.class) {
             switch (derivedFeatureID) {
                 case ICanvasPackage.CANVAS_MODEL_BLOCK__HINT_TITLE: return IArchimatePackage.HINT_PROVIDER__HINT_TITLE;
@@ -747,6 +753,11 @@ public int eDerivedStructuralFeatureID(int baseFeatureID, Class<?> baseClass) {
                 default: return -1;
             }
         }
+        if (baseClass == IHelpHintProvider.class) {
+            switch (baseFeatureID) {
+                default: return -1;
+            }
+        }
         if (baseClass == IHintProvider.class) {
             switch (baseFeatureID) {
                 case IArchimatePackage.HINT_PROVIDER__HINT_TITLE: return ICanvasPackage.CANVAS_MODEL_BLOCK__HINT_TITLE;

diff --git a/com.archimatetool.canvas/src/com/archimatetool/canvas/model/util/CanvasAdapterFactory.java b/com.archimatetool.canvas/src/com/archimatetool/canvas/model/util/CanvasAdapterFactory.java
@@ -26,6 +26,7 @@
 import com.archimatetool.model.IDocumentable;
 import com.archimatetool.model.IFeatures;
 import com.archimatetool.model.IFontAttribute;
+import com.archimatetool.model.IHelpHintProvider;
 import com.archimatetool.model.IHintProvider;
 import com.archimatetool.model.IIconic;
 import com.archimatetool.model.IIdentifier;
@@ -163,6 +164,10 @@ public Adapter caseDiagramModel(IDiagramModel object) {
                 return createDiagramModelAdapter();
             }
             @Override
+            public Adapter caseHelpHintProvider(IHelpHintProvider object) {
+                return createHelpHintProviderAdapter();
+            }
+            @Override
             public Adapter caseHintProvider(IHintProvider object) {
                 return createHintProviderAdapter();
             }
@@ -518,6 +523,20 @@ public Adapter createDiagramModelAdapter() {
         return null;
     }
 
+    /**
+     * Creates a new adapter for an object of class '{@link com.archimatetool.model.IHelpHintProvider <em>Help Hint Provider</em>}'.
+     * <!-- begin-user-doc -->
+     * This default implementation returns null so that we can easily ignore cases;
+     * it's useful to ignore a case when inheritance will catch all the cases anyway.
+     * <!-- end-user-doc -->
+     * @return the new adapter.
+     * @see com.archimatetool.model.IHelpHintProvider
+     * @generated
+     */
+    public Adapter createHelpHintProviderAdapter() {
+        return null;
+    }
+
     /**
      * Creates a new adapter for an object of class '{@link com.archimatetool.model.IFontAttribute <em>Font Attribute</em>}'.
      * <!-- begin-user-doc -->

diff --git a/com.archimatetool.canvas/src/com/archimatetool/canvas/model/util/CanvasSwitch.java b/com.archimatetool.canvas/src/com/archimatetool/canvas/model/util/CanvasSwitch.java
@@ -25,6 +25,7 @@
 import com.archimatetool.model.IDocumentable;
 import com.archimatetool.model.IFeatures;
 import com.archimatetool.model.IFontAttribute;
+import com.archimatetool.model.IHelpHintProvider;
 import com.archimatetool.model.IHintProvider;
 import com.archimatetool.model.IIconic;
 import com.archimatetool.model.IIdentifier;
@@ -108,6 +109,7 @@ protected T doSwitch(int classifierID, EObject theEObject) {
                 if (result == null) result = caseDiagramModelContainer(canvasModel);
                 if (result == null) result = caseDocumentable(canvasModel);
                 if (result == null) result = caseProperties(canvasModel);
+                if (result == null) result = caseHelpHintProvider(canvasModel);
                 if (result == null) result = caseFeatures(canvasModel);
                 if (result == null) result = caseDiagramModelComponent(canvasModel);
                 if (result == null) result = caseArchimateModelObject(canvasModel);
@@ -157,6 +159,7 @@ protected T doSwitch(int classifierID, EObject theEObject) {
                 if (result == null) result = caseHintProvider(canvasModelBlock);
                 if (result == null) result = caseDiagramModelObject(canvasModelBlock);
                 if (result == null) result = caseDiagramModelImageProvider(canvasModelBlock);
+                if (result == null) result = caseHelpHintProvider(canvasModelBlock);
                 if (result == null) result = caseConnectable(canvasModelBlock);
                 if (result == null) result = caseFontAttribute(canvasModelBlock);
                 if (result == null) result = caseLineObject(canvasModelBlock);
@@ -520,6 +523,21 @@ public T caseDiagramModel(IDiagramModel object) {
         return null;
     }
 
+    /**
+     * Returns the result of interpreting the object as an instance of '<em>Help Hint Provider</em>'.
+     * <!-- begin-user-doc -->
+     * This implementation returns null;
+     * returning a non-null result will terminate the switch.
+     * <!-- end-user-doc -->
+     * @param object the target of the switch.
+     * @return the result of interpreting the object as an instance of '<em>Help Hint Provider</em>'.
+     * @see #doSwitch(org.eclipse.emf.ecore.EObject) doSwitch(EObject)
+     * @generated
+     */
+    public T caseHelpHintProvider(IHelpHintProvider object) {
+        return null;
+    }
+
     /**
      * Returns the result of interpreting the object as an instance of '<em>Font Attribute</em>'.
      * <!-- begin-user-doc -->

diff --git a/...matetool.hammer/src/com/archimatetool/hammer/validation/issues/AbstractIssueCategory.java b/...matetool.hammer/src/com/archimatetool/hammer/validation/issues/AbstractIssueCategory.java
@@ -52,12 +52,12 @@ public Image getImage() {
     }
 
     @Override
-    public String getHelpHintTitle() {
+    public String getHintTitle() {
         return getName();
     }
 
     @Override
-    public String getHelpHintContent() {
+    public String getHintContent() {
         return null;
     }
 }
diff --git a/...rchimatetool.hammer/src/com/archimatetool/hammer/validation/issues/AbstractIssueType.java b/...rchimatetool.hammer/src/com/archimatetool/hammer/validation/issues/AbstractIssueType.java
@@ -88,12 +88,12 @@ public Image getImage() {
     }
 
     @Override
-    public String getHelpHintTitle() {
+    public String getHintTitle() {
         return getName();
     }
 
     @Override
-    public String getHelpHintContent() {
+    public String getHintContent() {
         return getExplanation();
     }
 

diff --git a/com.archimatetool.hammer/src/com/archimatetool/hammer/validation/issues/AdviceCategory.java b/com.archimatetool.hammer/src/com/archimatetool/hammer/validation/issues/AdviceCategory.java
@@ -30,7 +30,7 @@ public Image getImage() {
     }
 
     @Override
-    public String getHelpHintContent() {
+    public String getHintContent() {
         return Messages.AdviceCategory_1;
     }
 }
diff --git a/com.archimatetool.hammer/src/com/archimatetool/hammer/validation/issues/ErrorsCategory.java b/com.archimatetool.hammer/src/com/archimatetool/hammer/validation/issues/ErrorsCategory.java
@@ -30,7 +30,7 @@ public Image getImage() {
     }
 
     @Override
-    public String getHelpHintContent() {
+    public String getHintContent() {
         return Messages.ErrorsCategory_1;
     }
 }
diff --git a/com.archimatetool.hammer/src/com/archimatetool/hammer/validation/issues/IIssue.java b/com.archimatetool.hammer/src/com/archimatetool/hammer/validation/issues/IIssue.java
@@ -8,7 +8,7 @@
 import org.eclipse.core.runtime.IAdaptable;
 import org.eclipse.swt.graphics.Image;
 
-import com.archimatetool.editor.ui.IHelpHintProvider;
+import com.archimatetool.model.IHelpHintProvider;
 
 
 public interface IIssue extends IHelpHintProvider, IAdaptable {

diff --git a/com.archimatetool.hammer/src/com/archimatetool/hammer/validation/issues/IIssueCategory.java b/com.archimatetool.hammer/src/com/archimatetool/hammer/validation/issues/IIssueCategory.java
@@ -9,7 +9,7 @@
 
 import org.eclipse.swt.graphics.Image;
 
-import com.archimatetool.editor.ui.IHelpHintProvider;
+import com.archimatetool.model.IHelpHintProvider;
 
 
 /**

diff --git a/...archimatetool.hammer/src/com/archimatetool/hammer/validation/issues/WarningsCategory.java b/...archimatetool.hammer/src/com/archimatetool/hammer/validation/issues/WarningsCategory.java
@@ -30,7 +30,7 @@ public Image getImage() {
     }
 
     @Override
-    public String getHelpHintContent() {
+    public String getHintContent() {
         return Messages.WarningsCategory_1;
     }
 }
diff --git a/com.archimatetool.help/src/com/archimatetool/help/hints/HintsView.java b/com.archimatetool.help/src/com/archimatetool/help/hints/HintsView.java
@@ -52,7 +52,6 @@
 import com.archimatetool.editor.ArchiPlugin;
 import com.archimatetool.editor.preferences.IPreferenceConstants;
 import com.archimatetool.editor.ui.IArchiImages;
-import com.archimatetool.editor.ui.IHelpHintProvider;
 import com.archimatetool.editor.ui.services.ComponentSelectionManager;
 import com.archimatetool.editor.ui.services.IComponentSelectionListener;
 import com.archimatetool.editor.utils.PlatformUtils;
@@ -61,7 +60,7 @@
 import com.archimatetool.model.IArchimateConcept;
 import com.archimatetool.model.IArchimateDiagramModel;
 import com.archimatetool.model.IDiagramModelComponent;
-import com.archimatetool.model.IHintProvider;
+import com.archimatetool.model.IHelpHintProvider;
 
 
 
@@ -302,24 +301,9 @@ private void showHintForSelected(Object source, Object selected) {
             path = hint.path;
         }
 
-        // This is an Application Help Hint Provider
-        if(selected instanceof IHelpHintProvider) {
-            IHelpHintProvider provider = (IHelpHintProvider)selected;
-
-            // Title set
-            if(StringUtils.isSet(provider.getHelpHintTitle())) {
-                title = provider.getHelpHintTitle();
-            }
-
-            // Content set
-            if(StringUtils.isSet(provider.getHelpHintContent())) {
-                content = makeHTMLEntry(provider.getHelpHintContent());
-            }
-        }
-        // This is a Hint Content Provider
-        else if(actualObject instanceof IHintProvider) {
-            IHintProvider provider = (IHintProvider)actualObject;
-
+        // This is a Help Hint Provider
+        IHelpHintProvider provider = (IHelpHintProvider)(actualObject instanceof IHelpHintProvider ? actualObject : selected instanceof IHelpHintProvider ? selected : null);
+        if(provider != null) {
             // Title set
             if(StringUtils.isSet(provider.getHintTitle())) {
                 title = provider.getHintTitle();

diff --git a/com.archimatetool.model/model/archimate.ecore b/com.archimatetool.model/model/archimate.ecore
@@ -474,7 +474,8 @@
   </eClassifiers>
   <eClassifiers xsi:type="ecore:EClass" name="SketchModelSticky" eSuperTypes="#//DiagramModelObject #//DiagramModelContainer #//TextContent #//Properties #//TextPosition #//Iconic"/>
   <eClassifiers xsi:type="ecore:EClass" name="SketchModelActor" eSuperTypes="#//DiagramModelObject #//Documentable #//Properties"/>
-  <eClassifiers xsi:type="ecore:EClass" name="HintProvider" abstract="true" interface="true">
+  <eClassifiers xsi:type="ecore:EClass" name="HintProvider" abstract="true" interface="true"
+      eSuperTypes="#//HelpHintProvider">
     <eStructuralFeatures xsi:type="ecore:EAttribute" name="hintTitle" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"
         defaultValueLiteral=""/>
     <eStructuralFeatures xsi:type="ecore:EAttribute" name="hintContent" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"
@@ -484,4 +485,6 @@
       </eAnnotations>
     </eStructuralFeatures>
   </eClassifiers>
+  <eClassifiers xsi:type="ecore:EClass" name="HelpHintProvider" instanceClassName="com.archimatetool.model.IHelpHintProvider"
+      abstract="true" interface="true"/>
 </ecore:EPackage>
diff --git a/com.archimatetool.model/model/archimate.genmodel b/com.archimatetool.model/model/archimate.genmodel
@@ -337,5 +337,6 @@
       <genFeatures createChild="false" ecoreFeature="ecore:EAttribute archimate.ecore#//HintProvider/hintTitle"/>
       <genFeatures createChild="false" ecoreFeature="ecore:EAttribute archimate.ecore#//HintProvider/hintContent"/>
     </genClasses>
+    <genClasses image="false" ecoreClass="archimate.ecore#//HelpHintProvider"/>
   </genPackages>
 </genmodel:GenModel>
diff --git a/com.archimatetool.model/src/com/archimatetool/model/IArchimatePackage.java b/com.archimatetool.model/src/com/archimatetool/model/IArchimatePackage.java
@@ -10629,6 +10629,25 @@ public interface IArchimatePackage extends EPackage {
      */
     int SKETCH_MODEL_ACTOR_FEATURE_COUNT = DIAGRAM_MODEL_OBJECT_FEATURE_COUNT + 2;
 
+    /**
+     * The meta object id for the '{@link com.archimatetool.model.IHelpHintProvider <em>Help Hint Provider</em>}' class.
+     * <!-- begin-user-doc -->
+     * <!-- end-user-doc -->
+     * @see com.archimatetool.model.IHelpHintProvider
+     * @see com.archimatetool.model.impl.ArchimatePackage#getHelpHintProvider()
+     * @generated
+     */
+    int HELP_HINT_PROVIDER = 139;
+
+    /**
+     * The number of structural features of the '<em>Help Hint Provider</em>' class.
+     * <!-- begin-user-doc -->
+     * <!-- end-user-doc -->
+     * @generated
+     * @ordered
+     */
+    int HELP_HINT_PROVIDER_FEATURE_COUNT = 0;
+
     /**
      * The meta object id for the '{@link com.archimatetool.model.IHintProvider <em>Hint Provider</em>}' class.
      * <!-- begin-user-doc -->
@@ -10646,7 +10665,7 @@ public interface IArchimatePackage extends EPackage {
      * @generated
      * @ordered
      */
-    int HINT_PROVIDER__HINT_TITLE = 0;
+    int HINT_PROVIDER__HINT_TITLE = HELP_HINT_PROVIDER_FEATURE_COUNT + 0;
 
     /**
      * The feature id for the '<em><b>Hint Content</b></em>' attribute.
@@ -10655,7 +10674,7 @@ public interface IArchimatePackage extends EPackage {
      * @generated
      * @ordered
      */
-    int HINT_PROVIDER__HINT_CONTENT = 1;
+    int HINT_PROVIDER__HINT_CONTENT = HELP_HINT_PROVIDER_FEATURE_COUNT + 1;
 
     /**
      * The number of structural features of the '<em>Hint Provider</em>' class.
@@ -10664,7 +10683,7 @@ public interface IArchimatePackage extends EPackage {
      * @generated
      * @ordered
      */
-    int HINT_PROVIDER_FEATURE_COUNT = 2;
+    int HINT_PROVIDER_FEATURE_COUNT = HELP_HINT_PROVIDER_FEATURE_COUNT + 2;
 
     /**
      * The meta object id for the '{@link com.archimatetool.model.FolderType <em>Folder Type</em>}' enum.
@@ -10674,7 +10693,7 @@ public interface IArchimatePackage extends EPackage {
      * @see com.archimatetool.model.impl.ArchimatePackage#getFolderType()
      * @generated
      */
-    int FOLDER_TYPE = 139;
+    int FOLDER_TYPE = 140;
 
     /**
      * The meta object id for the '<em>File</em>' data type.
@@ -10684,7 +10703,7 @@ public interface IArchimatePackage extends EPackage {
      * @see com.archimatetool.model.impl.ArchimatePackage#getFile()
      * @generated
      */
-    int FILE = 140;
+    int FILE = 141;
 
 
     /**
@@ -12825,6 +12844,17 @@ public interface IArchimatePackage extends EPackage {
      */
     EAttribute getHintProvider_HintContent();
 
+    /**
+     * Returns the meta object for class '{@link com.archimatetool.model.IHelpHintProvider <em>Help Hint Provider</em>}'.
+     * <!-- begin-user-doc -->
+     * <!-- end-user-doc -->
+     * @return the meta object for class '<em>Help Hint Provider</em>'.
+     * @see com.archimatetool.model.IHelpHintProvider
+     * @model instanceClass="com.archimatetool.model.IHelpHintProvider"
+     * @generated
+     */
+    EClass getHelpHintProvider();
+
     /**
      * Returns the meta object for enum '{@link com.archimatetool.model.FolderType <em>Folder Type</em>}'.
      * <!-- begin-user-doc -->
@@ -14802,6 +14832,16 @@ interface Literals {
          */
         EAttribute HINT_PROVIDER__HINT_CONTENT = eINSTANCE.getHintProvider_HintContent();
 
+        /**
+         * The meta object literal for the '{@link com.archimatetool.model.IHelpHintProvider <em>Help Hint Provider</em>}' class.
+         * <!-- begin-user-doc -->
+         * <!-- end-user-doc -->
+         * @see com.archimatetool.model.IHelpHintProvider
+         * @see com.archimatetool.model.impl.ArchimatePackage#getHelpHintProvider()
+         * @generated
+         */
+        EClass HELP_HINT_PROVIDER = eINSTANCE.getHelpHintProvider();
+
         /**
          * The meta object literal for the '{@link com.archimatetool.model.FolderType <em>Folder Type</em>}' enum.
          * <!-- begin-user-doc -->