org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/matching/ITmfMatchEventDefinition.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 2014 École Polytechnique de Montréal
   3  *
   4  * All rights reserved. This program and the accompanying materials are made
   5  * 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 implementation and API
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.core.event.matching;
  14
  15 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
  16 import org.eclipse.tracecompass.tmf.core.event.matching.TmfEventMatching.Direction;
  17 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  18
  19 /**
  20  * This interface describe a concrete method to match events. Typically it
  21  * manages for a given matching type what events/fields are used to match events
  22  *
  23  * @author Geneviève Bastien
  24  */
  25 public interface ITmfMatchEventDefinition {
  26
  27     /**
  28      * Returns a key for an event that uniquely identifies this event and will
  29      * match the key from another event.
  30      *
  31      * @param event
  32      *            The event for which to compute the key
  33      * @return the unique key for this event
  34      */
  35     IEventMatchingKey getEventKey(ITmfEvent event);
  36
  37     /**
  38      * Verifies whether a trace has all required events to match using this
  39      * class
  40      *
  41      * @param trace
  42      *            The trace
  43      * @return Whether the trace has all required information
  44      */
  45     boolean canMatchTrace(ITmfTrace trace);
  46
  47     /**
  48      * Returns the direction of this event, whether 'send', 'receive' or null if
  49      * event is neither
  50      *
  51      * @param event
  52      *            The event to check
  53      * @return The direction of this event, null if uninteresting event
  54      */
  55     Direction getDirection(ITmfEvent event);
  56
  57 }