Execution.java

package org.sigmah.client.util.profiler;

/*
 * #%L
 * Sigmah
 * %%
 * Copyright (C) 2010 - 2016 URD
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/gpl-3.0.html>.
 * #L%
 */

import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArray;
import com.google.gwt.user.client.Window;
import java.io.Serializable;
import java.util.Date;
import org.sigmah.client.Sigmah;
import org.sigmah.client.util.JsIterable;
import org.sigmah.offline.appcache.ApplicationCache;
import org.sigmah.offline.js.Values;
import org.sigmah.shared.dto.profile.ExecutionDTO;
import org.sigmah.shared.util.Collections;

/**
 * Execution of a scenario.
 * 
 * @author Raphaël Calabro (raphael.calabro@netapsys.fr)
 */
public final class Execution extends JavaScriptObject implements Serializable {
	
	/**
	 * Mapper to convert an instance of <code>Execution</code> to an instance
	 * of <code>ExecutionDTO</code>.
	 */
	public static final Collections.Mapper<Execution, ExecutionDTO> DTO_MAPPER;
	
	static {
		DTO_MAPPER = new Collections.Mapper<Execution, ExecutionDTO>() {
			
			@Override
			public ExecutionDTO forEntry(final Execution entry) {
				return entry.toDTO();
			}
			
		};
	}
	
	/**
	 * Creates a new execution for the given scenario.
	 * 
	 * @param scenario Scenario.
	 * @return A new <code>Execution</code>.
	 */
	public static Execution create(Scenario scenario) {
		final Execution execution = Values.createJavaScriptObject(Execution.class);
		execution.setScenario(scenario);
		execution.setDate(new Date());
		execution.setDuration(0);
		execution.setVersionNumber(Sigmah.VERSION);
		execution.setUserAgent(Window.Navigator.getUserAgent());
		execution.setApplicationCacheStatus(ApplicationCache.getApplicationCache().getStatus().name());
		execution.setCheckpoints(Values.createTypedJavaScriptArray(Checkpoint.class));
		return execution;
	}
	
	protected Execution() {
		// Not accessible.
	}
	
	/**
	 * Creates a new <code>ExecutionDTO</code> with the data contained in this
	 * instance.
	 * 
	 * @return A new <code>ExecutionDTO</code>.
	 */
	public ExecutionDTO toDTO() {
		final ExecutionDTO dto = new ExecutionDTO();
		
		dto.setApplicationCacheStatus(getApplicationCacheStatus());
		dto.setDate(getDate());
		dto.setOnligne(isOnline());
		dto.setScenario(getScenario());
		dto.setUserAgent(getUserAgent());
		dto.setUserEmailAddress(getUserEmailAddress());
		dto.setVersionNumber(getVersionNumber());
		dto.setDuration(getDuration());
		
		for (final Checkpoint checkPoint : getCheckpointSequence()) {
			dto.getCheckpoints().add(checkPoint.toDTO());
		}
		
		return dto;
	}

	public Scenario getScenario() {
		return Scenario.valueOf(getScenarioName());
	}

	public void setScenario(Scenario scenario) {
		setScenarioName(scenario.name());
	}

	public Date getDate() {
		return Values.getDate(this, "date");
	}

	public void setDate(Date date) {
		Values.setDate(this, "date", date);
	}

	public native String getScenarioName() /*-{
		return this.scenario;
	}-*/;

	public native void setScenarioName(String name) /*-{
		this.scenario = name;
	}-*/;

	public native double getDuration() /*-{
		return this.duration;
	}-*/;
	
	public native void setDuration(double duration) /*-{
		this.duration = duration;
	}-*/;
	
	public native String getUserEmailAddress() /*-{
		return this.userEmailAddress;
	}-*/;
	
	public native void setUserEmailAddress(String userEmailAddress) /*-{
		this.userEmailAddress = userEmailAddress;
	}-*/;

	public native String getVersionNumber() /*-{
		return this.versionNumber;
	}-*/;
	
	public native void setVersionNumber(String versionNumber) /*-{
		this.versionNumber = versionNumber;
	}-*/;

	public native String getUserAgent() /*-{
		return this.userAgent;
	}-*/;
	
	public native void setUserAgent(String userAgent) /*-{
		this.userAgent = userAgent;
	}-*/;
	
	public native boolean isOnline() /*-{
		return this.online;
	}-*/;
	
	public native void setOnline(boolean online) /*-{
		this.online = online;
	}-*/;
	
	public native String getApplicationCacheStatus() /*-{
		return this.applicationCacheStatus;
	}-*/;
	
	public native void setApplicationCacheStatus(String applicationCacheStatus) /*-{
		this.applicationCacheStatus = applicationCacheStatus;
	}-*/;
	
	public native JsArray<Checkpoint> getCheckpoints() /*-{
		return this.checkpoints;
	}-*/;
	
	public Iterable<Checkpoint> getCheckpointSequence() {
		return new JsIterable<Checkpoint>(getCheckpoints());
	}
	
	public native void setCheckpoints(JsArray<Checkpoint> checkpoints) /*-{
		this.checkpoints = checkpoints;
	}-*/;
	
	/**
	 * Adds a new checkpoint.
	 * 
	 * @param name Description of the checkpoint.
	 * @param time Time when the checkpoint has been reached.
	 */
	public native void addCheckpoint(String name, double time) /*-{
		this.checkpoints.push({"name": name, "time": time, "duration": 0});
	}-*/;
	
}