org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/internal/tmf/core/trace/TmfExperimentLocation.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2013 Ericsson
   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  * Francois Chouinard - Initial API and implementation
  11  * Francois Chouinard - Updated as per TMF Trace Model 1.0
  12  * Patrick Tasse - Updated for ranks in experiment location
  13  *******************************************************************************/
  14
  15 package org.eclipse.linuxtools.internal.tmf.core.trace;
  16
  17 import org.eclipse.linuxtools.tmf.core.trace.ITmfLocation;
  18
  19
  20 /**
  21  * The experiment location in TMF.
  22  * <p>
  23  * An experiment location is actually the set of locations of the traces it
  24  * contains. By setting the individual traces to their corresponding locations,
  25  * the experiment can be positioned to read the next chronological event.
  26  * <p>
  27  * It is the responsibility of the user the individual trace locations are valid
  28  * and that they are matched to the correct trace.
  29  *
  30  * @version 1.0
  31  * @author Francois Chouinard
  32  *
  33  * @see TmfLocationArray
  34  */
  35 public final class TmfExperimentLocation implements ITmfLocation {
  36
  37     private final TmfLocationArray fLocation;
  38
  39     // ------------------------------------------------------------------------
  40     // Constructors
  41     // ------------------------------------------------------------------------
  42
  43     /**
  44      * The standard constructor
  45      *
  46      * @param locations the set of trace locations
  47      */
  48     public TmfExperimentLocation(TmfLocationArray locations) {
  49         fLocation = locations;
  50     }
  51
  52     /**
  53      * The copy constructor
  54      *
  55      * @param location the other experiment location
  56      */
  57     public TmfExperimentLocation(TmfExperimentLocation location) {
  58         this(location.getLocationInfo());
  59     }
  60
  61     // ------------------------------------------------------------------------
  62     // Object
  63     // ------------------------------------------------------------------------
  64
  65     /* (non-Javadoc)
  66      * @see org.eclipse.linuxtools.tmf.core.trace.TmfLocation#toString()
  67      */
  68     @Override
  69     @SuppressWarnings("nls")
  70     public String toString() {
  71         StringBuilder result = new StringBuilder("TmfExperimentLocation [");
  72         result.append(fLocation.toString());
  73         result.append("]");
  74         return result.toString();
  75     }
  76
  77     /* (non-Javadoc)
  78      * @see org.eclipse.linuxtools.tmf.core.trace.TmfLocation#hashCode()
  79      */
  80     @Override
  81     public int hashCode() {
  82         return super.hashCode();
  83     }
  84
  85     /* (non-Javadoc)
  86      * @see org.eclipse.linuxtools.tmf.core.trace.TmfLocation#equals(java.lang.Object)
  87      */
  88     @Override
  89     public boolean equals(Object obj) {
  90         if (this == obj) {
  91             return true;
  92         }
  93         if (!super.equals(obj)) {
  94             return false;
  95         }
  96         if (getClass() != obj.getClass()) {
  97             return false;
  98         }
  99         return true;
 100     }
 101
 102     /* (non-Javadoc)
 103      * @see org.eclipse.linuxtools.tmf.core.trace.ITmfLocation#getLocationData()
 104      */
 105     @Override
 106     public TmfLocationArray getLocationInfo() {
 107         return fLocation;
 108     }
 109
 110 }