tmf/org.eclipse.tracecompass.tmf.core.tests/stubs/org/eclipse/tracecompass/tmf/tests/stubs/analysis/TestExperimentAnalysis.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014, 2016 École Polytechnique de Montréal
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Geneviève Bastien - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.tests.stubs.analysis;
  14
  15 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  16
  17 import java.util.HashSet;
  18 import java.util.Set;
  19
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystemBuilder;
  22 import org.eclipse.tracecompass.statesystem.core.exceptions.StateValueTypeException;
  23 import org.eclipse.tracecompass.statesystem.core.exceptions.TimeRangeException;
  24 import org.eclipse.tracecompass.statesystem.core.statevalue.TmfStateValue;
  25 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
  26 import org.eclipse.tracecompass.tmf.core.statesystem.AbstractTmfStateProvider;
  27 import org.eclipse.tracecompass.tmf.core.statesystem.ITmfStateProvider;
  28 import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule;
  29 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  30
  31 /**
  32  * Stubs for experiment analysis. This analysis is a state system analysis that
  33  * simply counts the number of traces for which events were received. The number
  34  * of traces is the value of attribute
  35  * {@link TestExperimentAnalysis#TRACE_QUARK_NAME}.
  36  *
  37  * @author Geneviève Bastien
  38  */
  39 public class TestExperimentAnalysis extends TmfStateSystemAnalysisModule {
  40
  41     /**
  42      * The quark counting the number of traces
  43      */
  44     public static final String TRACE_QUARK_NAME = "Traces";
  45
  46     @Override
  47     protected ITmfStateProvider createStateProvider() {
  48         return new TestExpStateSystemProvider(checkNotNull(getTrace()));
  49     }
  50
  51     @Override
  52     protected StateSystemBackendType getBackendType() {
  53         return StateSystemBackendType.INMEM;
  54     }
  55
  56     private class TestExpStateSystemProvider extends AbstractTmfStateProvider {
  57
  58         private static final int VERSION = 1;
  59         private final Set<ITmfTrace> fTraces = new HashSet<>();
  60         private int fCount = 0;
  61
  62         /**
  63          * Constructor
  64          *
  65          * @param trace
  66          *            The LTTng 2.0 kernel trace directory
  67          */
  68         public TestExpStateSystemProvider(@NonNull ITmfTrace trace) {
  69             super(trace, "Stub State System for Experiment");
  70         }
  71
  72         @Override
  73         public int getVersion() {
  74             return VERSION;
  75         }
  76
  77         @Override
  78         public ITmfStateProvider getNewInstance() {
  79             return new TestExpStateSystemProvider(this.getTrace());
  80         }
  81
  82         @Override
  83         protected void eventHandle(ITmfEvent event) {
  84             ITmfStateSystemBuilder ss = checkNotNull(getStateSystemBuilder());
  85             if (!fTraces.contains(event.getTrace())) {
  86                 try {
  87                     int quarkId = ss.getQuarkAbsoluteAndAdd(TRACE_QUARK_NAME);
  88                     ss.modifyAttribute(event.getTimestamp().getValue(), TmfStateValue.newValueInt(++fCount), quarkId);
  89                     fTraces.add(event.getTrace());
  90                 } catch (TimeRangeException | StateValueTypeException e) {
  91
  92                 }
  93             }
  94         }
  95     }
  96 }