analysis/org.eclipse.stem.util.analysis/src/org/eclipse/stem/util/analysis/views/ScenarioComparisonControl.java - stem/org.eclipse.stem - Git at Google

 // EstimatorControl.java
 package org.eclipse.stem.util.analysis.views;

 /*******************************************************************************
  * Copyright (c) 2007, 2008 IBM Corporation and others.
  * 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:
  *     IBM Corporation - initial API and implementation
  *******************************************************************************/

 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;

 import org.eclipse.birt.chart.model.attribute.ColorDefinition;
 import org.eclipse.birt.chart.model.attribute.impl.ColorDefinitionImpl;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IConfigurationElement;
 import org.eclipse.core.runtime.IExtensionRegistry;
 import org.eclipse.core.runtime.Platform;
 import org.eclipse.emf.common.util.EList;
 import org.eclipse.jface.dialogs.ProgressMonitorDialog;
 import org.eclipse.stem.analysis.ErrorFunction;
 import org.eclipse.stem.analysis.ErrorResult;
 import org.eclipse.stem.analysis.ScenarioInitializationException;
 import org.eclipse.stem.util.analysis.Activator;
 import org.eclipse.stem.util.analysis.CSVAnalysisWriter;
 import org.eclipse.stem.util.analysis.ScenarioAnalysisSuite;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.events.DisposeEvent;
 import org.eclipse.swt.events.DisposeListener;
 import org.eclipse.swt.events.SelectionAdapter;
 import org.eclipse.swt.events.SelectionEvent;
 import org.eclipse.swt.graphics.Font;
 import org.eclipse.swt.layout.FormAttachment;
 import org.eclipse.swt.layout.FormData;
 import org.eclipse.swt.layout.FormLayout;
 import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Combo;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.DirectoryDialog;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Label;
 import org.eclipse.swt.widgets.Shell;
 import org.eclipse.swt.widgets.Text;

 /**
  * This class is a SWT GUI component that uses BIRT to plot
  */
 public class ScenarioComparisonControl extends AnalysisControl {

 	/**
 	 * used to identify user preferences for this class
 	 * This String is not human readable so does not need to be NLS'd. It is a key in a map
 	 */
 	private static final String CONSUMER = "SCENARIOCOMPARISON_CONTROL";

 	/**
 	 * used to remember the primary directory in the user preferences
 	 * This String is not human readable so does not need to be NLS'd. It is a key in a map
 	 */
 	private static final String PRIMARY_FOLDER_KEY = CONSUMER+"_PRIMARY";
 	/**
 	 * used to remember the secondary directory in the user preferences
 	 * This String is not human readable so does not need to be NLS'd. It is a key in a map
 	 */
 	private static final String SECONDARY_FOLDER_KEY = CONSUMER+"_SECONDARY";

 	/**
 	 *  First Scenario Label - indicates number of regions being watched for analysis.
 	 *  There are locations with relative value history providers attached
 	 */
 	Label firstScenarioFolderLabel;

 	/**
 	 *  Second Scenario Label - indicates number of regions being watched for analysis.
 	 *  There are locations with relative value history providers attached
 	 */
 	Label secondScenarioFolderLabel;

 	/**
 	 * First input text field for the scenario folder of data to use in making the estimation
 	 */
 	Text text1;


 	/**
 	 * Second Input text field for the scenario folder of data to be compared
 	 **/
 	Text text2;


 	protected Combo errorFunctionCombo;
 	protected ErrorFunction [] errorFunctions;

 	/**
 	 * Results of analysis
 	 */
 	Label statusLabel;


 	/**
 	 * Colors for the time series chart
 	 */
 	static final ColorDefinition foreGround = ColorDefinitionImpl.BLACK();
 	static final ColorDefinition backgroundGround = ColorDefinitionImpl.create(255, 231, 186);//color is called wheat
 	static final ColorDefinition frameColor = ColorDefinitionImpl.create(220, 220, 220);

 	static final String ROOT_PATH =  Platform.getLocation().toOSString();
 	/**
 	 * the chart of results
 	 */
 	static TimeSeriesCanvas timeSeriesCanvas;


 	/**
 	 * the results of various scenario comparisons
 	 * TODO: eventually this might be a map keyed by comparison id
 	 * for now there is only one comparison, the mean square difference.
 	 */
 	List<EList<Double>> comparisonValues = new ArrayList<EList<Double>>();

 	private static final String COMPARISON_FILE_NAME = "RMSCompare";
 	private static final String SELECT_FOLDER_DIALOG_TEXT = "Pick a scenario folder";

 	ScenarioAnalysisSuite analyzer = new ScenarioAnalysisSuite(this);

 	/**
 	 *
 	 * @param parent
 	 */
 	public ScenarioComparisonControl(final Composite parent) {
 		super(parent, SWT.None);
 		createContents();
 	} // EstimatorControl

 	/**
 	 * Create the contents of the plotter
 	 */
 	private void createContents() {
 		Display display = this.getDisplay();
 		setLayout(new FormLayout());

 		identifiableTitle = new Label(this, SWT.NONE);

 		final Font newFont = getLargerFont(18, display);

 		identifiableTitle.setFont(newFont);
 		// Since you created the font, you must dispose it
 		identifiableTitle.addDisposeListener(new DisposeListener() {
 		    public void widgetDisposed(DisposeEvent e) {
 		        newFont.dispose();
 		    }
 		});
 		identifiableTitle.setText(Messages.getString("COMP.TITLE"));
 		//propertySelector = new PropertySelector(this, SWT.NONE);


 		statusLabel = new Label(this, SWT.BORDER);
 		statusLabel.setText("");

 		firstScenarioFolderLabel = new Label(this, SWT.BORDER);
 		firstScenarioFolderLabel.setText(Messages.getString("COMP.FOLDER1LABEL"));

 		text1 = new Text(this, SWT.BORDER);
 	    String primaryDir=prefs.getRecentFolder(PRIMARY_FOLDER_KEY);
 	    text1.setText(primaryDir);

 	    secondScenarioFolderLabel = new Label(this, SWT.BORDER);
 	    secondScenarioFolderLabel.setText(Messages.getString("COMP.FOLDER2LABEL"));

 		text2 = new Text(this, SWT.BORDER);
 	    String secondaryDir=prefs.getRecentFolder(SECONDARY_FOLDER_KEY);
 	    text2.setText(secondaryDir);

 	    Composite analyzeButtonComposite = getAnalyzeButtonComposite(this,Messages.getString("COMP.ANALYZE"));

 		statusLabel = new Label(this, SWT.SHADOW_OUT);
 		statusLabel.setBackground(display.getSystemColor(SWT.COLOR_WHITE));
 		statusLabel.setText(Messages.getString("COMP.RESULTS"));

 		int spacer = 5;
 		int buttonspacer = 0;

 		final FormData titleFormData = new FormData();
 		identifiableTitle.setLayoutData(titleFormData);
 		titleFormData.top = new FormAttachment(0, 0);
 //		titleFormData.bottom = new FormAttachment(bottom, 0);
 		titleFormData.left = new FormAttachment(0, 0);
 		titleFormData.right = new FormAttachment(100, 0);

 //		bottom += deltaBottom;
         /////////////////////////////////////////////////////////////////////////
 		// TextField folder label
 		final FormData firstScenarioFolderLabelFormData = new FormData();
 		// propertySelectorFormData.top = new FormAttachment(cSVLoggerCanvas,
 		// 0);
 		firstScenarioFolderLabelFormData.top = new FormAttachment(identifiableTitle, spacer);
 //		firstScenarioFolderLabelFormData.bottom = new FormAttachment(bottom, 0);
 		firstScenarioFolderLabelFormData.left = new FormAttachment(0, 0);
 		firstScenarioFolderLabelFormData.right = new FormAttachment(15, 0);
 		firstScenarioFolderLabel.setLayoutData(firstScenarioFolderLabelFormData);
 		// first text field for parameter Estimator
 		final FormData text1FormData = new FormData();
 		text1FormData.top = new FormAttachment(identifiableTitle,spacer);
 	//	text1FormData.bottom = new FormAttachment(bottom, 0);
 		text1FormData.left = new FormAttachment(firstScenarioFolderLabel, 0);
 		text1FormData.right = new FormAttachment(85, 0);
 		text1.setLayoutData(text1FormData);


 		Button selectFolder1Button = new Button(this, SWT.NONE);
 		selectFolder1Button.setText(Messages.getString("COMP.SELECTFOLDERBUTTON"));
 		final FormData selectFolder1FormData = new FormData();
 		selectFolder1FormData.top = new FormAttachment(identifiableTitle, buttonspacer);
 	//	selectFolder1FormData.bottom = new FormAttachment(bottom, 0);
 		selectFolder1FormData.left = new FormAttachment(text1, 0);
 	//	selectFolder1FormData.right = new FormAttachment(100, 0);
 		selectFolder1Button.setLayoutData(selectFolder1FormData);

 		final Shell shell = this.getShell();

 		selectFolder1Button.addSelectionListener(new SelectionAdapter() {
 			@Override
 			public void widgetSelected(@SuppressWarnings("unused")
 			final SelectionEvent e) {
 				final DirectoryDialog dd = new DirectoryDialog(
 						shell, SWT.OPEN);
 					dd.setText(SELECT_FOLDER_DIALOG_TEXT); //$NON-NLS-1$
 					String beginSearch = text1.getText();
 					if((beginSearch==null)||(beginSearch.length()<1)) beginSearch = ROOT_PATH;

 					dd.setFilterPath(beginSearch);
 					final String selected = dd.open();
 					if(selected!=null) text1.setText(selected);
 			}
 		});


         /////////////////////////////////////////////////////////////////////////

 //		bottom += deltaBottom;

         /////////////////////////////////////////////////////////////////////////
 		// TextField folder label
 		final FormData secondScenarioFolderLabelFormData = new FormData();
 		// propertySelectorFormData.top = new FormAttachment(cSVLoggerCanvas,
 		// 0);
 		secondScenarioFolderLabelFormData.top = new FormAttachment(firstScenarioFolderLabel,spacer);
 //		secondScenarioFolderLabelFormData.bottom = new FormAttachment(bottom, 0);
 		secondScenarioFolderLabelFormData.left = new FormAttachment(0, 0);
 		secondScenarioFolderLabelFormData.right = new FormAttachment(15, 0);
 		secondScenarioFolderLabel.setLayoutData(secondScenarioFolderLabelFormData);
 		// first text field for parameter Estimator
 		final FormData text2FormData = new FormData();
 		text2FormData.top = new FormAttachment(text1, spacer);
 //		text2FormData.bottom = new FormAttachment(bottom, 0);
 		text2FormData.left = new FormAttachment(secondScenarioFolderLabel, 0);
 		text2FormData.right = new FormAttachment(85, 0);
 		text2.setLayoutData(text2FormData);

 		Button selectFolder2Button = new Button(this, SWT.NONE);
 		selectFolder2Button.setText(Messages.getString("COMP.SELECTFOLDERBUTTON"));
 		final FormData selectFolder2FormData = new FormData();
 		selectFolder2FormData.top = new FormAttachment(text1, buttonspacer);
 //		selectFolder2FormData.bottom = new FormAttachment(bottom, 0);
 		selectFolder2FormData.left = new FormAttachment(text2, 0);
 //		selectFolder2FormData.right = new FormAttachment(100, 0);
 		selectFolder2Button.setLayoutData(selectFolder2FormData);

 		selectFolder2Button.addSelectionListener(new SelectionAdapter() {
 			@Override
 			public void widgetSelected(@SuppressWarnings("unused")
 			final SelectionEvent e) {
 				final DirectoryDialog dd = new DirectoryDialog(
 						shell, SWT.OPEN);
 					dd.setText(Messages.getString("COMP.SELECTFOLDERDIALOG")); //$NON-NLS-1$
 					String beginSearch = text2.getText();
 					if((beginSearch==null)||(beginSearch.length()<1)) beginSearch = ROOT_PATH;

 					dd.setFilterPath(beginSearch);
 					final String selected = dd.open();
 					if(selected!=null) text2.setText(selected);
 			}
 		});

 		/////////////////////////////////////////////////////////////////////////

 //		bottom += deltaBottom;

 		Label errorFunctionLabel = new Label(this, SWT.NONE);
 		final FormData errorFunctionLabelFormData = new FormData();
 		// propertySelectorFormDataX.top = new FormAttachment(propertySelectorY,
 		// 0);
 		errorFunctionLabelFormData.top = new FormAttachment(text2, spacer);
 		errorFunctionLabelFormData.left = new FormAttachment(0, 0);
 		errorFunctionLabelFormData.right = new FormAttachment(15, 0);
 		errorFunctionLabel.setLayoutData(errorFunctionLabelFormData);
 		errorFunctionLabel.setText(Messages.getString("COMP.ERRORFUNCTION"));

 		errorFunctionCombo = new Combo(this, SWT.NONE);
 		final FormData errorFunctionComboFormData = new FormData();
 		errorFunctionComboFormData.top = new FormAttachment(text2, spacer);
 //		errorFunctionComboFormData.bottom = new FormAttachment(bottom, 0);
 		errorFunctionComboFormData.left = new FormAttachment(errorFunctionLabel, 5);
 //		errorFunctionComboFormData.right = new FormAttachment(80, 0);
 		errorFunctionCombo.setLayoutData(errorFunctionComboFormData);

 		populateErrorFunctionCombo();

 //		bottom += deltaBottom;

 		// AnalyzeButton
 		final FormData analysisButtonFormData = new FormData();
 		// propertySelectorFormDataX.top = new FormAttachment(propertySelectorY,
 		// 0);
 		analysisButtonFormData.top = new FormAttachment(errorFunctionCombo, spacer);
 //		analysisButtonFormData.bottom = new FormAttachment(bottom, 0);
 		analysisButtonFormData.left = new FormAttachment(0, 0);
 		analysisButtonFormData.right = new FormAttachment(100, 0);
 		analyzeButtonComposite.setLayoutData(analysisButtonFormData);


 		// Results Graph
 		timeSeriesCanvas = new TimeSeriesCanvas(this,
 													Messages.getString("COMP.RMSDIFFERENCELABEL"),
 													Messages.getString("COMP.RMSSTRING"),
 													Messages.getString("COMP.RMSSTRING"),
 													foreGround,
 													backgroundGround,
 													frameColor, 0);

 		final FormData chartFormData = new FormData();
 		timeSeriesCanvas.setLayoutData(chartFormData);
 		chartFormData.top = new FormAttachment(analyzeButtonComposite, 0);
 		chartFormData.bottom = new FormAttachment(90, 0);
 		chartFormData.left = new FormAttachment(0, 0);
 		chartFormData.right = new FormAttachment(100, 0);

 		/*
 		final FormData resultsSelectorFormData = new FormData();
 		resultsSelectorFormData.top = new FormAttachment(analyzeButton, 0);
 		resultsSelectorFormData.bottom = new FormAttachment(bottom, 0);
 		resultsSelectorFormData.left = new FormAttachment(0, 0);
 		resultsSelectorFormData.right = new FormAttachment(100, 0);
 		statusLabel.setLayoutData(resultsSelectorFormData);
 		*/
 		// Status label
 		final FormData statusFormData = new FormData();
 		statusFormData.top = new FormAttachment(90, 0);
 		statusFormData.bottom = new FormAttachment(100, 0);
 		statusFormData.left = new FormAttachment(0, 0);
 		statusFormData.right = new FormAttachment(100, 0);
 		statusLabel.setLayoutData(statusFormData);


 		final ProgressMonitorDialog progressDialog = new ProgressMonitorDialog(this.getShell());

 		analyzeButton.addSelectionListener(new SelectionAdapter() {
 			@Override
 			public void widgetSelected(@SuppressWarnings("unused")
 			final SelectionEvent e) {
 				/*
 				 * reinitialize the graph
 				 */
 				timeSeriesCanvas.reset();
 				comparisonValues.clear();
 				timeSeriesCanvas.draw();
 				// reinitialize the status label
 				statusLabel.setText(Messages.getString("COMMON.STATUS"));


 				String referenceDirectory  = text1.getText();
 				String comparisonDirectory = text2.getText();

 				/*
 				 * VALIDATE the text input Fields
 				 */
 				if(!analyzer.validate(referenceDirectory)) {
 					statusLabel.setText(ScenarioAnalysisSuite.NOT_FOUND_MSG);
 					text1.setText("");
 				}
                 if(!analyzer.validate(comparisonDirectory)) {
                 	statusLabel.setText(ScenarioAnalysisSuite.NOT_FOUND_MSG);
                 	text2.setText("");
 				}
                 if((!analyzer.validate(referenceDirectory)) || (!analyzer.validate(comparisonDirectory))) {
                 	return;
                 }

                 ErrorResult result=null;
                 try {
                 	int index = (errorFunctionCombo.getSelectionIndex() == -1)? 0:errorFunctionCombo.getSelectionIndex();
                 	result = analyzer.compare(referenceDirectory, comparisonDirectory, progressDialog, errorFunctions[index]);
                 	if(result !=null) {
                 		comparisonValues.add(result.getErrorByTimeStep());
                 	}

                 	//success... remember the users prefs
 					prefs.setRecentFolder(PRIMARY_FOLDER_KEY,referenceDirectory);
 					prefs.setRecentFolder(SECONDARY_FOLDER_KEY,comparisonDirectory);
                 } catch(ScenarioInitializationException sie) {
                 	Activator.logError("", sie);
                 }

 				timeSeriesCanvas.draw();

 				String outFileName = COMPARISON_FILE_NAME+"_"+
 									 getScenarioNameFromDirectoryName(referenceDirectory)+
 									 "_"+
 									 getScenarioNameFromDirectoryName(comparisonDirectory);

 				CSVAnalysisWriter writer = new CSVAnalysisWriter(outFileName);
 			    writer.logData(comparisonValues);
 			    String results = "RMS Difference = ";
 			    if(result !=null) {
 			    	results += result.getError();
 			    }

 				statusLabel.setText(results);
 			}
 		});

 	} // createContents


 	/**
 	 * @param dirName
 	 * @return short name of scenario
 	 */
 	public static String getScenarioNameFromDirectoryName(String dirName) {
 		int last = dirName.lastIndexOf("/");
 		int last2 =  dirName.lastIndexOf("\\");
 		if(last2>last) last = last2;
 		if(last <=0 ) last = 0;
 		String retVal = dirName.substring(last+1, dirName.length());
 		return retVal;
 	}

 	/**
 	 * This returns the results of a comparison of type comparisonType
 	 * as an array of double.
 	 * TODO for now there is only one type, the MEAN SQ Diff
 	 * @param chartIndex not used (only one chart)
 	 * @param comparisonType
 	 * @return Cumulative deviation from reference trajectory
 	 */
 	@SuppressWarnings("boxing")
 	@Override
 	public double[] getValues(int chartIndex, int comparisonType) {
 		if((comparisonValues==null)||(comparisonValues.size()==0)) return new double[0];
 		EList<Double> r = comparisonValues.get(0);
 		double []result = new double[r.size()];
 		for(int i=0;i<r.size();++i) result[i]=r.get(i);
 		return result;
 	}

 private void populateErrorFunctionCombo() {

 		final IExtensionRegistry registry = Platform.getExtensionRegistry();
 		final IConfigurationElement[] errorFunctionsConfigElements = registry
 				.getConfigurationElementsFor(org.eclipse.stem.analysis.Constants.ID_ERRORFUNCTION_EXTENSION_POINT);

 			final java.util.List<ErrorFunction> temp = new ArrayList<ErrorFunction>();

 			errorFunctions = new ErrorFunction[errorFunctionsConfigElements.length];

 			for (int i = 0; i < errorFunctionsConfigElements.length; i++) {
 				final IConfigurationElement element = errorFunctionsConfigElements[i];

 				if (element.getName().equals(org.eclipse.stem.analysis.Constants.ERRORFUNCTION_ELEMENT)) {
 					// Yes
 					try {
 						temp.add((ErrorFunction) element
 								.createExecutableExtension("class")); //$NON-NLS-1$
 					} catch (final CoreException e) {
 						Activator.logError(
 								Messages.getString("Unable to instantiate extension point "+element), e); //$NON-NLS-1$
 					}
 				} // if
 			} // for each configuration element

 			errorFunctions = temp.toArray(new ErrorFunction[] {});

 		for(int i=0;i<errorFunctions.length;++i)
 			errorFunctionCombo.add(errorFunctions[i].eClass().getName());
 		errorFunctionCombo.select(0);
 	}

 	/**
 	 *
 	 * @param chartIndex not used (only one chart)
 	 * @param state
 	 * @return property name
 	 */
 	@Override
 	public String getProperty(int chartIndex, int state) {
 		return Messages.getString("COMP.RMSSTRING");
 	}

 	/**
 	 * Only one property to plot = the RMS difference
 	 * @param chartIndex not used (only one chart)
 	 * @return the number of properties
 	 * @see org.eclipse.stem.util.analysis.views.AnalysisControl#getNumProperties(int chartIndex)
 	 */
 	@Override
 	public int getNumProperties(int chartIndex) {
 		return 1;
 	}


 	/**
 	 * to remove the control e.g. by a remove button event
 	 */
 	@Override
 	public void remove() {
 		updateStatusLabel();
 	}


 	protected void updateStatusLabel() {
 		statusLabel.setText(Messages.getString("COMMON.STATUS"));
 	}


 	/**
 	 * Initialize the header label
 	 *
 	 * @param folderName
 	 */
 	@Override
 	protected void initializeHeader(String folderName) {
 		simulationNameLabel.setText("analyzing "+folderName);

 	} // initializeFromSimulation


 	/**
 	 * @see org.eclipse.swt.widgets.Widget#dispose()
 	 */
 	@Override
 	public void dispose() {

 		super.dispose();

 	} // dispose


 	/**
 	 * Each Control class may add objects to this map
 	 * @return the control parameters maps
 	 */
 	public Map<String, Object> getControlParametersMap() {
 		// add nothing for now
 		return controlParametersMap;
 	}


 } // EstimatorControl
	// EstimatorControl.java
	package org.eclipse.stem.util.analysis.views;

	/*******************************************************************************
	* Copyright (c) 2007, 2008 IBM Corporation and others.
	* 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:
	* IBM Corporation - initial API and implementation
	*******************************************************************************/

	import java.util.ArrayList;
	import java.util.List;
	import java.util.Map;

	import org.eclipse.birt.chart.model.attribute.ColorDefinition;
	import org.eclipse.birt.chart.model.attribute.impl.ColorDefinitionImpl;
	import org.eclipse.core.runtime.CoreException;
	import org.eclipse.core.runtime.IConfigurationElement;
	import org.eclipse.core.runtime.IExtensionRegistry;
	import org.eclipse.core.runtime.Platform;
	import org.eclipse.emf.common.util.EList;
	import org.eclipse.jface.dialogs.ProgressMonitorDialog;
	import org.eclipse.stem.analysis.ErrorFunction;
	import org.eclipse.stem.analysis.ErrorResult;
	import org.eclipse.stem.analysis.ScenarioInitializationException;
	import org.eclipse.stem.util.analysis.Activator;
	import org.eclipse.stem.util.analysis.CSVAnalysisWriter;
	import org.eclipse.stem.util.analysis.ScenarioAnalysisSuite;
	import org.eclipse.swt.SWT;
	import org.eclipse.swt.events.DisposeEvent;
	import org.eclipse.swt.events.DisposeListener;
	import org.eclipse.swt.events.SelectionAdapter;
	import org.eclipse.swt.events.SelectionEvent;
	import org.eclipse.swt.graphics.Font;
	import org.eclipse.swt.layout.FormAttachment;
	import org.eclipse.swt.layout.FormData;
	import org.eclipse.swt.layout.FormLayout;
	import org.eclipse.swt.widgets.Button;
	import org.eclipse.swt.widgets.Combo;
	import org.eclipse.swt.widgets.Composite;
	import org.eclipse.swt.widgets.DirectoryDialog;
	import org.eclipse.swt.widgets.Display;
	import org.eclipse.swt.widgets.Label;
	import org.eclipse.swt.widgets.Shell;
	import org.eclipse.swt.widgets.Text;

	/**
	* This class is a SWT GUI component that uses BIRT to plot
	*/
	public class ScenarioComparisonControl extends AnalysisControl {

	/**
	* used to identify user preferences for this class
	* This String is not human readable so does not need to be NLS'd. It is a key in a map
	*/
	private static final String CONSUMER = "SCENARIOCOMPARISON_CONTROL";

	/**
	* used to remember the primary directory in the user preferences
	* This String is not human readable so does not need to be NLS'd. It is a key in a map
	*/
	private static final String PRIMARY_FOLDER_KEY = CONSUMER+"_PRIMARY";
	/**
	* used to remember the secondary directory in the user preferences
	* This String is not human readable so does not need to be NLS'd. It is a key in a map
	*/
	private static final String SECONDARY_FOLDER_KEY = CONSUMER+"_SECONDARY";

	/**
	* First Scenario Label - indicates number of regions being watched for analysis.
	* There are locations with relative value history providers attached
	*/
	Label firstScenarioFolderLabel;

	/**
	* Second Scenario Label - indicates number of regions being watched for analysis.
	* There are locations with relative value history providers attached
	*/
	Label secondScenarioFolderLabel;

	/**
	* First input text field for the scenario folder of data to use in making the estimation
	*/
	Text text1;


	/**
	* Second Input text field for the scenario folder of data to be compared
	**/
	Text text2;


	protected Combo errorFunctionCombo;
	protected ErrorFunction [] errorFunctions;

	/**
	* Results of analysis
	*/
	Label statusLabel;


	/**
	* Colors for the time series chart
	*/
	static final ColorDefinition foreGround = ColorDefinitionImpl.BLACK();
	static final ColorDefinition backgroundGround = ColorDefinitionImpl.create(255, 231, 186);//color is called wheat
	static final ColorDefinition frameColor = ColorDefinitionImpl.create(220, 220, 220);

	static final String ROOT_PATH = Platform.getLocation().toOSString();
	/**
	* the chart of results
	*/
	static TimeSeriesCanvas timeSeriesCanvas;



	/**
	* the results of various scenario comparisons
	* TODO: eventually this might be a map keyed by comparison id
	* for now there is only one comparison, the mean square difference.
	*/
	List<EList<Double>> comparisonValues = new ArrayList<EList<Double>>();

	private static final String COMPARISON_FILE_NAME = "RMSCompare";
	private static final String SELECT_FOLDER_DIALOG_TEXT = "Pick a scenario folder";

	ScenarioAnalysisSuite analyzer = new ScenarioAnalysisSuite(this);

	/**
	*
	* @param parent
	*/
	public ScenarioComparisonControl(final Composite parent) {
	super(parent, SWT.None);
	createContents();
	} // EstimatorControl

	/**
	* Create the contents of the plotter
	*/
	private void createContents() {
	Display display = this.getDisplay();
	setLayout(new FormLayout());

	identifiableTitle = new Label(this, SWT.NONE);

	final Font newFont = getLargerFont(18, display);

	identifiableTitle.setFont(newFont);
	// Since you created the font, you must dispose it
	identifiableTitle.addDisposeListener(new DisposeListener() {
	public void widgetDisposed(DisposeEvent e) {
	newFont.dispose();
	}
	});
	identifiableTitle.setText(Messages.getString("COMP.TITLE"));
	//propertySelector = new PropertySelector(this, SWT.NONE);


	statusLabel = new Label(this, SWT.BORDER);
	statusLabel.setText("");

	firstScenarioFolderLabel = new Label(this, SWT.BORDER);
	firstScenarioFolderLabel.setText(Messages.getString("COMP.FOLDER1LABEL"));

	text1 = new Text(this, SWT.BORDER);
	String primaryDir=prefs.getRecentFolder(PRIMARY_FOLDER_KEY);
	text1.setText(primaryDir);

	secondScenarioFolderLabel = new Label(this, SWT.BORDER);
	secondScenarioFolderLabel.setText(Messages.getString("COMP.FOLDER2LABEL"));

	text2 = new Text(this, SWT.BORDER);
	String secondaryDir=prefs.getRecentFolder(SECONDARY_FOLDER_KEY);
	text2.setText(secondaryDir);

	Composite analyzeButtonComposite = getAnalyzeButtonComposite(this,Messages.getString("COMP.ANALYZE"));

	statusLabel = new Label(this, SWT.SHADOW_OUT);
	statusLabel.setBackground(display.getSystemColor(SWT.COLOR_WHITE));
	statusLabel.setText(Messages.getString("COMP.RESULTS"));

	int spacer = 5;
	int buttonspacer = 0;

	final FormData titleFormData = new FormData();
	identifiableTitle.setLayoutData(titleFormData);
	titleFormData.top = new FormAttachment(0, 0);
	// titleFormData.bottom = new FormAttachment(bottom, 0);
	titleFormData.left = new FormAttachment(0, 0);
	titleFormData.right = new FormAttachment(100, 0);

	// bottom += deltaBottom;
	/////////////////////////////////////////////////////////////////////////
	// TextField folder label
	final FormData firstScenarioFolderLabelFormData = new FormData();
	// propertySelectorFormData.top = new FormAttachment(cSVLoggerCanvas,
	// 0);
	firstScenarioFolderLabelFormData.top = new FormAttachment(identifiableTitle, spacer);
	// firstScenarioFolderLabelFormData.bottom = new FormAttachment(bottom, 0);
	firstScenarioFolderLabelFormData.left = new FormAttachment(0, 0);
	firstScenarioFolderLabelFormData.right = new FormAttachment(15, 0);
	firstScenarioFolderLabel.setLayoutData(firstScenarioFolderLabelFormData);
	// first text field for parameter Estimator
	final FormData text1FormData = new FormData();
	text1FormData.top = new FormAttachment(identifiableTitle,spacer);
	// text1FormData.bottom = new FormAttachment(bottom, 0);
	text1FormData.left = new FormAttachment(firstScenarioFolderLabel, 0);
	text1FormData.right = new FormAttachment(85, 0);
	text1.setLayoutData(text1FormData);


	Button selectFolder1Button = new Button(this, SWT.NONE);
	selectFolder1Button.setText(Messages.getString("COMP.SELECTFOLDERBUTTON"));
	final FormData selectFolder1FormData = new FormData();
	selectFolder1FormData.top = new FormAttachment(identifiableTitle, buttonspacer);
	// selectFolder1FormData.bottom = new FormAttachment(bottom, 0);
	selectFolder1FormData.left = new FormAttachment(text1, 0);
	// selectFolder1FormData.right = new FormAttachment(100, 0);
	selectFolder1Button.setLayoutData(selectFolder1FormData);

	final Shell shell = this.getShell();

	selectFolder1Button.addSelectionListener(new SelectionAdapter() {
	@Override
	public void widgetSelected(@SuppressWarnings("unused")
	final SelectionEvent e) {
	final DirectoryDialog dd = new DirectoryDialog(
	shell, SWT.OPEN);
	dd.setText(SELECT_FOLDER_DIALOG_TEXT); //$NON-NLS-1$
	String beginSearch = text1.getText();
	if((beginSearch==null)\|\|(beginSearch.length()<1)) beginSearch = ROOT_PATH;

	dd.setFilterPath(beginSearch);
	final String selected = dd.open();
	if(selected!=null) text1.setText(selected);
	}
	});



	/////////////////////////////////////////////////////////////////////////

	// bottom += deltaBottom;

	/////////////////////////////////////////////////////////////////////////
	// TextField folder label
	final FormData secondScenarioFolderLabelFormData = new FormData();
	// propertySelectorFormData.top = new FormAttachment(cSVLoggerCanvas,
	// 0);
	secondScenarioFolderLabelFormData.top = new FormAttachment(firstScenarioFolderLabel,spacer);
	// secondScenarioFolderLabelFormData.bottom = new FormAttachment(bottom, 0);
	secondScenarioFolderLabelFormData.left = new FormAttachment(0, 0);
	secondScenarioFolderLabelFormData.right = new FormAttachment(15, 0);
	secondScenarioFolderLabel.setLayoutData(secondScenarioFolderLabelFormData);
	// first text field for parameter Estimator
	final FormData text2FormData = new FormData();
	text2FormData.top = new FormAttachment(text1, spacer);
	// text2FormData.bottom = new FormAttachment(bottom, 0);
	text2FormData.left = new FormAttachment(secondScenarioFolderLabel, 0);
	text2FormData.right = new FormAttachment(85, 0);
	text2.setLayoutData(text2FormData);

	Button selectFolder2Button = new Button(this, SWT.NONE);
	selectFolder2Button.setText(Messages.getString("COMP.SELECTFOLDERBUTTON"));
	final FormData selectFolder2FormData = new FormData();
	selectFolder2FormData.top = new FormAttachment(text1, buttonspacer);
	// selectFolder2FormData.bottom = new FormAttachment(bottom, 0);
	selectFolder2FormData.left = new FormAttachment(text2, 0);
	// selectFolder2FormData.right = new FormAttachment(100, 0);
	selectFolder2Button.setLayoutData(selectFolder2FormData);

	selectFolder2Button.addSelectionListener(new SelectionAdapter() {
	@Override
	public void widgetSelected(@SuppressWarnings("unused")
	final SelectionEvent e) {
	final DirectoryDialog dd = new DirectoryDialog(
	shell, SWT.OPEN);
	dd.setText(Messages.getString("COMP.SELECTFOLDERDIALOG")); //$NON-NLS-1$
	String beginSearch = text2.getText();
	if((beginSearch==null)\|\|(beginSearch.length()<1)) beginSearch = ROOT_PATH;

	dd.setFilterPath(beginSearch);
	final String selected = dd.open();
	if(selected!=null) text2.setText(selected);
	}
	});

	/////////////////////////////////////////////////////////////////////////

	// bottom += deltaBottom;

	Label errorFunctionLabel = new Label(this, SWT.NONE);
	final FormData errorFunctionLabelFormData = new FormData();
	// propertySelectorFormDataX.top = new FormAttachment(propertySelectorY,
	// 0);
	errorFunctionLabelFormData.top = new FormAttachment(text2, spacer);
	errorFunctionLabelFormData.left = new FormAttachment(0, 0);
	errorFunctionLabelFormData.right = new FormAttachment(15, 0);
	errorFunctionLabel.setLayoutData(errorFunctionLabelFormData);
	errorFunctionLabel.setText(Messages.getString("COMP.ERRORFUNCTION"));

	errorFunctionCombo = new Combo(this, SWT.NONE);
	final FormData errorFunctionComboFormData = new FormData();
	errorFunctionComboFormData.top = new FormAttachment(text2, spacer);
	// errorFunctionComboFormData.bottom = new FormAttachment(bottom, 0);
	errorFunctionComboFormData.left = new FormAttachment(errorFunctionLabel, 5);
	// errorFunctionComboFormData.right = new FormAttachment(80, 0);
	errorFunctionCombo.setLayoutData(errorFunctionComboFormData);

	populateErrorFunctionCombo();

	// bottom += deltaBottom;

	// AnalyzeButton
	final FormData analysisButtonFormData = new FormData();
	// propertySelectorFormDataX.top = new FormAttachment(propertySelectorY,
	// 0);
	analysisButtonFormData.top = new FormAttachment(errorFunctionCombo, spacer);
	// analysisButtonFormData.bottom = new FormAttachment(bottom, 0);
	analysisButtonFormData.left = new FormAttachment(0, 0);
	analysisButtonFormData.right = new FormAttachment(100, 0);
	analyzeButtonComposite.setLayoutData(analysisButtonFormData);



	// Results Graph
	timeSeriesCanvas = new TimeSeriesCanvas(this,
	Messages.getString("COMP.RMSDIFFERENCELABEL"),
	Messages.getString("COMP.RMSSTRING"),
	Messages.getString("COMP.RMSSTRING"),
	foreGround,
	backgroundGround,
	frameColor, 0);

	final FormData chartFormData = new FormData();
	timeSeriesCanvas.setLayoutData(chartFormData);
	chartFormData.top = new FormAttachment(analyzeButtonComposite, 0);
	chartFormData.bottom = new FormAttachment(90, 0);
	chartFormData.left = new FormAttachment(0, 0);
	chartFormData.right = new FormAttachment(100, 0);

	/*
	final FormData resultsSelectorFormData = new FormData();
	resultsSelectorFormData.top = new FormAttachment(analyzeButton, 0);
	resultsSelectorFormData.bottom = new FormAttachment(bottom, 0);
	resultsSelectorFormData.left = new FormAttachment(0, 0);
	resultsSelectorFormData.right = new FormAttachment(100, 0);
	statusLabel.setLayoutData(resultsSelectorFormData);
	*/
	// Status label
	final FormData statusFormData = new FormData();
	statusFormData.top = new FormAttachment(90, 0);
	statusFormData.bottom = new FormAttachment(100, 0);
	statusFormData.left = new FormAttachment(0, 0);
	statusFormData.right = new FormAttachment(100, 0);
	statusLabel.setLayoutData(statusFormData);


	final ProgressMonitorDialog progressDialog = new ProgressMonitorDialog(this.getShell());

	analyzeButton.addSelectionListener(new SelectionAdapter() {
	@Override
	public void widgetSelected(@SuppressWarnings("unused")
	final SelectionEvent e) {
	/*
	* reinitialize the graph
	*/
	timeSeriesCanvas.reset();
	comparisonValues.clear();
	timeSeriesCanvas.draw();
	// reinitialize the status label
	statusLabel.setText(Messages.getString("COMMON.STATUS"));


	String referenceDirectory = text1.getText();
	String comparisonDirectory = text2.getText();

	/*
	* VALIDATE the text input Fields
	*/
	if(!analyzer.validate(referenceDirectory)) {
	statusLabel.setText(ScenarioAnalysisSuite.NOT_FOUND_MSG);
	text1.setText("");
	}
	if(!analyzer.validate(comparisonDirectory)) {
	statusLabel.setText(ScenarioAnalysisSuite.NOT_FOUND_MSG);
	text2.setText("");
	}
	if((!analyzer.validate(referenceDirectory)) \|\| (!analyzer.validate(comparisonDirectory))) {
	return;
	}

	ErrorResult result=null;
	try {
	int index = (errorFunctionCombo.getSelectionIndex() == -1)? 0:errorFunctionCombo.getSelectionIndex();
	result = analyzer.compare(referenceDirectory, comparisonDirectory, progressDialog, errorFunctions[index]);
	if(result !=null) {
	comparisonValues.add(result.getErrorByTimeStep());
	}

	//success... remember the users prefs
	prefs.setRecentFolder(PRIMARY_FOLDER_KEY,referenceDirectory);
	prefs.setRecentFolder(SECONDARY_FOLDER_KEY,comparisonDirectory);
	} catch(ScenarioInitializationException sie) {
	Activator.logError("", sie);
	}

	timeSeriesCanvas.draw();

	String outFileName = COMPARISON_FILE_NAME+"_"+
	getScenarioNameFromDirectoryName(referenceDirectory)+
	"_"+
	getScenarioNameFromDirectoryName(comparisonDirectory);

	CSVAnalysisWriter writer = new CSVAnalysisWriter(outFileName);
	writer.logData(comparisonValues);
	String results = "RMS Difference = ";
	if(result !=null) {
	results += result.getError();
	}

	statusLabel.setText(results);
	}
	});

	} // createContents




	/**
	* @param dirName
	* @return short name of scenario
	*/
	public static String getScenarioNameFromDirectoryName(String dirName) {
	int last = dirName.lastIndexOf("/");
	int last2 = dirName.lastIndexOf("\\");
	if(last2>last) last = last2;
	if(last <=0 ) last = 0;
	String retVal = dirName.substring(last+1, dirName.length());
	return retVal;
	}

	/**
	* This returns the results of a comparison of type comparisonType
	* as an array of double.
	* TODO for now there is only one type, the MEAN SQ Diff
	* @param chartIndex not used (only one chart)
	* @param comparisonType
	* @return Cumulative deviation from reference trajectory
	*/
	@SuppressWarnings("boxing")
	@Override
	public double[] getValues(int chartIndex, int comparisonType) {
	if((comparisonValues==null)\|\|(comparisonValues.size()==0)) return new double[0];
	EList<Double> r = comparisonValues.get(0);
	double []result = new double[r.size()];
	for(int i=0;i<r.size();++i) result[i]=r.get(i);
	return result;
	}

	private void populateErrorFunctionCombo() {

	final IExtensionRegistry registry = Platform.getExtensionRegistry();
	final IConfigurationElement[] errorFunctionsConfigElements = registry
	.getConfigurationElementsFor(org.eclipse.stem.analysis.Constants.ID_ERRORFUNCTION_EXTENSION_POINT);

	final java.util.List<ErrorFunction> temp = new ArrayList<ErrorFunction>();

	errorFunctions = new ErrorFunction[errorFunctionsConfigElements.length];

	for (int i = 0; i < errorFunctionsConfigElements.length; i++) {
	final IConfigurationElement element = errorFunctionsConfigElements[i];

	if (element.getName().equals(org.eclipse.stem.analysis.Constants.ERRORFUNCTION_ELEMENT)) {
	// Yes
	try {
	temp.add((ErrorFunction) element
	.createExecutableExtension("class")); //$NON-NLS-1$
	} catch (final CoreException e) {
	Activator.logError(
	Messages.getString("Unable to instantiate extension point "+element), e); //$NON-NLS-1$
	}
	} // if
	} // for each configuration element

	errorFunctions = temp.toArray(new ErrorFunction[] {});

	for(int i=0;i<errorFunctions.length;++i)
	errorFunctionCombo.add(errorFunctions[i].eClass().getName());
	errorFunctionCombo.select(0);
	}

	/**
	*
	* @param chartIndex not used (only one chart)
	* @param state
	* @return property name
	*/
	@Override
	public String getProperty(int chartIndex, int state) {
	return Messages.getString("COMP.RMSSTRING");
	}

	/**
	* Only one property to plot = the RMS difference
	* @param chartIndex not used (only one chart)
	* @return the number of properties
	* @see org.eclipse.stem.util.analysis.views.AnalysisControl#getNumProperties(int chartIndex)
	*/
	@Override
	public int getNumProperties(int chartIndex) {
	return 1;
	}





	/**
	* to remove the control e.g. by a remove button event
	*/
	@Override
	public void remove() {
	updateStatusLabel();
	}




	protected void updateStatusLabel() {
	statusLabel.setText(Messages.getString("COMMON.STATUS"));
	}



	/**
	* Initialize the header label
	*
	* @param folderName
	*/
	@Override
	protected void initializeHeader(String folderName) {
	simulationNameLabel.setText("analyzing "+folderName);

	} // initializeFromSimulation






	/**
	* @see org.eclipse.swt.widgets.Widget#dispose()
	*/
	@Override
	public void dispose() {

	super.dispose();

	} // dispose



	/**
	* Each Control class may add objects to this map
	* @return the control parameters maps
	*/
	public Map<String, Object> getControlParametersMap() {
	// add nothing for now
	return controlParametersMap;
	}


	} // EstimatorControl