/*** PlateView.java - part of the MirkE (say murky) application for colormetric analysis emphesizing 
   kinetics.
   
   Created by: Scott Menor on 21 July, 2004.
   Last modified by: Scott Menor on 12 December, 2004
   
   Copyright (c) 2004 Arizona State University - Cancer Research Institute. All rights reserved.
   
   MirkE 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 2 of the License, or
  (at your option) any later version.
  
  MirkE 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 MirkE; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  US
  */
  
  package edu.asu.cri.MirkE.gui;
  
  import java.awt.Dimension;
  import java.awt.GridBagConstraints;
  
  import javax.swing.JLabel;
  import javax.swing.JPanel;
  import javax.swing.border.EtchedBorder;
  import javax.swing.event.EventListenerList;
  
  import edu.asu.cri.MirkE.MirkE;
  import edu.asu.cri.MirkE.dataStructures.DataSet;
  import edu.asu.cri.MirkE.exceptions.MirkEApplicationException;
  
  
  /*** A viewer for multiwell plates used to represent colormetric data and to allow users to select which well(s) belong to a specific group 
  
  @author Scott Menor
  @version 0.3.0 1 februrary, 2004
  */
  public class PlateView extends JPanel {
  	private DataSet dataSet;
  	private MirkE mirke;
  	
  	protected EventListenerList listenerList = new EventListenerList();
  	protected PlateViewEvent plateViewEvent = null;
  	
  	private String selectableParameter;
  	
  	/***
  		@param selectableParameter
  		*/
  	public void setSelectableParameter(String selectableParameter) {
  		this.selectableParameter = selectableParameter;
  		// TODO - mass update query to change category names
  		
  		firePlateViewUpdated();
  	}
  	
  	/***
  		@return selectableParameter
  	 */
  	public String getSelectableParameter() {
  		return selectableParameter;
  	}
  	
  	private int numberOfRows = 0;
  	private int numberOfColumns = 0;
  	
  	/*** constructor
  	 *	
  	 * @param mirke
  	 * @param selectableParameter
  	 * @throws MirkEApplicationException
  	 */
  	public PlateView(MirkE mirke, 
  	        String selectableParameter) throws MirkEApplicationException{
  	    super();
  		
  		this.mirke = mirke;
  		this.dataSet = mirke.getDataSet();
  		this.selectableParameter = selectableParameter;
  		
  		initialize();
  	}
  	
  	/***
  	 * @throws MirkEApplicationException 
  	 */
  	public void initialize() throws MirkEApplicationException {
  		dataSet.computePlateDimensions(); // TODO - call this automagically when DataSet is updated?
  		numberOfRows = dataSet.getNumberOfRows();
  		numberOfColumns = dataSet.getNumberOfColumns();
  		createPlateViewGUI();
  	}
  	
 	/***
 	 * @throws MirkEApplicationException
 	 */
 	public void createPlateViewGUI() throws MirkEApplicationException{
 		java.awt.GridBagConstraints gridBagConstraints;
 		gridBagConstraints = new java.awt.GridBagConstraints();
 		gridBagConstraints.insets = new java.awt.Insets(5, 5, 5, 5);
 		gridBagConstraints.ipadx = 8;
 		gridBagConstraints.ipady = 8;
 		
 		setLayout(new java.awt.GridBagLayout()); 
 		
 		gridBagConstraints.gridwidth = 1;
 		gridBagConstraints.gridheight = 1;
 		gridBagConstraints.anchor = GridBagConstraints.CENTER;
 		
 		gridBagConstraints.gridx = 0;
 		
 		for (int rowNumber=0;rowNumber<numberOfRows;rowNumber++) {
 			gridBagConstraints.gridy = rowNumber + 1;
 			add(new JLabel("" + rowNumberToLabel(rowNumber),
 						   JLabel.CENTER), 
 				gridBagConstraints);
 		}
 		
 		gridBagConstraints.gridy = 0;
 		
 		for (int columnNumber=0;columnNumber<numberOfColumns;columnNumber++) {
 			gridBagConstraints.gridx = columnNumber + 1;
 			
 			add(new JLabel("" + columnNumberToColumnLabel(columnNumber),
 						   JLabel.CENTER), 
 				gridBagConstraints);
 		}
 		
 		Dimension wellSize = new Dimension(25, 
 										   25); // TODO - automate
 		String plateWellType = "";
 		
 		for (int rowNumber=0;rowNumber<numberOfRows;rowNumber++) {
 			gridBagConstraints.gridy = rowNumber + 1;
 			String rowLabel = rowNumberToLabel(rowNumber);
 			
 			for (int columnNumber=0;columnNumber<numberOfColumns;columnNumber++) {
 				gridBagConstraints.gridx = columnNumber + 1;
 				String columnLabel = columnNumberToColumnLabel(columnNumber);
 				
 				java.util.List plateWellDescriptorList = mirke.getDataSet().find("from PlateWellDescriptor as d " +
 																				 "where d.plateWellType='M' and " + 
 																				 "d.plateRow='"+rowLabel+"' and " + 
 																				 "d.plateColumn='"+columnLabel+"'");
 				
 				plateWellType = "E";
 				
 				if (plateWellDescriptorList.size() > 0) {
 					plateWellType = "M";
 				}
 				
 				WellButton wellButton = new WellButton(mirke, 
 													   rowLabel, 
 													   columnLabel,
 													   plateWellType,
 													   selectableParameter);
 				
 				wellButton.setPreferredSize(wellSize);
 				
 				addPlateViewListener(wellButton);
 				
 				add(wellButton, 
 					gridBagConstraints);
 			}
 		}
 		
 		setBorder(new EtchedBorder()); // TODO - make a custom plate Border (that actually looks a bit more like a multiwell plate with a notch) and wrap the WellButton s by themselves 
 	}
 	
 	/***
 		
 	 @param rowNumber
 	 
 	 @return rowLabel
 	 */
 	public String rowNumberToLabel(int rowNumber) {
 		String rowLabel = "";
 		
 		rowLabel += (char)('A' + rowNumber);
 		
 		return rowLabel;
 	}
 	
 	/***
 		
 	 @param columnNumber
 	 
 	 @return columnLabel
 	 */
 	public String columnNumberToColumnLabel(int columnNumber) {
 		String columnLabel = "" + (columnNumber + 1);
 		
 		return columnLabel;
 	}
 	
 	/***
 		
 	 @param mirke
 	 */
 	public void setMirke(MirkE mirke) {
 		this.mirke = mirke;
 	}
 	
 	/***
 		
 	 @return mirke
 	 */
 	public MirkE getMirke() {
 		return this.mirke;
 	}
 	
 	/*** Add a listener to be notified of changes in an instance of the <code>PlateView</code>
 		
 		@param plateViewEventListener
 		*/
 	public void addPlateViewListener(PlateViewEventListener plateViewEventListener) {
 		listenerList.add(PlateViewEventListener.class, plateViewEventListener);
 	}
 	
 	/*** Remove a listener (no longer notify it of changes to an instance of the <code>PlateView</code>).
 		
 		@param plateViewEventListener
 		*/
 	public void removePlateViewListener(PlateViewEventListener plateViewEventListener) {
 		listenerList.remove(PlateViewEventListener.class, plateViewEventListener);
 	}
 	
 	/*** Notify all listeners that the <code>PlateView</code> has changed (TODO - add finer-grain notification so listeners don't need to update everything on a change event)
 		
 		*/
 	protected void firePlateViewUpdated() {
 		
 		Object[] listeners = listenerList.getListenerList();
 		for (int i = listeners.length-2; i>=0; i-=2) { 
 			if (listeners[i] == PlateViewEventListener.class) {
 				
 				// create the event if one doesn't already exist (TODO - should we ensure that a different event is created for each time the model is updated or just use the same one every time; for this case, I think it's fine to use the same one since there is no content to the event object)
 				if (plateViewEvent == null) {
 					plateViewEvent = new PlateViewEvent(this);
 				} 
 				
 				((PlateViewEventListener)listeners[i+1]).plateViewChanged(plateViewEvent);
 			}
 		}
 	}	
 }