Comments on "Frallax feedback" #1
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
create() and remove() includes how the analysis module is initialized and how the configuration file is managed. But we're writing config files in our own specified location (per data provider id), so those are preferably in our own code?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And if we move create() and remove() to internal code,
AbstractTmfDataProviderConfigurator.traceOpened()andTmfConfiguration.readConfigurations()also needs to be in internal code, because we no longer have control over where we store the files.