/*
    * This file is a part of CAST project.
    * (c) Copyright 2007, AGH University of Science & Technology
    * https://caribou.iisg.agh.edu.pl/trac/cast
    *
    * Licensed under the Eclipse Public License, Version 1.0 (the "License").
    * You may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * http://www.eclipse.org/legal/epl-v10.html
   */
  /*
   * File: ImporterWizard.java
   * Created: 2009-03-13
   * Author: bmilos
   * $Id$
   */
  
  package pl.edu.agh.cast.importer.wizard;
  
  import java.lang.reflect.InvocationTargetException;
  import java.util.Collection;
  
  import org.apache.log4j.Logger;
  import org.eclipse.core.runtime.CoreException;
  import org.eclipse.core.runtime.IProgressMonitor;
  import org.eclipse.core.runtime.NullProgressMonitor;
  import org.eclipse.jface.dialogs.ProgressMonitorDialog;
  import org.eclipse.jface.operation.IRunnableWithProgress;
  import org.eclipse.jface.window.Window;
  import org.eclipse.jface.wizard.Wizard;
  
  import pl.edu.agh.cast.CastApplication;
  import pl.edu.agh.cast.CoreServiceLocator;
  import pl.edu.agh.cast.data.model.IDataSet;
  import pl.edu.agh.cast.data.model.IElement;
  import pl.edu.agh.cast.importer.base.process.ImportProcess;
  import pl.edu.agh.cast.importer.base.util.IImporterPluginRegistryProvider;
  import pl.edu.agh.cast.importer.base.util.ImporterUtil;
  import pl.edu.agh.cast.importer.wizard.dialog.DataSetNameDialog;
  import pl.edu.agh.cast.importer.wizard.page.AbstractConversionRulesSelectionPage;
  import pl.edu.agh.cast.importer.wizard.page.InitImportPage;
  import pl.edu.agh.cast.importer.wizard.strategy.IImportWizardStrategy;
  import pl.edu.agh.cast.importer.wizard.util.IWizardPluginRegistryProvider;
  import pl.edu.agh.cast.importer.wizard.util.Messages;
  import pl.edu.agh.cast.importer.wizard.util.WizardUtil;
  import pl.edu.agh.cast.model.IModelPluginRegistryProvider;
  
  /**
   * The wizard, which leads the users through an import data process, and which may also include a new template creation.
   * 
   * @author AGH CAST Team
   */
  public class ImporterWizard extends Wizard {
  
  	private static final int WIZARD_SIZE_HEIGHT = 700;
  
  	private static final int WIZARD_SIZE_WIDTH = 800;
  
  	private final Logger log = Activator.getLogger();
  
  	/**
  	 * The importer utility class.
  	 */
  	private ImporterUtil importerUtil;
  
  	/**
  	 * The wizard utility class.
  	 */
  	private WizardUtil wizardUtil;
  
  	/**
  	 * The conversion rules page currently present in the import wizard.
  	 */
  	private AbstractConversionRulesSelectionPage currConversionRulesPage;
  
  	private ImportProcess importProcess;
  
  	private IImportWizardStrategy wizardStrategy;
  
  	/**
  	 * The default constructor.
  	 * 
  	 * @param projectLocation
  	 *            project location
  	 */
  	public ImporterWizard(String projectLocation) {
  		this(null, null, null); // use default providers
  		importProcess = new ImportProcess();
  		importProcess.setProjectLocation(projectLocation);
  
  		setForcePreviousAndNextButtons(true);
  	}
  
  	/**
  	 * The constructor - for test use only.
  	 * 
  	 * @param pluginRegistryProvider
  	 *            the importer plugin registry provider
  	 * @param modelPluginRegistryProvider
 	 *            the model plugin registry provider
 	 * @param wizardPluginRegistryProvider
 	 *            the wizard plugin registry provider
 	 */
 	protected ImporterWizard(IImporterPluginRegistryProvider pluginRegistryProvider,
 	        IModelPluginRegistryProvider modelPluginRegistryProvider,
 	        IWizardPluginRegistryProvider wizardPluginRegistryProvider) {
 		super();
 		setWindowTitle(Messages.ImporterWizard_WindowTitle);
 		importerUtil = new ImporterUtil(pluginRegistryProvider);
 		wizardUtil = new WizardUtil(wizardPluginRegistryProvider);
 	}
 
 	/**
 	 * Performs data tokenization with the data currently configured.
 	 */
 	public void performTokenization() {
 		importProcess.tokenize(new NullProgressMonitor());
 	}
 
 	/**
 	 * Performs data parsing with the data currently configured and the analyzers specified.
 	 */
 	public void performParsing() {
 		final IRunnableWithProgress rwp = new IRunnableWithProgress() {
 			@Override
 			public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {
 				importProcess.parse(monitor);
 			}
 		};
 
 		try {
 			new ProgressMonitorDialog(CastApplication.getDisplay().getActiveShell()).run(true, false, rwp);
 		} catch (InvocationTargetException e) {
 			log.error(e.getMessage(), e);
 		} catch (InterruptedException e) {
 			log.error(e.getMessage(), e);
 		}
 	}
 
 	/**
 	 * Performs data conversion with the data and converter previously configured.
 	 */
 	public void performConversion() {
 		final IRunnableWithProgress rwp = new IRunnableWithProgress() {
 			@Override
 			public void run(final IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {
 				importProcess.convert(monitor);
 			}
 		};
 
 		try {
 			new ProgressMonitorDialog(CastApplication.getDisplay().getActiveShell()).run(true, false, rwp);
 		} catch (InvocationTargetException e) {
 			log.error(e.getMessage(), e);
 		} catch (InterruptedException e) {
 			log.error(e.getMessage(), e);
 		}
 
 	}
 
 	/**
 	 * Saves converted data sets using persistence provider.
 	 * 
 	 * @return true if data sets have been properly saved; false if any error occurred or user cancel
 	 */
 	public boolean saveDataSet() {
 		final DataSetNameDialog dsNameDialog = new DataSetNameDialog(getShell(), importProcess.getConvertedData()
 		        .get(0).getName());
 		if (dsNameDialog.open() != Window.OK) {
 			return false;
 		}
 
 		boolean res = true;
 		importProcess.getConvertedData().get(0).setName(dsNameDialog.getValue());
 
 		ProgressMonitorDialog dialog = new ProgressMonitorDialog(getShell());
 		try {
 			dialog.run(true, false, new IRunnableWithProgress() {
 
 				@Override
 				@SuppressWarnings("unchecked")
 				public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {
 					CoreServiceLocator.getPersistenceProvider().saveDataSets(
 					        (Collection<IDataSet<? extends IElement>>)(Collection)importProcess.getConvertedData(),
 					        monitor);
 
 				}
 
 			});
 		} catch (InvocationTargetException e) {
 			log.error(e.getMessage(), e);
 			res = false;
 		} catch (InterruptedException e) {
 			log.error(e.getMessage(), e);
 			res = false;
 		}
 		return res;
 
 	}
 
 	/*
 	 * -----------------------------------------------------------------------------------------------------------
 	 * --------------------------OVERRIDED METHODS-------------------------------------------------------
 	 * -----------------------------------------------------------------------------------------------------------
 	 */
 
 	/**
 	 * {@inheritDoc}
 	 * 
 	 * @see org.eclipse.jface.wizard.Wizard#addPages()
 	 */
 	@Override
 	public void addPages() {
 		addPage(new InitImportPage());
 		getShell().setSize(WIZARD_SIZE_WIDTH, WIZARD_SIZE_HEIGHT);
 	}
 
 	/**
 	 * {@inheritDoc}
 	 * 
 	 * @see org.eclipse.jface.wizard.Wizard#canFinish()
 	 */
 	@Override
 	public boolean canFinish() {
 		return wizardStrategy != null && wizardStrategy.canFinishWizard();
 	}
 
 	/**
 	 * {@inheritDoc}
 	 * 
 	 * @see org.eclipse.jface.wizard.Wizard#performFinish()
 	 */
 	@Override
 	public boolean performFinish() {
 		return wizardStrategy.performFinish();
 	}
 
 	/*----------------------------------------------------------------------------------------------------------*/
 
 	/*
 	 * -----------------------------------------------------------------------------------------------------------
 	 * --------------------------HELPER METHODS------------------------------------------------------------
 	 * -----------------------------------------------------------------------------------------------------------
 	 */
 
 	private void updateCurrConversionRulesPage() {
 		if (importProcess.getConversionRulesSelectionPageId() != null) {
 			try {
 				currConversionRulesPage = wizardUtil.getConversionRulesSelectionPageInstance(importProcess
 				        .getConversionRulesSelectionPageId());
 			} catch (CoreException e) {
 				String errorMsg = "CoreException while retrieving instance of conversion rule selection " //$NON-NLS-1$
 				        + "page for model id: " + importProcess.getConversionRulesSelectionPageId(); //$NON-NLS-1$
 				log.error(errorMsg, e);
 				throw new RuntimeException(errorMsg, e);
 			}
 		}
 	}
 
 	/*----------------------------------------------------------------------------------------------------------*/
 
 	/*
 	 * -----------------------------------------------------------------------------------------------------------
 	 * --------------------------GETTERS AND SETTERS------------------------------------------------------
 	 * -----------------------------------------------------------------------------------------------------------
 	 */
 
 	/**
 	 * Sets new import strategy. When strategy is changed new import process instance is created.
 	 * 
 	 * @param strategy
 	 *            import strategy to set
 	 */
 	public void setImportStrategy(IImportWizardStrategy strategy) {
 		if (strategy != wizardStrategy) {
 			final ImportProcess newProcess = new ImportProcess();
 			newProcess.setFilePath(importProcess.getFilePath());
 			newProcess.setProjectLocation(importProcess.getProjectLocation());
 			importProcess = newProcess;
 
 			this.wizardStrategy = strategy;
 			wizardStrategy.addPages(this);
 		}
 	}
 
 	public ImportProcess getImportProcess() {
 		return importProcess;
 	}
 
 	public ImporterUtil getImporterUtil() {
 		return this.importerUtil;
 	}
 
 	public WizardUtil getWizardUtil() {
 		return this.wizardUtil;
 	}
 
 	/**
 	 * Returns rules page for actual selected model.
 	 * 
 	 * @return current conversion rules page
 	 */
 	public AbstractConversionRulesSelectionPage getCurrConversionRulesPage() {
 		updateCurrConversionRulesPage();
 		return this.currConversionRulesPage;
 	}
 
 	public IImportWizardStrategy getWizardStrategy() {
 		return wizardStrategy;
 	}
 
 	/*----------------------------------------------------------------------------------------------------------*/
 
 }