tmf: Simplify and rename state system analysis validation

This commit moves parameter validation logic out of
AbstractStateSystemAnalysisDataProvider, retaining only the
check for analysis module initialization. This change allows
better support for data providers that do not share common
query parameters.

Signed-off-by: Siwei Zhang <siwei.zhang@ericsson.com>

Author: Siwei Zhang

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

@@ -1,5 +1,5 @@
 /**********************************************************************
- * Copyright (c) 2017 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
@@ -15,7 +15,6 @@
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.tracecompass.internal.tmf.core.model.TmfXyResponseFactory;
 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem;
-import org.eclipse.tracecompass.tmf.core.model.filters.TimeQueryFilter;
 import org.eclipse.tracecompass.tmf.core.model.xy.ITmfXyModel;
 import org.eclipse.tracecompass.tmf.core.response.TmfModelResponse;
 import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule;
@@ -24,8 +23,8 @@
 /**
  * Every data provider that used a TmfStateSystemAnalysisModule should extends
  * this class. The purpose of this class is to provide a common method to verify
- * parameters of fetch method before computing the model. It's intended only to
- * limit code duplication of verification in fetch method of concrete data
+ * analysis module initialization before computing the model. It's intended only
+ * to limit code duplication of verification in fetch method of concrete data
  * providers
  *
  * @author Yonni Chen
@@ -45,23 +44,21 @@ public AbstractStateSystemAnalysisDataProvider(ITmfTrace trace) {
 
     /**
      * This method is common to any data provider using a
-     * TmfStateSystemAnalysisModule. We simply verify that parameters passed in
-     * fetch method of data providers are correct before executing fetch method.
-     * This method is intended to limit duplication accross all data providers using
-     * TmfStateSystemAnalysisModule
+     * TmfStateSystemAnalysisModule. We simply verify that the analysis module
+     * and state system is initialized. This method is intended to limit
+     * duplication across all data providers using TmfStateSystemAnalysisModule.
      *
      * @param module
      *            A TmfStateSystemAnalysisModule. We are interested to know if
      *            initialization succeed
-     * @param filter
-     *            Contains the requested X values.
      * @param monitor
-     *            A ProgressMonitor. We are interested if task was cancelled before
-     *            proceding to request
+     *            A ProgressMonitor. We are interested if task was cancelled
+     *            before proceding to request
      * @return A {@link TmfModelResponse} if something went wrong. Null if
      *         everything is fine
+     * @since 10.2
      */
-    protected @Nullable TmfModelResponse<ITmfXyModel> verifyParameters(TmfStateSystemAnalysisModule module, TimeQueryFilter filter, @Nullable IProgressMonitor monitor) {
+    protected @Nullable TmfModelResponse<ITmfXyModel> verifyAnalysisModuleInitialization(TmfStateSystemAnalysisModule module, @Nullable IProgressMonitor monitor) {
         if (!module.waitForInitialization()) {
             return TmfXyResponseFactory.createFailedResponse(CommonStatusMessage.ANALYSIS_INITIALIZATION_FAILED);
         }
@@ -73,10 +70,6 @@ public AbstractStateSystemAnalysisDataProvider(ITmfTrace trace) {
             return TmfXyResponseFactory.createFailedResponse(CommonStatusMessage.STATE_SYSTEM_FAILED);
         }
 
-        long realStart = Math.max(ss.getStartTime(), filter.getStart());
-        if (realStart >= filter.getEnd()) {
-            return TmfXyResponseFactory.createEmptyResponse(CommonStatusMessage.INCORRECT_QUERY_INTERVAL);
-        }
         return null;
     }
 }

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/xy/AbstractTreeCommonXDataProvider.java

@@ -76,13 +76,17 @@ public final TmfModelResponse<ITmfXyModel> fetchXY(Map<String, Object> fetchPara
         if (filter == null) {
             return TmfXyResponseFactory.createFailedResponse(CommonStatusMessage.INCORRECT_QUERY_PARAMETERS);
         }
-        TmfModelResponse<ITmfXyModel> res = verifyParameters(module, filter, monitor);
+        TmfModelResponse<ITmfXyModel> res = verifyAnalysisModuleInitialization(module, monitor);
         if (res != null) {
             return res;
         }
 
         ITmfStateSystem ss = Objects.requireNonNull(module.getStateSystem(),
                 "Statesystem should have been verified by verifyParameters"); //$NON-NLS-1$
+        long realStart = Math.max(ss.getStartTime(), filter.getStart());
+        if (realStart >= filter.getEnd()) {
+            return TmfXyResponseFactory.createEmptyResponse(CommonStatusMessage.INCORRECT_QUERY_INTERVAL);
+        }
         long currentEnd = ss.getCurrentEndTime();
         boolean complete = ss.waitUntilBuilt(0) || filter.getEnd() <= currentEnd;