/*
    * 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: AbstractConversionRuleConfigDialog.java
   * Created: 2009-04-30
   * Author: bmilos
   * $Id$
   */
  
  package pl.edu.agh.cast.importer.wizard.dialog.rule;
  
  import java.util.HashMap;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Map;
  
  import org.eclipse.osgi.util.NLS;
  import org.eclipse.swt.SWT;
  import org.eclipse.swt.layout.GridData;
  import org.eclipse.swt.widgets.Composite;
  import org.eclipse.swt.widgets.Dialog;
  import org.eclipse.swt.widgets.Display;
  import org.eclipse.swt.widgets.Shell;
  
  import pl.edu.agh.cast.importer.base.converter.rules.IConversionRule;
  import pl.edu.agh.cast.importer.base.data.TabularData;
  import pl.edu.agh.cast.importer.wizard.page.AbstractConversionRulesSelectionPage;
  import pl.edu.agh.cast.importer.wizard.util.Messages;
  import pl.edu.agh.cast.importer.wizard.utils.ButtonTableCreator;
  import pl.edu.agh.cast.ui.util.MsgBoxHelper;
  
  /**
   * Abstract class for conversion rules configuration dialogs of the importer wizard.
   *
   * @author AGH CAST Team
   */
  public abstract class AbstractConversionRuleConfigDialog extends Dialog {
  
  	private static final int DEFAULT_DIALOG_STYLE = SWT.APPLICATION_MODAL | SWT.DIALOG_TRIM;
  
  	/**
  	 * The dialog shell.
  	 */
  	protected Shell shell;
  
  	/**
  	 * The mediating conversion rules selection page.
  	 */
  	protected AbstractConversionRulesSelectionPage mediator;
  
  	/**
  	 * The tabular data to be converted.
  	 */
  	protected TabularData data;
  
  	/**
  	 * The additional parameters for the conversion rule.
  	 */
  	protected String[] labelParams;
  
  	/**
  	 * The conversion rule.
  	 */
  	protected IConversionRule rule;
  
  	/**
  	 * The default constructor.
  	 *
  	 * @param parent
  	 *            the parent shell
  	 */
  	public AbstractConversionRuleConfigDialog(Shell parent) {
  		super(parent, DEFAULT_DIALOG_STYLE);
  	}
  
  	/**
  	 * Opens the dialog.
  	 */
  	public void open() {
  		// Create the dialog window
  		shell = new Shell(getParent(), DEFAULT_DIALOG_STYLE);
  		shell.layout();
  		shell.setText(Messages.AbstractConversionRuleConfigDialog_Title);
  		if (createContents()) {
  			shell.pack();
  			shell.setLocation(getParent().toDisplay(100, 100));
  			shell.open();
  
  			Display display = getParent().getDisplay();
  			while (!shell.isDisposed()) {
  				if (!display.readAndDispatch()) {
 					display.sleep();
 				}
 			}
 		}
 	}
 
 	/**
 	 * Sets necessary data for this conversion rule configuration dialog.
 	 *
 	 * @param mediatingPage
 	 *            the mediating page
 	 * @param tabData
 	 *            the tabular data
 	 * @param params
 	 *            the additional parameters
 	 * @param convRule
 	 *            the conversion rule
 	 */
 	public void setData(AbstractConversionRulesSelectionPage mediatingPage, TabularData tabData, String[] params,
 	        IConversionRule convRule) {
 		this.mediator = mediatingPage;
 		this.data = tabData;
 		this.labelParams = params;
 		this.rule = convRule;
 	}
 
 	/**
 	 * Calls the {@link ButtonTableCreator#createTable(Composite, GridData, TabularData, Map)} method of the specified
 	 * table creator, which is to be created on the specified composite.
 	 *
 	 * @param container
 	 *            the container for the new table that is to be created
 	 * @param tableCreator
 	 *            the button table creator
 	 * @param columnType
 	 *            the type of columns to be included in the table
 	 * @param columnTypeName
 	 *            the name of the column type
 	 * @return <code>true</code> of the table was successfully created, <code>false</code> otherwise
 	 */
 	protected boolean createTable(Composite container, ButtonTableCreator tableCreator, Class<?> columnType,
 	        String columnTypeName) {
 		List<Class<?>> columnTypes = data.getColumnTypes();
 		GridData tableLData = new GridData(SWT.FILL, SWT.FILL, true, true);
 
 		if (columnTypes == null) {
 			tableCreator.createTable(container, tableLData, data, null);
 		} else {
 			List<Integer> colIndices = new LinkedList<Integer>();
 
 			for (int columnIdx = 0; columnIdx < columnTypes.size(); columnIdx++) {
 				if (columnType.isAssignableFrom(columnTypes.get(columnIdx))) {
 					colIndices.add(columnIdx);
 				}
 			}
 
 			if (colIndices.isEmpty()) {
 				String colName = ""; //$NON-NLS-1$
 				if (columnTypeName != null) {
 					colName = columnTypeName.toLowerCase();
 				}
 
 				MsgBoxHelper.showWarningBox(container,
 				        Messages.AbstractSingleColumnConversionRuleConfigDialog_NoColumnBoxTitle, NLS.bind(
 				                Messages.AbstractSingleColumnConversionRuleConfigDialog_NoColumnBoxMsg, colName));
 				return false;
 			}
 
 			/*
 			 * Construction of a mapping of dialog tabular data column indices (always increased by 1 because of the row
 			 * number column in the config dialog) to the indices of columns of the "entire" tabular data (containing
 			 * only the columns selected at the {@link AnalyzersSelectionPage}).
 			 */
 			Map<Integer, Integer> dialogToDataIndices = new HashMap<Integer, Integer>();
 			for (int dialogColIdx = 0; dialogColIdx < colIndices.size(); dialogColIdx++) {
 				dialogToDataIndices.put(dialogColIdx + 1, colIndices.get(dialogColIdx));
 			}
 
 			tableCreator.createTable(container, tableLData, data.copyDataLeavingColumns(colIndices),
 			        dialogToDataIndices);
 		}
 		return true;
 	}
 
 	/*
 	 * -----------------------------------------------------------------------------------------------------------
 	 * --------------------------ABSTRACT METHODS---------------------------------------------------------
 	 * -----------------------------------------------------------------------------------------------------------
 	 */
 
 	protected abstract boolean createContents();
 
 	/*----------------------------------------------------------------------------------------------------------*/
 
 }