tmf: Add auto-expand level in TmfTreeModel

The auto-expand level is supposed to be used for the input of the tree.
The value 0 means that there is no auto-expand; 1 means that top-level
elements are expanded, but not their children; 2 means that top-level
elements are expanded, and their children, but not grand-children; and
so on.

The value -1 means that all subtrees should be expanded (default).

[Added] Add auto-expand level in TmfTreeModel

Signed-off-by: Hriday Panchasara [email protected]
Signed-off-by: Bernd Hufmann <[email protected]>

Author: hriday-panchasara

tmf/org.eclipse.tracecompass.tmf.core.tests/src/org/eclipse/tracecompass/tmf/core/tests/model/tree/TmfTreeModelTest.java

@@ -1,5 +1,5 @@
 /**********************************************************************
- * Copyright (c) 2020, 2025 Ericsson
+ * Copyright (c) 2020 Ericsson
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License 2.0 which
@@ -41,6 +41,8 @@ public class TmfTreeModelTest {
     private static final String TOOLTIP_PREFIX = "tooltip";
     private static final String LABEL_PREFIX = "label";
     private static final String TEST_SCOPE = "scope";
+    private static final int ALL_LEVELS = -1;
+    private static final int TEST_LEVEL = 1;
     private static List<ITmfTreeDataModel> fTestEntries = new ArrayList<>();
     private static List<String> fTestHeaders = new ArrayList<>();
     private static List<String> fExpectedEmptyTooltips = new ArrayList<>();
@@ -82,13 +84,13 @@ public static void initClass() {
     @Test
     public void testTmfTreeModelConstructor() {
         TmfTreeModel<ITmfTreeDataModel> testInstance = new TmfTreeModel<>(fTestHeaders, fTestEntries);
-        verifyInstance(testInstance, fExpectedEmptyTooltips, null);
+        verifyInstance(testInstance, fExpectedEmptyTooltips, null, ALL_LEVELS);
 
         testInstance = new TmfTreeModel<>(fTestHeaders, fTestEntries, TEST_SCOPE);
-        verifyInstance(testInstance, fExpectedEmptyTooltips, TEST_SCOPE);
+        verifyInstance(testInstance, fExpectedEmptyTooltips, TEST_SCOPE, ALL_LEVELS);
     }
 
-    private static void verifyInstance(TmfTreeModel<ITmfTreeDataModel> testInstance, List<String> tooltips, @Nullable String scope) {
+    private static void verifyInstance(TmfTreeModel<ITmfTreeDataModel> testInstance, List<String> tooltips, @Nullable String scope, int autoExpandLevel) {
         assertEquals("Incorrect list of entries", fTestEntries, testInstance.getEntries());
         assertEquals("Incorrect list of entries", fTestHeaders, testInstance.getHeaders());
 
@@ -101,6 +103,7 @@ private static void verifyInstance(TmfTreeModel<ITmfTreeDataModel> testInstance,
             assertEquals("Incorrect Collumn descriptor header tooltip", tooltips.get(i), columnDescriptors.get(i).getTooltip());
         }
         assertEquals("Incorrect scope", scope, testInstance.getScope());
+        assertEquals("Incorrect autoExpandLevel", autoExpandLevel, testInstance.getAutoExpandLevel());
     }
 
     /**
@@ -112,13 +115,17 @@ public void testTmfTreeModelConstructor2() {
         TmfTreeModel.Builder<ITmfTreeDataModel> builder = new TmfTreeModel.Builder<>();
         builder.setColumnDescriptors(fTestDescriptors).setEntries(fTestEntries);
         TmfTreeModel<ITmfTreeDataModel> testInstance = builder.build();
-        verifyInstance(testInstance, fExpectedTooltips, null);
+        verifyInstance(testInstance, fExpectedTooltips, null, ALL_LEVELS);
 
         builder = new TmfTreeModel.Builder<>();
         builder.setColumnDescriptors(fTestDescriptors).setEntries(fTestEntries).setScope(TEST_SCOPE);
+        testInstance = builder.build();
+        verifyInstance(testInstance, fExpectedTooltips, TEST_SCOPE, ALL_LEVELS);
 
+        builder = new TmfTreeModel.Builder<>();
+        builder.setColumnDescriptors(fTestDescriptors).setEntries(fTestEntries).setScope(TEST_SCOPE).setAutoExpandLevel(TEST_LEVEL);
         testInstance = builder.build();
-        verifyInstance(testInstance, fExpectedTooltips, TEST_SCOPE);
+        verifyInstance(testInstance, fExpectedTooltips, TEST_SCOPE, TEST_LEVEL);
 
         builder = new TmfTreeModel.Builder<>();
         testInstance = builder.build();

tmf/org.eclipse.tracecompass.tmf.core/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %Bundle-Name
 Bundle-Vendor: %Bundle-Vendor
-Bundle-Version: 10.0.0.qualifier
+Bundle-Version: 10.1.0.qualifier
 Bundle-Localization: plugin
 Bundle-SymbolicName: org.eclipse.tracecompass.tmf.core;singleton:=true
 Bundle-Activator: org.eclipse.tracecompass.internal.tmf.core.Activator

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeCompositeDataProvider.java

@@ -1,5 +1,5 @@
 /**********************************************************************
- * Copyright (c) 2017, 2021 Ericsson
+ * Copyright (c) 2017, 2025 Ericsson
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License 2.0 which
@@ -106,6 +106,7 @@ public TmfModelResponse<TmfTreeModel<M>> fetchTree(Map<String, Object> fetchPara
         boolean isComplete = true;
         List<Entry<M, Object>> entries = new ArrayList<>();
         List<ITableColumnDescriptor> columnDescriptor = null;
+        int autoExpandLevel = TmfTreeModel.ALL_LEVELS;
 
         Table<Object, Long, @NonNull M> scopedEntries = HashBasedTable.create();
         for (P dataProvider : fProviders) {
@@ -155,6 +156,8 @@ public TmfModelResponse<TmfTreeModel<M>> fetchTree(Map<String, Object> fetchPara
                 if (columnDescriptor == null) {
                     columnDescriptor = model.getColumnDescriptors();
                 }
+                // All autoExpandLevel are supposed to be the same
+                autoExpandLevel = model.getAutoExpandLevel();
             }
             if (monitor != null && monitor.isCanceled()) {
                 return new TmfModelResponse<>(null, ITmfResponse.Status.CANCELLED, CommonStatusMessage.TASK_CANCELLED);
@@ -166,7 +169,8 @@ public TmfModelResponse<TmfTreeModel<M>> fetchTree(Map<String, Object> fetchPara
             columnDescriptor = Collections.emptyList();
         }
         treeModelBuilder.setColumnDescriptors(columnDescriptor)
-                        .setEntries(Lists.transform(entries, e -> e.getKey()));
+                        .setEntries(Lists.transform(entries, e -> e.getKey()))
+                        .setAutoExpandLevel(autoExpandLevel);
 
         if (isComplete) {
             return new TmfModelResponse<>(treeModelBuilder.build(), ITmfResponse.Status.COMPLETED, CommonStatusMessage.COMPLETED);

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/tree/TmfTreeModel.java

@@ -1,5 +1,5 @@
 /**********************************************************************
- * Copyright (c) 2019 Ericsson
+ * Copyright (c) 2019, 2025 Ericsson
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License 2.0 which
@@ -31,11 +31,24 @@
  * @since 5.0
  */
 public class TmfTreeModel<T extends ITmfTreeDataModel> {
+
+    /**
+     * Expand level to indicate that all tree levels are expanded. (default)
+     *
+     * @since 10.1
+     */
+    public static final int ALL_LEVELS = -1;
+
     private List<String> fHeaders;
     private List<ITableColumnDescriptor> fColumnDescriptors;
     private List<T> fEntries;
     private @Nullable String fScope;
 
+    /**
+     * Indicates which level of the tree should be expanded.
+     */
+    private int fAutoExpandLevel = ALL_LEVELS;
+
     /**
      * Constructor
      *
@@ -88,6 +101,7 @@ private TmfTreeModel(Builder<T> builder) {
         fColumnDescriptors = builder.fColumnDescriptors;
         fEntries = builder.fEntries;
         fScope = builder.fScope;
+        fAutoExpandLevel = builder.fAutoExpandLevel;
     }
 
     /**
@@ -118,6 +132,36 @@ public List<T> getEntries() {
         return fScope;
     }
 
+    /**
+     * Returns the auto-expand level.
+     *
+     * @return non-negative level, or <code>ALL_LEVELS</code> if all levels of
+     *         the tree are expanded automatically
+     * @see #setAutoExpandLevel
+     * @since 10.1
+     */
+    public int getAutoExpandLevel() {
+        return fAutoExpandLevel;
+    }
+
+    /**
+     * Sets the auto-expand level to be used for the input of the tree. The
+     * value 0 means that there is no auto-expand; 1 means that top-level
+     * elements are expanded, but not their children; 2 means that top-level
+     * elements are expanded, and their children, but not grand-children; and so
+     * on.
+     * <p>
+     * The value {@link #ALL_LEVELS} means that all subtrees should be expanded.
+     * </p>
+     *
+     * @param autoExpandLevel
+     *            The auto expand level to set
+     * @since 10.1
+     */
+    public void setAutoExpandLevel(int autoExpandLevel) {
+        this.fAutoExpandLevel = autoExpandLevel;
+    }
+
     /**
      *
      * A builder class to build instances implementing interface
@@ -131,6 +175,7 @@ public static class Builder<T extends ITmfTreeDataModel> {
         private List<ITableColumnDescriptor> fColumnDescriptors = new ArrayList<>();
         private List<T> fEntries;
         private @Nullable String fScope;
+        private int fAutoExpandLevel = ALL_LEVELS;
 
         /**
          * Constructor
@@ -175,6 +220,20 @@ public Builder<T> setScope(String scope) {
             return this;
         }
 
+        /**
+         * Sets which level of the tree should be expanded
+         *
+         * @param autoExpandLevel
+         *            expand level of the tree model
+         * @return this {@link Builder} object
+         * @see TmfTreeModel#setAutoExpandLevel(int)
+         * @since 10.1
+         */
+        public Builder<T> setAutoExpandLevel(int autoExpandLevel) {
+            fAutoExpandLevel = autoExpandLevel;
+            return this;
+        }
+
         /**
          * The method to construct an instance of {@link TmfTreeModel}
          *