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.Set;
  16
  17 import org.eclipse.core.runtime.IProgressMonitor;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.eclipse.tracecompass.tmf.core.analysis.TmfAbstractAnalysisModule;
  20 import org.eclipse.tracecompass.tmf.core.analysis.requirements.TmfAbstractAnalysisRequirement;
  21 import org.eclipse.tracecompass.tmf.core.exceptions.TmfAnalysisException;
  22 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  23 import org.eclipse.tracecompass.tmf.tests.stubs.trace.TmfTraceStub;
  24
  25 import com.google.common.collect.ImmutableSet;
  26
  27 /**
  28  * Analysis type to test requirements acquisition
  29  */
  30 @SuppressWarnings({ "javadoc", "nls" })
  31 public class TestRequirementAnalysis extends TmfAbstractAnalysisModule {
  32     /* Test requirement types */
  33     public static final @NonNull String EVENT_TYPE = "event";
  34     public static final @NonNull String FIELD_TYPE = "field";
  35
  36     /* A few event names */
  37     public static final @NonNull String EXIT_SYSCALL = "exit_syscall";
  38     public static final @NonNull String SCHED_SWITCH = "sched_switch";
  39     public static final @NonNull String SCHED_WAKEUP = "sched_wakeup";
  40
  41     /* A few fields */
  42     public static final @NonNull String PID = "pid";
  43     public static final @NonNull String TID = "tid";
  44
  45     @Override
  46     public boolean canExecute(ITmfTrace trace) {
  47         /* This just makes sure the trace is a ctf stub trace */
  48         return (TmfTraceStub.class.isAssignableFrom(trace.getClass()));
  49     }
  50
  51     @Override
  52     protected void canceling() {
  53
  54     }
  55
  56     @Override
  57     protected boolean executeAnalysis(final IProgressMonitor monitor) {
  58         return true;
  59     }
  60
  61     @Override
  62     public boolean setTrace(ITmfTrace trace) throws TmfAnalysisException {
  63         return super.setTrace(trace);
  64     }
  65
  66     @Override
  67     public Iterable<TmfAbstractAnalysisRequirement> getAnalysisRequirements() {
  68         Set<TmfAbstractAnalysisRequirement> requirements = ImmutableSet.of(
  69                 AnalysisRequirementFactory.REQUIREMENT_1,
  70                 AnalysisRequirementFactory.REQUIREMENT_3);
  71
  72         return requirements;
  73     }
  74 }