tmf: extend api for configuration 2

Author: frallax

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/config/AbstractTmfDataProviderConfigurator.java

@@ -0,0 +1,150 @@
+package org.eclipse.tracecompass.tmf.core.config;
+
+import java.util.List;
+
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.tracecompass.tmf.core.dataprovider.IDataProviderDescriptor;
+import org.eclipse.tracecompass.tmf.core.exceptions.TmfConfigurationException;
+import org.eclipse.tracecompass.tmf.core.signal.TmfSignalHandler;
+import org.eclipse.tracecompass.tmf.core.signal.TmfTraceClosedSignal;
+import org.eclipse.tracecompass.tmf.core.signal.TmfTraceOpenedSignal;
+import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
+import org.eclipse.tracecompass.tmf.core.trace.TmfTraceManager;
+import org.eclipse.tracecompass.tmf.core.trace.experiment.TmfExperiment;
+
+import com.google.common.collect.HashBasedTable;
+import com.google.common.collect.Table;
+
+/**
+ *
+ */
+public abstract class AbstractTmfDataProviderConfigurator implements ITmfDataProviderConfigurator{
+
+    private static final Table<String, ITmfTrace, ITmfConfiguration> fTmfConfigurationTable = HashBasedTable.create();
+
+    @Override
+    public @NonNull IDataProviderDescriptor createDataProviderDescriptors(ITmfTrace trace, ITmfConfiguration configuration) throws TmfConfigurationException {
+
+        if (configuration.getName().equals(TmfConfiguration.UNKNOWN)) {
+            throw new TmfConfigurationException("Missing configuration name of InAndOut analysis"); //$NON-NLS-1$
+        }
+
+        if (configuration.getSourceTypeId().equals(TmfConfiguration.UNKNOWN)) {
+            throw new TmfConfigurationException("Missing configuration type for InAndOut analysis"); //$NON-NLS-1$
+        }
+
+        String description = configuration.getDescription();
+        if (configuration.getDescription().equals(TmfConfiguration.UNKNOWN)) {
+            description = "InAndOut Analysis defined by configuration " + configuration.getName(); //$NON-NLS-1$
+        }
+
+        TmfConfiguration.Builder builder = new TmfConfiguration.Builder();
+        builder.setId(configuration.getId())
+               .setSourceTypeId(configuration.getSourceTypeId())
+               .setName(configuration.getName())
+               .setDescription(description)
+               .setParameters(configuration.getParameters())
+               .build();
+
+        ITmfConfiguration config = builder.build();
+
+        applyConfiguration(trace, config, true);
+        if (fTmfConfigurationTable.contains(config.getId(), trace)) {
+            throw new TmfConfigurationException("Configuration already existis with label: " + config.getName()); //$NON-NLS-1$
+        }
+        fTmfConfigurationTable.put(config.getId(), trace, config);
+        return getDescriptorFromConfig(config);
+    }
+
+    /**
+     * @param config
+     * @return A data provider descriptor based on the configuration parameter
+     */
+    protected abstract IDataProviderDescriptor getDescriptorFromConfig(ITmfConfiguration config);
+
+    /**
+     * This is the method that handles what happens when a configuration is applied
+     * @param trace
+     * @param config
+     * @param writeConfig
+     */
+    protected abstract void applyConfiguration(ITmfTrace trace, ITmfConfiguration config, boolean writeConfig);
+
+    // efrooo: the below move to open source
+    @Override
+    public void removeDataProviderDescriptor(ITmfTrace trace, IDataProviderDescriptor descriptor) throws TmfConfigurationException {
+        ITmfConfiguration creationConfiguration = descriptor.getConfiguration();
+        if (creationConfiguration == null) {
+            throw new TmfConfigurationException("Data provider was not created by a configuration"); //$NON-NLS-1$
+        }
+
+        String configId = creationConfiguration.getId();
+        ITmfConfiguration config = fTmfConfigurationTable.get(configId, trace);
+        if (config == null) {
+            return;
+        }
+        config = fTmfConfigurationTable.remove(configId, trace);
+        removeConfiguration(trace, config);
+    }
+
+    /**
+     * This is the method that handles what happens when a configuration is removed (e.g. remove analysis, dp etc)
+     * @param trace
+     * @param config
+     */
+    protected abstract void removeConfiguration(@NonNull ITmfTrace trace, @NonNull ITmfConfiguration config);
+
+    // efroroo: to open source
+    /**
+     * Signal handler for opened trace signal. Will populate trace
+     * configurations
+     *
+     * @param signal
+     *            the signal to handle
+     */
+    @TmfSignalHandler
+    public void traceOpened(TmfTraceOpenedSignal signal, String subfolder) {
+        ITmfTrace trace = signal.getTrace();
+        if (trace == null) {
+            return;
+        }
+        try {
+            if (trace instanceof TmfExperiment) {
+                for (ITmfTrace tr : TmfTraceManager.getTraceSet(trace)) {
+                   // Read configurations from sub-trace
+                   List<ITmfConfiguration> configs = TmfConfiguration.readConfigurations(tr, subfolder);
+                   readAndApplyConfiguration(trace, configs);
+                }
+            } else {
+                // Read configurations trace
+                List<ITmfConfiguration> configs = TmfConfiguration.readConfigurations(trace, subfolder);
+                readAndApplyConfiguration(trace, configs);
+            }
+       } catch (TmfConfigurationException e) {
+           // FIXME: use proper logging
+           // Activator.logError("Error applying configurations for trace " + trace.getName(), e); //$NON-NLS-1$
+       }
+    }
+
+    /**
+     * Handles trace closed signal
+     *
+     * @param signal
+     *            the close signal to handle
+     */
+    @TmfSignalHandler
+    public void traceClosed(TmfTraceClosedSignal signal) {
+        ITmfTrace trace = signal.getTrace();
+        fTmfConfigurationTable.column(trace).clear();
+    }
+
+    private void readAndApplyConfiguration(ITmfTrace trace, List<ITmfConfiguration> configs) throws TmfConfigurationException {
+        for (ITmfConfiguration config : configs) {
+            if (!fTmfConfigurationTable.contains(config.getId(), trace)) {
+                fTmfConfigurationTable.put(config.getId(), trace, config);
+                applyConfiguration(trace, config, false);
+            }
+        }
+    }
+
+}