Refactor ITmfLocation and fix dependencies

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / experiment / TmfExperimentContext.java

/*******************************************************************************
 * Copyright (c) 2009, 2010 Ericsson
 * 
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *   Francois Chouinard - Initial API and implementation
 *******************************************************************************/

package org.eclipse.linuxtools.tmf.core.experiment;

import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
import org.eclipse.linuxtools.tmf.core.trace.ITmfContext;
import org.eclipse.linuxtools.tmf.core.trace.ITmfLocation;
import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
import org.eclipse.linuxtools.tmf.core.trace.TmfContext;

/**
 * <b><u>TmfExperimentContext</u></b>
 * <p>
 * The experiment keeps track of the next event from each of its traces so
 * it can pick the next one in chronological order.
 * <p>
 * This implies that the "next" event from each trace has already been
 * read and that we at least know its timestamp. This doesn't imply that a
 * full parse of the event content was performed (read: LTTng works like 
 * this).
 * <p>
 * The last trace refers to the trace from which the last event was
 * "consumed" at the experiment level.
 */
public class TmfExperimentContext extends TmfContext {

	// ------------------------------------------------------------------------
	// Constants
	// ------------------------------------------------------------------------
	
	 public static final int NO_TRACE = -1;

	// ------------------------------------------------------------------------
	// Attributes
	// ------------------------------------------------------------------------

	private ITmfTrace<?>[]  fTraces = new ITmfTrace[0];
	private ITmfContext[] fContexts;
	private ITmfEvent[]   fEvents;
	private int lastTraceRead;

	// ------------------------------------------------------------------------
	// Constructors
	// ------------------------------------------------------------------------

	public TmfExperimentContext(ITmfTrace<?>[] traces, ITmfContext[] contexts) {
		super();
		fTraces   = traces;
		fContexts = contexts;
		fEvents   = new ITmfEvent[fTraces.length];

		ITmfLocation<?>[] locations = new ITmfLocation[fTraces.length];
		long[] ranks = new long[fTraces.length];
		long rank = 0;
		for (int i = 0; i < fTraces.length; i++) {
			if (contexts[i] != null) {
				locations[i] = contexts[i].getLocation();
				ranks[i] = contexts[i].getRank();
				rank += contexts[i].getRank();
			}
		}
		
		setLocation(new TmfExperimentLocation(new TmfLocationArray(locations), ranks));
		setRank(rank);
		lastTraceRead = NO_TRACE;
	}

	public TmfExperimentContext(ITmfTrace<?>[] traces) {
		this(traces, new TmfContext[traces.length]);
	}

	public TmfExperimentContext(TmfExperimentContext other) {
		this(other.fTraces, other.cloneContexts());
		fEvents = other.fEvents;
		if (other.getLocation() != null)
			setLocation(other.getLocation().clone());
		setRank(other.getRank());
		setLastTrace(other.lastTraceRead);
	}

	private ITmfContext[] cloneContexts() {
		ITmfContext[] contexts = new TmfContext[fContexts.length];
		for (int i = 0; i < fContexts.length; i++)
			contexts[i] = fContexts[i].clone();
		return contexts;
	}

	// ------------------------------------------------------------------------
	// Accessors
	// ------------------------------------------------------------------------

	public ITmfTrace<?>[] getTraces() {
		return fTraces;
	}

	public ITmfContext[] getContexts() {
		return fContexts;
	}

	public ITmfEvent[] getEvents() {
		return fEvents;
	}

	public int getLastTrace() {
		return lastTraceRead;
	}

	public void setLastTrace(int newIndex) {
		lastTraceRead = newIndex;
	}

	// ------------------------------------------------------------------------
	// Object
	// ------------------------------------------------------------------------

    @Override
    public int hashCode() {
		int result = 17;
    	for (int i = 0; i < fTraces.length; i++) {
    		result = 37 * result + fTraces[i].hashCode();
    		result = 37 * result + fContexts[i].hashCode();
    	}
    	return result;
    }
 
    @Override
    public boolean equals(Object other) {
        if (this == other)
            return true;
        if (!super.equals(other))
            return false;
    	if (!(other instanceof TmfExperimentContext)) {
    		return false;
    	}
    	TmfExperimentContext o = (TmfExperimentContext) other;
    	boolean isEqual = true;
    	int i = 0;
    	while (isEqual && i < fTraces.length) {
    		isEqual &= fTraces[i].equals(o.fTraces[i]);
    		isEqual &= fContexts[i].equals(o.fContexts[i]);
    		i++;
    	}
    	return isEqual;
    }
 
}