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