tmf: Introduce "IMAGE" data provider type

Followed by introducing the configurable reports data providers, this commit proposes
a new data provider type called "IMAGE", which is related to different types of configurable
image reports, such as jpg, png, svg, etc.

[Added] A new data provider type called "IMAGE"

Signed-off-by: Kaveh Shahedi <kaveh.shahedi@ericsson.com>

Author: kavehshahedi

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/dataprovider/IDataProviderDescriptor.java

@@ -29,14 +29,13 @@
 public interface IDataProviderDescriptor {
 
     /**
-     * The type of the data provider. The purpose of the type to indicate
-     * to the clients the type of viewer to visualize or whether they can
-     * share a common x-axis (e.g. time).
+     * The type of the data provider. The purpose of the type to indicate to the
+     * clients the type of viewer to visualize or whether they can share a
+     * common x-axis (e.g. time).
      *
      * The following types share common x-axis/time axis:
      *
-     * {@link #TREE_TIME_XY}
-     * {@link #TIME_GRAPH}
+     * {@link #TREE_TIME_XY} {@link #TIME_GRAPH}
      *
      * @author Loic Prieur-Drevon
      * @author Bernd Hufmann
@@ -47,22 +46,39 @@ public enum ProviderType {
          */
         TABLE,
         /**
-         * A provider for a tree, whose entries have XY series. The x-series is time.
+         * A provider for a tree, whose entries have XY series. The x-series is
+         * time.
          */
         TREE_TIME_XY,
         /**
-         * A provider for a Time Graph model, which has entries with a start and end
-         * time, each entry has a series of states, arrows link from one series to
-         * another
+         * A provider for a Time Graph model, which has entries with a start and
+         * end time, each entry has a series of states, arrows link from one
+         * series to another
          */
         TIME_GRAPH,
         /**
          * A provider for a data tree, which has entries (rows) and columns.
+         *
          * @since 6.1
          */
         DATA_TREE,
         /**
-         * A provider with no data. Can be used for grouping purposes and/or as data provider configurator.
+         * A provider for a report, which can be an image, report, text, etc.
+         * The sub-type of the provider is used to indicate the type of report.
+         *
+         * @since 10.3
+         */
+        REPORT,
+        /**
+         * A provider for an image data (e.g., png, jpeg, etc.)
+         *
+         * @since 10.3
+         */
+        IMAGE,
+        /**
+         * A provider with no data. Can be used for grouping purposes and/or as
+         * data provider configurator.
+         *
          * @since 9.5
          */
         NONE
@@ -110,7 +126,7 @@ public enum ProviderType {
      * Gets the input configuration used to create this data provider.
      *
      * @return the {@link ITmfConfiguration} configuration use to create this
-     * data provider, or null if not applicable
+     *         data provider, or null if not applicable
      * @since 9.5
      */
     default @Nullable ITmfConfiguration getConfiguration() {
@@ -124,4 +140,14 @@ public enum ProviderType {
     default IDataProviderCapabilities getCapabilities() {
         return DataProviderCapabilities.NULL_INSTANCE;
     }
+
+    /**
+     * Gets the sub-type of this data provider.
+     *
+     * @return the sub-type or null if not applicable
+     * @since 10.3
+     */
+    default @Nullable ProviderType getSubType() {
+        return null;
+    }
 }

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/DataProviderDescriptor.java

@@ -33,6 +33,7 @@ public class DataProviderDescriptor implements IDataProviderDescriptor {
     private final String fName;
     private final String fDescription;
     private final ProviderType fType;
+    private final @Nullable ProviderType fSubType;
     private final @Nullable String fParentId;
     private final @Nullable ITmfConfiguration fConfiguration;
     private final IDataProviderCapabilities fCapabilities;
@@ -48,6 +49,7 @@ private DataProviderDescriptor(Builder builder) {
         fName = builder.fName;
         fDescription = builder.fDescription;
         fType = Objects.requireNonNull(builder.fType);
+        fSubType = builder.fSubType;
         fParentId = builder.fParentId;
         fConfiguration = builder.fConfiguration;
         fCapabilities = builder.fCapabilities;
@@ -68,6 +70,11 @@ public ProviderType getType() {
         return fType;
     }
 
+    @Override
+    public @Nullable ProviderType getSubType() {
+        return fSubType;
+    }
+
     @Override
     public String getDescription() {
         return fDescription;
@@ -93,10 +100,11 @@ public IDataProviderCapabilities getCapabilities() {
     public String toString() {
         return getClass().getSimpleName() + " [fName=" + getName()
                 + ", fDescription=" + getDescription() + ", fType=" + getType()
-                +  ", fId=" + getId()
-                +  ", fParentId=" + fParentId
-                +  ", fConfiguration=" + fConfiguration
-                +  ", fCapabilities=" + fCapabilities
+                + ", fId=" + getId()
+                + ", fSubType=" + fSubType
+                + ", fParentId=" + fParentId
+                + ", fConfiguration=" + fConfiguration
+                + ", fCapabilities=" + fCapabilities
                 + "]";
     }
 
@@ -107,24 +115,26 @@ public boolean equals(@Nullable Object arg0) {
         }
         DataProviderDescriptor other = (DataProviderDescriptor) arg0;
         return Objects.equals(fName, other.fName) && Objects.equals(fId, other.fId)
-                && Objects.equals(fType, other.fType) && Objects.equals(fDescription, other.fDescription)
-                && Objects.equals(fParentId, other.fParentId) && Objects.equals(fConfiguration, other.fConfiguration)
-                && Objects.equals(fCapabilities, other.fCapabilities);
+                && Objects.equals(fType, other.fType) && Objects.equals(fSubType, other.fSubType)
+                && Objects.equals(fDescription, other.fDescription) && Objects.equals(fParentId, other.fParentId)
+                && Objects.equals(fConfiguration, other.fConfiguration) && Objects.equals(fCapabilities, other.fCapabilities);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(fParentId, fName, fId, fType, fDescription, fConfiguration, fCapabilities);
+        return Objects.hash(fParentId, fName, fId, fType, fSubType, fDescription, fConfiguration, fCapabilities);
     }
 
     /**
-     * A builder class to build instances implementing interface {@link IDataProviderDescriptor}
+     * A builder class to build instances implementing interface
+     * {@link IDataProviderDescriptor}
      */
     public static class Builder {
         private String fId = ""; //$NON-NLS-1$
         private String fName = ""; //$NON-NLS-1$
         private String fDescription = ""; //$NON-NLS-1$
         private @Nullable ProviderType fType = null;
+        private @Nullable ProviderType fSubType = null;
         private @Nullable String fParentId = null;
         private @Nullable ITmfConfiguration fConfiguration = null;
         private IDataProviderCapabilities fCapabilities = DataProviderCapabilities.NULL_INSTANCE;
@@ -184,6 +194,19 @@ public Builder setProviderType(ProviderType type) {
             return this;
         }
 
+        /**
+         * Sets the data provider sub type
+         *
+         * @param subType
+         *            the data provider sub type to set
+         * @return the builder instance.
+         * @since 10.3
+         */
+        public Builder setProviderSubType(@Nullable ProviderType subType) {
+            fSubType = subType;
+            return this;
+        }
+
         /**
          * Sets the parent ID of the descriptor
          *