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

   1 /*******************************************************************************
   2  * Copyright (c) 2014 É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  *   Mathieu Rail - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.tests.stubs.analysis;
  14
  15 import java.util.Collection;
  16 import java.util.HashMap;
  17 import java.util.Map;
  18
  19 import org.eclipse.core.runtime.IProgressMonitor;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.eclipse.tracecompass.tmf.core.analysis.TmfAbstractAnalysisModule;
  22 import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisRequirement;
  23 import org.eclipse.tracecompass.tmf.core.analysis.TmfAnalysisRequirement.ValuePriorityLevel;
  24 import org.eclipse.tracecompass.tmf.core.exceptions.TmfAnalysisException;
  25 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  26 import org.eclipse.tracecompass.tmf.tests.stubs.trace.TmfTraceStub;
  27
  28 /**
  29  * Analysis type to test requirements acquisition
  30  */
  31 @SuppressWarnings({ "javadoc", "nls" })
  32 public class TestRequirementAnalysis extends TmfAbstractAnalysisModule {
  33     /* Test requirement types */
  34     public static final String EVENT_TYPE = "event";
  35     public static final String FIELD_TYPE = "field";
  36
  37     /* A few event names */
  38     public static final String EXIT_SYSCALL = "exit_syscall";
  39     public static final String SCHED_SWITCH = "sched_switch";
  40     public static final String SCHED_WAKEUP = "sched_wakeup";
  41
  42     /* A few fields */
  43     public static final String PID = "pid";
  44     public static final String TID = "tid";
  45
  46     @Override
  47     public boolean canExecute(ITmfTrace trace) {
  48         /* This just makes sure the trace is a ctf stub trace */
  49         return (TmfTraceStub.class.isAssignableFrom(trace.getClass()));
  50     }
  51
  52     @Override
  53     protected void canceling() {
  54
  55     }
  56
  57     @Override
  58     protected boolean executeAnalysis(final IProgressMonitor monitor) {
  59         return true;
  60     }
  61
  62     @Override
  63     public boolean setTrace(ITmfTrace trace) throws TmfAnalysisException {
  64         return super.setTrace(trace);
  65     }
  66
  67     @Override
  68     public Iterable<TmfAnalysisRequirement> getAnalysisRequirements() {
  69         Map<String, TmfAnalysisRequirement> requirements = new HashMap<>();
  70
  71         /* Event type requirement and values */
  72         TmfAnalysisRequirement eventReqs = new TmfAnalysisRequirement(EVENT_TYPE);
  73         eventReqs.addValue(EXIT_SYSCALL, ValuePriorityLevel.MANDATORY);
  74         eventReqs.addValue(SCHED_SWITCH, ValuePriorityLevel.MANDATORY);
  75         eventReqs.addValue(SCHED_WAKEUP, ValuePriorityLevel.MANDATORY);
  76         requirements.put(EVENT_TYPE, eventReqs);
  77
  78         /* Field type requirement and values */
  79         TmfAnalysisRequirement fieldReqs = new TmfAnalysisRequirement(FIELD_TYPE);
  80         fieldReqs.addValue(PID, ValuePriorityLevel.MANDATORY);
  81         fieldReqs.addValue(TID, ValuePriorityLevel.MANDATORY);
  82         requirements.put(FIELD_TYPE, fieldReqs);
  83
  84         @SuppressWarnings("null")
  85         @NonNull Collection<TmfAnalysisRequirement> values = requirements.values();
  86         return values;
  87     }
  88 }